Class ObjectStore<T, PK, TNoKey>

T is the type of the object, PK is the type of the object's primary key.

Type Parameters

T extends TNoKey
PK extends IDBValidKey
TNoKey

Index

Constructors

Properties

Methods

add clear count createIndex delete deleteIndex get getAll getAllPrimaryKeys getPrimaryKey index put requireGet tryDeleteIndex

Constructors

constructor

new ObjectStore<T, PK, TNoKey>(objectStore): ObjectStore<T, PK, TNoKey>
Type Parameters
- T
- PK extends IDBValidKey
- TNoKey
Parameters
- objectStore: IDBObjectStore
Returns ObjectStore<T, PK, TNoKey>

Properties

`Readonly` iterator

iterator: CursorIterator<T, PK, PK>

Methods

add

add(value, key?): Promise<PK>
A Promise version of IDBObjectStore.add
Parameters
- value: TNoKey
- Optional key: PK
Returns Promise<PK>

clear

clear(): Promise<undefined>
A Promise version of IDBObjectStore.clear

Returns Promise<undefined>

count

count(query?): Promise<number>
A Promise version of IDBObjectStore.count
Parameters
- Optional query: PK | IDBKeyRange
Returns Promise<number>

createIndex

createIndex<IT>(indexDef): Index<T, IT, PK>
Type Parameters
- IT extends IDBValidKey
Parameters
- indexDef: IndexDef<IT>
Returns Index<T, IT, PK>
See

delete

delete(query): Promise<undefined>
Parameters
- query: PK | IDBKeyRange
Returns Promise<undefined>
See
IDBObjectStore.delete

deleteIndex

deleteIndex<IT>(indexDef): void
Type Parameters
- IT extends IDBValidKey
Parameters
- indexDef: IndexDef<IT>
Returns void
See

get

get(query): Promise<undefined | T>
Parameters
- query: PK | IDBKeyRange
Returns Promise<undefined | T>
See
IDBObjectStore.get

getAll

getAll(query?, count?): Promise<T[]>
A Promise version of IDBObjectStore.getAll
Parameters
- Optional query: PK | IDBKeyRange
- Optional count: number
Returns Promise<T[]>

getAllPrimaryKeys

getAllPrimaryKeys(query?, count?): Promise<PK[]>
Parameters
- Optional query: PK | IDBKeyRange
- Optional count: number
Returns Promise<PK[]>
See
IDBObjectStore.getAllKeys

getPrimaryKey

getPrimaryKey(query): Promise<undefined | PK>
Parameters
- query: PK | IDBKeyRange
Returns Promise<undefined | PK>
See
IDBObjectStore.getKey

index

index<IT>(indexDef): Index<T, IT, PK>
Type Parameters
- IT extends IDBValidKey
Parameters
- indexDef: IndexDef<IT>
Returns Index<T, IT, PK>
See

put

put(value, key?): Promise<PK>
A Promise version of IDBObjectStore.put
Parameters
- value: T
- Optional key: PK
Returns Promise<PK>

requireGet

requireGet(key): Promise<T>
It is get but will throw if no object is found
Parameters
- key: PK | IDBKeyRange
Returns Promise<T>
Throws
when no object with key is found

tryDeleteIndex

tryDeleteIndex(name): boolean
Try to delete an index of the specified name. Return true if delete successfully.
Parameters
- name: string
Returns boolean
See