Class Index<O, IK, PK>

IK is the type of this index, PK is the type of the primary key of the object of this index.

Type Parameters

O
IK extends IDBValidKey
PK extends IDBValidKey

Index

Constructors

Properties

Methods

count get getAll getAllPrimaryKeys getPrimaryKey requireGet

Constructors

constructor

new Index<O, IK, PK>(index): Index<O, IK, PK>
Type Parameters
- O
- IK extends IDBValidKey
- PK extends IDBValidKey
Parameters
- index: IDBIndex
Returns Index<O, IK, PK>

Properties

`Readonly` iterator

iterator: CursorIterator<O, IK, PK>

Methods

count

count(query?): Promise<number>
Parameters
- Optional query: IDBKeyRange | IK
Returns Promise<number>
See

get

get(key): Promise<undefined | O>
Parameters
- key: IDBKeyRange | IK
Returns Promise<undefined | O>
See

getAll

getAll(query?, count?): Promise<O[]>
Parameters
- Optional query: IDBKeyRange | IK
- Optional count: number
Returns Promise<O[]>

getAllPrimaryKeys

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

getPrimaryKey

getPrimaryKey(key): Promise<undefined | PK>
Parameters
- key: IDBKeyRange | IK
Returns Promise<undefined | PK>
See

requireGet

requireGet(key): Promise<O>
Parameters
- key: IDBKeyRange | IK
Returns Promise<O>
Throws
when no object with key is found

See