Class Index

Secondary-index client used for lookup and cursor operations.

Index

Methods

get getKey getAll getAllKeys count delete openCursor openKeyCursor

Methods

get

get(...values: unknown[]): Promise<Record>
Reads the first record matching the supplied index values.
Parameters
- ...values: unknown[]
Returns Promise<Record>
- Defined in ../../src/indexeddb.ts:1121

getKey

getKey(...values: unknown[]): Promise<string>
Reads the primary key for the first matching index entry.
Parameters
- ...values: unknown[]
Returns Promise<string>
- Defined in ../../src/indexeddb.ts:1135

getAll

getAll(keyRange?: KeyRange, ...values: unknown[]): Promise<Record[]>
Reads all records matching the supplied index values and optional range.
Parameters
- OptionalkeyRange: KeyRange
- ...values: unknown[]
Returns Promise<Record[]>
- Defined in ../../src/indexeddb.ts:1149

getAllKeys

getAllKeys(keyRange?: KeyRange, ...values: unknown[]): Promise<string[]>
Reads all primary keys matching the supplied index values and optional range.
Parameters
- OptionalkeyRange: KeyRange
- ...values: unknown[]
Returns Promise<string[]>
- Defined in ../../src/indexeddb.ts:1162

count

count(keyRange?: KeyRange, ...values: unknown[]): Promise<number>
Counts records matching the supplied index values and optional range.
Parameters
- OptionalkeyRange: KeyRange
- ...values: unknown[]
Returns Promise<number>
- Defined in ../../src/indexeddb.ts:1175

delete

delete(...values: unknown[]): Promise<number>
Deletes records matching the supplied index values.
Parameters
- ...values: unknown[]
Returns Promise<number>
- Defined in ../../src/indexeddb.ts:1188

openCursor

openCursor(
options?: OpenCursorOptions,
...values: unknown[],
): Promise<Cursor | null>
Opens a cursor over the index.
Parameters
- Optionaloptions: OpenCursorOptions
- ...values: unknown[]
Returns Promise<Cursor | null>
- Defined in ../../src/indexeddb.ts:1200

openKeyCursor

openKeyCursor(
options?: OpenCursorOptions,
...values: unknown[],
): Promise<Cursor | null>
Opens a key-only cursor over the index.
Parameters
- Optionaloptions: OpenCursorOptions
- ...values: unknown[]
Returns Promise<Cursor | null>
- Defined in ../../src/indexeddb.ts:1211