Module: /utils/userIndexedDB

On this page

mapp.utils.userIndexedDB

The module exports method to store and retrieve objects from a userIndexedDB.

Source: utils/userIndexedDB.mjs, line 1

Methods

(inner) add(params) → {Promise}

Parameters:

Name	Type	Description
`params`	Object

Properties

Name	Type	Description
`params.user`	string
`params.db`	string
`params.store`	string
`params.key`	object

Source: utils/userIndexedDB.mjs, line 69

Returns:

addPromise

Type:: Promise

(inner) deleteDB()

Source: utils/userIndexedDB.mjs, line 62

(inner) get(params) → {Promise}

Parameters:

Name	Type	Description
`params`	Object

Properties

Name	Type	Description
`params.user`	string
`params.workspace`	string
`params.store`	string
`params.name`	object

Source: utils/userIndexedDB.mjs, line 103

Returns:

getPromise

Type:: Promise

(inner) openDB(params) → {Promise}

The method is called from any transaction method to interact with the userIndexedDB.

A new database will be created when attempting to open a DB which does not exist.

A new store will be created when a new DB is upgraded [on creation].

Parameters:

Name	Type	Description
`params`	object

Properties

Name	Type	Description
`params.store`	string
`params.user`	string
`params.workspace`	string

Source: utils/userIndexedDB.mjs, line 11

Returns:

OpenDBPromise

Type:: Promise

(inner) put(params) → {Promise}

Parameters:

Name	Type	Description
`params`	Object

Properties

Name	Type	Description
`params.user`	string
`params.db`	string
`params.store`	string
`params.obj`	object

Source: utils/userIndexedDB.mjs, line 166

Returns:

updatePromise

Type:: Promise