Database.IndexedDB.Core
- Package
- purescript-indexeddb
- Repository
- truqu/purescript-indexedDB
The Core module gathers types used across the library and provides basic Show instances for those types.
#Transaction Source
data Transaction :: Type
A Transaction is used to interact with the data in a database. Whenever data is read or written to the database it is done by using a transaction.
Instances
#ObjectStore Source
data ObjectStore :: Type
An object store is the primary storage mechanism for storing data in a database.
Instances
#ValueCursor Source
data ValueCursor :: Type
A cursor is used to iterate over a range of records in an index or an object store in a specific direction. A ValueCursor also holds the value corresponding to matching key.
Instances
#CursorDirection Source
data CursorDirection
A cursor has a direction that determines whether it moves in monotonically increasing or decreasing order of the record keys when iterated, and if it skips duplicated values when iterating indexes. The direction of a cursor also determines if the cursor initial position is at the start of its source or at its end.
Constructors
Instances
#CursorSource Source
data CursorSource
If the source of a cursor is an object store, the effective object store of the cursor is that object store and the effective key of the cursor is the cursor’s position. If the source of a cursor is an index, the effective object store of the cursor is that index’s referenced object store and the effective key is the cursor’s object store position.
Constructors
#KeyPath Source
type KeyPath = Array String
A key path is a list of strings that defines how to extract a key from a value. A valid key path is one of:
- An empty list.
- An singleton identifier, which is a string matching the IdentifierName production from the ECMAScript Language Specification [ECMA-262].
- A singleton string consisting of two or more identifiers separated by periods (U+002E FULL STOP).
- A non-empty list containing only strings conforming to the above requirements.
#TransactionMode Source
data TransactionMode
A transaction has a mode that determines which types of interactions can be performed upon that transaction. The mode is set when the transaction is created and remains fixed for the life of the transaction.
Constructors
Instances
#IDBConcreteCursor Source
class (IDBCursor cursor) <= IDBConcreteCursor cursor
A concrete cursor not only shares IDBCursor properties, but also some specific attributes (see KeyCursor or CursorWithValue).
Instances
#IDBCursor Source
class IDBCursor cursor
Cursor objects implement the IDBCursor interface. There is only ever one IDBCursor instance representing a given cursor. There is no limit on how many cursors can be used at the same time.
Instances
#IDBDatabase Source
#IDBIndex Source
class IDBIndex index
The IDBIndex interface represents an index handle. Any of these methods throw an "TransactionInactiveError" DOMException if called when the transaction is not active.
Instances
#IDBKeyRange Source
#IDBObjectStore Source
class IDBObjectStore store
The IDBObjectStore interface represents an object store handle.
Instances
Re-exports from Database.IndexedDB.IDBKey
- Modules
- Database.
IndexedDB. Core - Database.
IndexedDB. IDBCursor - Database.
IndexedDB. IDBDatabase - Database.
IndexedDB. IDBFactory - Database.
IndexedDB. IDBIndex - Database.
IndexedDB. IDBKey - Database.
IndexedDB. IDBKey. Internal - Database.
IndexedDB. IDBKeyRange - Database.
IndexedDB. IDBObjectStore - Database.
IndexedDB. IDBTransaction