Class IDB

Hierarchy

Implements

IDBInterface

Index

Constructors

constructor

Properties

Accessors

closedDueToVersionChange

Methods

delete deleteAll followDataUpdates get getAll has onDataUpdate set update

Constructors

constructor

new IDB(name: string, version: number, objectStores: StoreDefinition[], options?: IDBOptions): IDB
Create database and return its wrapper
Parameters
- name: string
  
  Database name
- version: number
  
  Database version
- objectStores: StoreDefinition[]
  
  Object stores that will create and update with database version change
- options: IDBOptions = {}
  
  Options for IDB object
Returns IDB
- Defined in IDB.ts:31

Properties

db

db: IDBDatabase

Access to raw database connection object. Use this for close database via yourDbVariable.db.close()

Accessors

closedDueToVersionChange

get closedDueToVersionChange(): undefined | boolean
Flag to check is connection to database was closed due to versionchange event

Returns undefined | boolean
Implementation of IDBInterface.closedDueToVersionChange
- Defined in IDB.ts:20

Methods

delete

delete<K>(store: string, keys: K | K[]): Promise<void>
Delete item from store by store default key
Type Parameters
- K
Parameters
- store: string
  
  Name of database store
- keys: K | K[]
  
  Key value to access item in the store
Returns Promise<void>
Implementation of IDBInterface.delete
- Defined in IDB.ts:230

deleteAll

deleteAll(store: string): Promise<void>
Delete all items from the store
Parameters
- store: string
  
  Name of database store
Returns Promise<void>
Implementation of IDBInterface.deleteAll
- Defined in IDB.ts:238

followDataUpdates

followDataUpdates<T, K>(store: string, keys: K, listener: UpdatedDataListener<void | T>): Promise<UnregisterListener>
Set a listener that follow updates happened only with the selected items in store

Example
```
// Follow one item:
db.followDataUpdates<ItemType, number>('store', 123, callback)
```
Example
```
// Follow multiple items, if no keys array - follow all changes in store:
db.followDataUpdates<ItemType, number>('store', [123, 124], callback)
```
Example
```
// Explicit follow all changes in store:
db.followDataUpdates<ItemType>('store', { getAll: true }, callback)
```
Type Parameters
- T
- K
Parameters
- store: string
  
  Name of database store
- keys: K
  
  Key of item to follow / array of item keys to follow, if no - fallback to all store items / explicit { getAll: true } to follow all changes in store
- listener: UpdatedDataListener<void | T>
  
  Async function that calls every time when updates happened with selected items
Returns Promise<UnregisterListener>
Implementation of IDBInterface.followDataUpdates
- Defined in IDB.ts:281
followDataUpdates<T, K>(store: string, keys: void | K[], listener: UpdatedDataListener<(void | T)[]>): Promise<UnregisterListener>
Type Parameters
- T
- K
Parameters
- store: string
- keys: void | K[]
- listener: UpdatedDataListener<(void | T)[]>
Returns Promise<UnregisterListener>
Implementation of IDBInterface.followDataUpdates
- Defined in IDB.ts:287
followDataUpdates<T>(store: string, keys: {
getAll: true;
}, listener: UpdatedDataListener<T[]>): Promise<UnregisterListener>
Type Parameters
- T
Parameters
- store: string
- keys: {
  getAll: true;
  }
  - getAll: true
- listener: UpdatedDataListener<T[]>
Returns Promise<UnregisterListener>
Implementation of IDBInterface.followDataUpdates
- Defined in IDB.ts:293

get

get<T, K>(store: string, keys: K): Promise<void | T>
Receive item from store by default store key
Type Parameters
- T
- K
Parameters
- store: string
  
  Name of database store
- keys: K
  
  Key value to access item in the store
Returns Promise<void | T>
Implementation of IDBInterface.get
- Defined in IDB.ts:146
get<T, K>(store: string, keys: K[]): Promise<(void | T)[]>
Type Parameters
- T
- K
Parameters
- store: string
- keys: K[]
Returns Promise<(void | T)[]>
Implementation of IDBInterface.get
- Defined in IDB.ts:147
get<T, K>(store: string, keys: K | K[]): Promise<void | T | (void | T)[]>
Type Parameters
- T
- K
Parameters
- store: string
- keys: K | K[]
Returns Promise<void | T | (void | T)[]>
Implementation of IDBInterface.get
- Defined in IDB.ts:148

getAll

getAll<T>(store: string, onData?: DataReceivingCallback<T>): Promise<T[]>
Receive all items from the store
Type Parameters
- T
Parameters
- store: string
  
  Name of database store
- Optional onData: DataReceivingCallback<T>
  
  Sync function that calls every time when next item received
Returns Promise<T[]>
Implementation of IDBInterface.getAll
- Defined in IDB.ts:209

has

has<K>(store: string, keys: K): Promise<boolean>
Check for item with key exist or return how much items are in the store if no keys argument
Type Parameters
- K
Parameters
- store: string
  
  Name of database store
- keys: K
  
  Key value to access item in store, if no key - return items amount in the store
Returns Promise<boolean>
Implementation of IDBInterface.has
- Defined in IDB.ts:245
has<K>(store: string, keys: K[]): Promise<boolean[]>
Type Parameters
- K
Parameters
- store: string
- keys: K[]
Returns Promise<boolean[]>
Implementation of IDBInterface.has
- Defined in IDB.ts:246
has<K>(store: string, keys: K | K[]): Promise<boolean | boolean[]>
Type Parameters
- K
Parameters
- store: string
- keys: K | K[]
Returns Promise<boolean | boolean[]>
Implementation of IDBInterface.has
- Defined in IDB.ts:247
has(store: string): Promise<number>
Parameters
- store: string
Returns Promise<number>
Implementation of IDBInterface.has
- Defined in IDB.ts:248

onDataUpdate

onDataUpdate<K>(store: string, listener: DataUpdateListener<K>): Promise<UnregisterListener>
Set a listener to the store that calls every time some changes in the store happened
Type Parameters
- K
Parameters
- store: string
  
  Name of database store
- listener: DataUpdateListener<K>
  
  Async function that calls every time when 'set', 'delete' and 'deleteAll' operations in the store happens
Returns Promise<UnregisterListener>
Implementation of IDBInterface.onDataUpdate
- Defined in IDB.ts:267

set

set<T>(store: string, items: T): Promise<boolean>
Add or rewrite item in the store

Example
```
{title: 'Book', author: 'Bob', data: new ArrayBuffer(32), pages: 12}
```
Type Parameters
- T
Parameters
- store: string
  
  Name of database store
- items: T
  
  Serializable object that IDB can store
Returns Promise<boolean>
Implementation of IDBInterface.set
- Defined in IDB.ts:128
set<T>(store: string, items: T[]): Promise<boolean[]>
Type Parameters
- T
Parameters
- store: string
- items: T[]
Returns Promise<boolean[]>
Implementation of IDBInterface.set
- Defined in IDB.ts:129
set<T>(store: string, items: T | T[]): Promise<boolean | boolean[]>
Type Parameters
- T
Parameters
- store: string
- items: T | T[]
Returns Promise<boolean | boolean[]>
Implementation of IDBInterface.set
- Defined in IDB.ts:130

update

update<T, K>(store: string, keys: K, updateCallbacks: UpdateCallback<T>): Promise<T>
Convenient method for get, modify and set back item to the store
Type Parameters
- T
- K
Parameters
- store: string
  
  Name of database store
- keys: K
  
  Key value to access item in the store
- updateCallbacks: UpdateCallback<T>
  
  Async function that receives item and can directly modify them
Returns Promise<T>
Implementation of IDBInterface.update
- Defined in IDB.ts:161
update<T, K>(store: string, keys: K[], updateCallbacks: UpdateCallback<T> | UpdateCallback<T>[]): Promise<T[]>
Type Parameters
- T
- K
Parameters
- store: string
- keys: K[]
- updateCallbacks: UpdateCallback<T> | UpdateCallback<T>[]
Returns Promise<T[]>
Implementation of IDBInterface.update
- Defined in IDB.ts:164
update<T, K>(store: string, keys: K | K[], updateCallbacks: UpdateCallback<T> | UpdateCallback<T>[]): Promise<T | T[]>
Type Parameters
- T
- K
Parameters
- store: string
- keys: K | K[]
- updateCallbacks: UpdateCallback<T> | UpdateCallback<T>[]
Returns Promise<T | T[]>
Implementation of IDBInterface.update
- Defined in IDB.ts:167

Settings

Member Visibility

Theme

Class IDB

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

name: string

version: number

objectStores: StoreDefinition[]

options: IDBOptions = {}

Returns IDB

Properties

db

Accessors

closedDueToVersionChange

Returns undefined | boolean

Methods

delete

Type Parameters

K

Parameters

store: string

keys: K | K[]

Returns Promise<void>

deleteAll

Parameters

store: string

Returns Promise<void>

followDataUpdates

Example

Example

Example

Type Parameters

T

K

Parameters

store: string

keys: K

listener: UpdatedDataListener<void | T>

Returns Promise<UnregisterListener>

Type Parameters

T

K

Parameters

store: string

keys: void | K[]

listener: UpdatedDataListener<(void | T)[]>

Returns Promise<UnregisterListener>

Type Parameters

T

Parameters

store: string

keys: { getAll: true; }

getAll: true

listener: UpdatedDataListener<T[]>

Returns Promise<UnregisterListener>

get

Type Parameters

T

K

Parameters

store: string

keys: K

Returns Promise<void | T>

Type Parameters

T

K

Parameters

store: string

keys: K[]

Returns Promise<(void | T)[]>

Type Parameters

keys: {
getAll: true;
}

`Optional` onData: DataReceivingCallback<T>