Skip to content

Commit

Permalink
bump version to 2.0.0 and update README
Browse files Browse the repository at this point in the history
  • Loading branch information
KtorZ committed Jul 28, 2017
1 parent f7dcb46 commit a96e6b9
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 13 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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\*
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "purescript-indexeddb",
"description": "An API wrapper around IndexedDB",
"version": "1.0.2",
"version": "2.0.0",
"authors": [
"Matthias Benkort <matthias.benkort@truqu.com>"
],
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
7 changes: 0 additions & 7 deletions src/Database/IndexedDB/Core.purs
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit a96e6b9

Please sign in to comment.