Module: IndexedDB::index

IndexedDB

exported: default
kind: object
declaration: const

Properties

🚫 _name

Type: string
kind: value

the name of the current db

🚫 _definitions

Type: Array.<Function>
kind: value

Methods

🚫 _setup() => {Promise.<IDBDatabase>}

kind: function

runs all db setup tasks

constructor(name) => {IndexedDB}

kind: function

Instantiates a new indexed DB. All version definitions have to be made done synchronously. The actual database creation is immediately scheduled for the next event cycle.

Name	Type	Description
name	string	of the db to open

_make(args) => {IndexedDB}

kind: function

Name	Type	Description
args	...any

define(version) => {IndexedDefinition}

kind: function

Creates a new version definition for the DB. All stores and indexes for the current version have to be defined in this definition.

Name	Type	Description
version	number	the version to be defined, don't use floats

read(storeName) => {IndexedQueryCompiler}

kind: function

Creates a new query to the database. The store which should be queried from has to be specified.

Name	Type	Description
storeName	string	to read from

write(storeName, value) => {Promise}

kind: function

Stores an object in the selected store. The promise resolves to the transaction result.

Name	Type	Description
storeName	string	name of the targeted store
value	object	value to store

delete(storeName) => {IndexedDeleteRangeCompiler}

kind: function

Removes objects which match the specified key range from the selected store. The key range is always matched against the stores primary key.

Name	Type	Description
storeName	string

clear(storeName) => {Promise}

kind: function

Removes all entries from the selected store.

Name	Type	Description
storeName	string

close() => {?}

kind: function

upgrade(version) => {?}

kind: function

Name	Type	Description
version	?