ixnay v1.0.3
ixnay
Simple promise based IndexedDb utilties
Functions
createConnectionObject(db, methods)
Creates a Connection object which you can use to interact with the db really it just turns an array of higher order funcs into an object containing... normal order funcs? normal funcs.. funcs. just funcs. i.e. funcA, funcB into {funcA: funcA(..), funcB: funcB(..)}
Kind: global function
Param | Type |
---|---|
db | IndexedDbConnection |
methods | Array |
getObjectStore(db, storeName, mode) ⇒ IndexedDbObjectStore
Retrieves object store with given mode.
Kind: global function
Param | Type |
---|---|
db | IndexedDbConnection |
storeName | String |
mode | String |
insertOne(db, storeName, entry) ⇒ function
Insert a single entry into database store.
Kind: global function
Param | Type |
---|---|
db | IndexedDbConnection |
storeName | String |
entry | Object |
Inserter(db, storeName, entries) ⇒ function
Generator for inserting entries into db.
Kind: global function
Param | Type |
---|---|
db | IndexedDbConnection |
storeName | String |
entries | Array |
insertAll(db, storeName, entries) ⇒ function
Insert multiple entries.
Kind: global function
Param | Type |
---|---|
db | IndexedDbConnection |
storeName | String |
entries | Array |
deleteAll(db) ⇒ function
Clear object store.
Kind: global function
Param | Type |
---|---|
db | IndexedDbConnection |
deleteById(db)
Delete entry by id.
Kind: global function
Param | Type |
---|---|
db | * |
insert(db) ⇒ function
Combine insert and insertAll into one function calls insertAll if the data passed is an array, otherwise it calls insertOne.
Kind: global function
Param | Type |
---|---|
db | IndexedDbConnection |
fetchById(db) ⇒ function
Fetch a database store entry by id.
Kind: global function
Param | Type |
---|---|
db | IndexedDbConnection |
updateById(db) ⇒ function
Update a single db entry.
Kind: global function
Param | Type |
---|---|
db | IndexedDbConnection |
fetchAll(db) ⇒ function
Fetch all database store entries.
Kind: global function
Param | Type |
---|---|
db | IndexedDbConnection |
fetchByIndex(db) ⇒ function
Fetch all database store entries matching index.
Kind: global function
Param | Type |
---|---|
db | IndexedDbConnection |
close(db) ⇒ function
Close the db.
Kind: global function
Param | Type |
---|---|
db | IndexedDbConnection |
getConnection(db) ⇒ function
Get db connection.
Kind: global function
Param | Type |
---|---|
db | IndexedDbConnection |
openDb(dbName, dbVersion, onUpgrade) ⇒ Promise
Open indexedDbConnection.
Kind: global function
Param | Type |
---|---|
dbName | String |
dbVersion | String |
onUpgrade | function |
connect(dbName, dbVersion, onUpgrade) ⇒ Promise
Open indexedDB connection and creates a connection object with everything plugged in.
Kind: global function
Param | Type |
---|---|
dbName | String |
dbVersion | String |
onUpgrade | function |