mirror of
https://github.com/ilyakooo0/purescript-indexedDB.git
synced 2024-09-11 06:55:48 +03:00
bump version to 2.0.0 and update README
This commit is contained in:
parent
f7dcb46dc6
commit
a96e6b915a
17
README.md
17
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
|
||||
|
@ -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>"
|
||||
],
|
||||
|
@ -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",
|
||||
|
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user