mirror of
https://github.com/ilyakooo0/purescript-indexedDB.git
synced 2024-08-15 18:00:40 +03:00
add documentation to IDBObjectStore
This commit is contained in:
KtorZ
parent
02acc707ee
commit
6f7562fe4f
@ -1,3 +1,4 @@
|
||||
-- | An object store is the primary storage mechanism for storing data in a database.
|
||||
module Database.IndexedDB.IDBObjectStore
|
||||
( class IDBObjectStore, add, clear, createIndex, delete, deleteIndex, index, put
|
||||
, module Database.IndexedDB.IDBIndex.Internal
|
||||
@ -28,49 +29,105 @@ import Database.IndexedDB.IDBKey.Internal (class IDBKey, Key(Key), extractFore
|
||||
--------------------
|
||||
-- INTERFACES
|
||||
--
|
||||
-- | The IDBObjectStore interface represents an object store handle.
|
||||
class IDBObjectStore store where
|
||||
-- | Adds or updates a record in store with the given value and key.
|
||||
-- |
|
||||
-- | If the store uses in-line keys and key is specified a "DataError" DOMException
|
||||
-- | will be thrown.
|
||||
-- |
|
||||
-- | If add() is used, and if a record with the key already exists the request will fail,
|
||||
-- | with a "ConstraintError" DOMException.
|
||||
add :: forall v k e. (IDBKey k) => store -> v -> Maybe k -> Aff (idb :: IDB | e) Key
|
||||
|
||||
-- | Deletes all records in store.
|
||||
clear :: forall e. store -> Aff (idb :: IDB | e) Unit
|
||||
|
||||
-- | Creates a new index in store with the given name, keyPath and options and
|
||||
-- | returns a new IDBIndex. If the keyPath and options define constraints that
|
||||
-- | cannot be satisfied with the data already in store the upgrade transaction
|
||||
-- | will abort with a "ConstraintError" DOMException.
|
||||
-- |
|
||||
-- | Throws an "InvalidStateError" DOMException if not called within an upgrade transaction.
|
||||
createIndex :: forall e. store -> IndexName -> KeyPath -> IDBIndexParameters -> Aff (idb :: IDB | e) Index
|
||||
|
||||
-- | Deletes records in store with the given key or in the given key range in query.
|
||||
delete :: forall e. store -> KeyRange -> Aff (idb :: IDB | e) Unit
|
||||
|
||||
-- | Deletes the index in store with the given name.
|
||||
-- |
|
||||
-- | Throws an "InvalidStateError" DOMException if not called within an upgrade transaction.
|
||||
deleteIndex :: forall e. store -> IndexName -> Aff (idb :: IDB | e) Unit
|
||||
|
||||
-- | Returns an IDBIndex for the index named name in store.
|
||||
index :: forall e. store -> IndexName -> Aff (idb :: IDB | e) Index
|
||||
|
||||
-- | Adds or updates a record in store with the given value and key.
|
||||
-- |
|
||||
-- | If the store uses in-line keys and key is specified a "DataError" DOMException
|
||||
-- | will be thrown.
|
||||
-- |
|
||||
-- | If put() is used, any existing record with the key will be replaced.
|
||||
put :: forall v k e. (IDBKey k) => store -> v -> Maybe k -> Aff (idb :: IDB | e) Key
|
||||
|
||||
|
||||
-- | Type alias for IndexName
|
||||
type IndexName = String
|
||||
|
||||
|
||||
-- | Options provided when creating an object store.
|
||||
type IDBObjectStoreParameters =
|
||||
{ keyPath :: KeyPath
|
||||
, autoIncrement :: Boolean
|
||||
}
|
||||
|
||||
|
||||
defaultParameters :: IDBObjectStoreParameters
|
||||
defaultParameters =
|
||||
{ keyPath : []
|
||||
, autoIncrement : false
|
||||
}
|
||||
|
||||
|
||||
--------------------
|
||||
-- ATTRIBUTES
|
||||
--
|
||||
autoIncrement :: ObjectStore -> Boolean
|
||||
-- | Returns `true` if the store has a key generator, and `false` otherwise.
|
||||
autoIncrement
|
||||
:: ObjectStore
|
||||
-> Boolean
|
||||
autoIncrement =
|
||||
_autoIncrement
|
||||
|
||||
|
||||
indexNames :: ObjectStore -> Array String
|
||||
--| Returns a list of the names of indexes in the store.
|
||||
indexNames
|
||||
:: ObjectStore
|
||||
-> Array String
|
||||
indexNames =
|
||||
_indexNames
|
||||
|
||||
|
||||
keyPath :: ObjectStore -> Array String
|
||||
-- | Returns the key path of the store, or empty array if none
|
||||
keyPath
|
||||
:: ObjectStore
|
||||
-> Array String
|
||||
keyPath =
|
||||
_keyPath
|
||||
|
||||
|
||||
name :: ObjectStore -> String
|
||||
-- | Returns the name of the store.
|
||||
name
|
||||
:: ObjectStore
|
||||
-> String
|
||||
name =
|
||||
_name
|
||||
|
||||
|
||||
transaction :: ObjectStore -> Transaction
|
||||
-- | Returns the associated transaction.
|
||||
transaction
|
||||
:: ObjectStore
|
||||
-> Transaction
|
||||
transaction =
|
||||
_transaction
|
||||
|
||||
@ -101,47 +158,65 @@ instance idbObjectStoreObjectStore :: IDBObjectStore ObjectStore where
|
||||
Key <$> Fn.runFn3 _put store value (toNullable $ (toKey >>> extractForeign) <$> key)
|
||||
|
||||
|
||||
defaultParameters :: IDBObjectStoreParameters
|
||||
defaultParameters =
|
||||
{ keyPath : []
|
||||
, autoIncrement : false
|
||||
}
|
||||
|
||||
|
||||
--------------------
|
||||
-- FFI
|
||||
--
|
||||
foreign import _add :: forall value e. Fn3 ObjectStore value (Nullable Foreign) (Aff (idb :: IDB | e) Foreign)
|
||||
foreign import _add
|
||||
:: forall value e
|
||||
. Fn3 ObjectStore value (Nullable Foreign) (Aff (idb :: IDB | e) Foreign)
|
||||
|
||||
|
||||
foreign import _autoIncrement :: ObjectStore -> Boolean
|
||||
foreign import _autoIncrement
|
||||
:: ObjectStore
|
||||
-> Boolean
|
||||
|
||||
|
||||
foreign import _clear :: forall e. ObjectStore -> Aff (idb :: IDB | e) Unit
|
||||
foreign import _clear
|
||||
:: forall e
|
||||
. ObjectStore
|
||||
-> Aff (idb :: IDB | e) Unit
|
||||
|
||||
|
||||
foreign import _createIndex :: forall e. Fn4 ObjectStore String (Array String) { unique :: Boolean, multiEntry :: Boolean } (Aff (idb :: IDB | e) Index)
|
||||
foreign import _createIndex
|
||||
:: forall e
|
||||
. Fn4 ObjectStore String (Array String) { unique :: Boolean, multiEntry :: Boolean } (Aff (idb :: IDB | e) Index)
|
||||
|
||||
|
||||
foreign import _delete :: forall e. Fn2 ObjectStore KeyRange (Aff (idb :: IDB | e) Unit)
|
||||
foreign import _delete
|
||||
:: forall e
|
||||
. Fn2 ObjectStore KeyRange (Aff (idb :: IDB | e) Unit)
|
||||
|
||||
|
||||
foreign import _deleteIndex :: forall e. Fn2 ObjectStore String (Aff (idb :: IDB | e) Unit)
|
||||
foreign import _deleteIndex
|
||||
:: forall e
|
||||
. Fn2 ObjectStore String (Aff (idb :: IDB | e) Unit)
|
||||
|
||||
|
||||
foreign import _index :: forall e. Fn2 ObjectStore String (Aff (idb :: IDB | e) Index)
|
||||
foreign import _index
|
||||
:: forall e
|
||||
. Fn2 ObjectStore String (Aff (idb :: IDB | e) Index)
|
||||
|
||||
|
||||
foreign import _indexNames :: ObjectStore -> Array String
|
||||
foreign import _indexNames
|
||||
:: ObjectStore
|
||||
-> Array String
|
||||
|
||||
|
||||
foreign import _keyPath :: ObjectStore -> Array String
|
||||
foreign import _keyPath
|
||||
:: ObjectStore
|
||||
-> Array String
|
||||
|
||||
|
||||
foreign import _name :: ObjectStore -> String
|
||||
foreign import _name
|
||||
:: ObjectStore
|
||||
-> String
|
||||
|
||||
|
||||
foreign import _put :: forall value e. Fn3 ObjectStore value (Nullable Foreign) (Aff (idb :: IDB | e) Foreign)
|
||||
foreign import _put
|
||||
:: forall value e
|
||||
. Fn3 ObjectStore value (Nullable Foreign) (Aff (idb :: IDB | e) Foreign)
|
||||
|
||||
|
||||
foreign import _transaction :: ObjectStore -> Transaction
|
||||
foreign import _transaction
|
||||
:: ObjectStore
|
||||
-> Transaction
|
||||
|
||||
Loading…
Reference in New Issue
Block a user