From a96e6b915a7f03374a7f1e60e1b356ac9a67f9b9 Mon Sep 17 00:00:00 2001 From: KtorZ Date: Fri, 28 Jul 2017 11:35:48 +0200 Subject: [PATCH] bump version to 2.0.0 and update README --- README.md | 17 +++++++++++++---- bower.json | 2 +- package.json | 2 +- src/Database/IndexedDB/Core.purs | 7 ------- 4 files changed, 15 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index bca62be..a7cc8cc 100644 --- a/README.md +++ b/README.md @@ -38,10 +38,9 @@ onUpgradeNeeded db _ = launchAff' do ## Notes ### Errors -Errors normally thrown by the IDB\* interfaces are wrapped in the `Aff` Monad as `Error` -where the `message` corresponds to the error's name (e.g. "InvalidStateError"). -Pattern matching can therefore be done on any error message to handle specific errors thrown -by the API. +Errors normally thrown by the IDB\* interfaces are wrapped in the `Aff` Monad as `Error` where +the `name` corresponds to the error's name (e.g. "InvalidStateError"). Pattern matching can +therefore be done on any error to handle specific errors thrown by the API. ### Examples The `test` folder contains a great amount of examples showing practical usage of the IDB\* @@ -52,6 +51,16 @@ one. ## Changelog +#### v2.0.0 + +- review interface implementation (use of opaque classes to improve readability without compromising + the reusability). The API doesn't really change from a user perspective though. + +- make the Key more opaque (by having an IDBKey instance for Foreign types) + +- Upgrade purescript-exceptions to 3.1.0 and leverage the new `name` accessor + + #### v1.0.0 - [Indexed Database API 2.0](https://w3c.github.io/IndexedDB/) totally covered apart from diff --git a/bower.json b/bower.json index 32d46de..664fd47 100644 --- a/bower.json +++ b/bower.json @@ -1,7 +1,7 @@ { "name": "purescript-indexeddb", "description": "An API wrapper around IndexedDB", - "version": "1.0.2", + "version": "2.0.0", "authors": [ "Matthias Benkort " ], diff --git a/package.json b/package.json index f86fe2b..fb8e509 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "purescript-indexeddb", - "version": "1.0.0", + "version": "2.0.0", "description": "A wrapper around the IndexedDB API", "scripts": { "prepare:release": "mkdir -p releases/github && cp -r README.md LICENSE src bower.json releases/github", diff --git a/src/Database/IndexedDB/Core.purs b/src/Database/IndexedDB/Core.purs index b52d845..36ff53e 100644 --- a/src/Database/IndexedDB/Core.purs +++ b/src/Database/IndexedDB/Core.purs @@ -1,12 +1,5 @@ -- | The Core module gathers types used across the library and provides basic Show instances for -- | those types. --- | --- | NOTE: --- | Errors normally thrown by the IDB* interfaces are wrapped in the `Aff` Monad as `Error` --- | where the `message` corresponds to the error's name (e.g. "InvalidStateError"). --- | Pattern matching can therefore be done on any error message to handle specific errors thrown --- | by the API. - module Database.IndexedDB.Core -- * Effects ( IDB