git.iko.soy/purescript-indexed-DB
on master help sign in
bump version to 2.0.0 and update README
commita96e6b915a7f03374a7f1e60e1b356ac9a67f9b9 authorKtorZ <matthias.benkort@gmail.com> dateFri 28 Jul 2017, 11:35 (9 years ago) parentf7dcb46
4 files changed+15−13
README.md+13−4 bower.json+1−1 package.json+1−1 src/Database/IndexedDB/Core.purs−7
README.md+13−4
@@ -38,10 +38,9 @@ onUpgradeNeeded db _ = launchAff' do
3838## Notes
3939
4040### Errors
41−Errors normally thrown by the IDB\* interfaces are wrapped in the `Aff` Monad as `Error`
42−where the `message` corresponds to the error's name (e.g. "InvalidStateError").
43−Pattern matching can therefore be done on any error message to handle specific errors thrown
44−by the API.
41+Errors normally thrown by the IDB\* interfaces are wrapped in the `Aff` Monad as `Error` where
42+the `name` corresponds to the error's name (e.g. "InvalidStateError"). Pattern matching can
43+therefore be done on any error to handle specific errors thrown by the API.
4544
4645### Examples
4746The `test` folder contains a great amount of examples showing practical usage of the IDB\*
@@ -52,6 +51,16 @@ one.
5251
5352## Changelog
5453
54+#### v2.0.0
55+
56+- review interface implementation (use of opaque classes to improve readability without compromising
57+ the reusability). The API doesn't really change from a user perspective though.
58+
59+- make the Key more opaque (by having an IDBKey instance for Foreign types)
60+
61+- Upgrade purescript-exceptions to 3.1.0 and leverage the new `name` accessor
62+
63+
5564#### v1.0.0
5665
5766- [Indexed Database API 2.0](https://w3c.github.io/IndexedDB/) totally covered apart from
bower.json+1−1
@@ -1,7 +1,7 @@
11{
22 "name": "purescript-indexeddb",
33 "description": "An API wrapper around IndexedDB",
4− "version": "1.0.2",
4+ "version": "2.0.0",
55 "authors": [
66 "Matthias Benkort <matthias.benkort@truqu.com>"
77 ],
package.json+1−1
@@ -1,6 +1,6 @@
11{
22 "name": "purescript-indexeddb",
3− "version": "1.0.0",
3+ "version": "2.0.0",
44 "description": "A wrapper around the IndexedDB API",
55 "scripts": {
66 "prepare:release": "mkdir -p releases/github && cp -r README.md LICENSE src bower.json releases/github",
src/Database/IndexedDB/Core.purs−7
@@ -1,12 +1,5 @@
11-- | The Core module gathers types used across the library and provides basic Show instances for
22-- | those types.
3−-- |
4−-- | NOTE:
5−-- | Errors normally thrown by the IDB* interfaces are wrapped in the `Aff` Monad as `Error`
6−-- | where the `message` corresponds to the error's name (e.g. "InvalidStateError").
7−-- | Pattern matching can therefore be done on any error message to handle specific errors thrown
8−-- | by the API.
9−
103module Database.IndexedDB.Core
114 -- * Effects
125 ( IDB