Class ObjectStore

Object store client used for primary-key operations.

Index

Methods

get getKey add put delete clear getAll getAllKeys count deleteRange openCursor openKeyCursor index

Methods

get

get(id: string): Promise<Record>
Reads a record by primary key.
Parameters
- id: string
Returns Promise<Record>
- Defined in ../../src/indexeddb.ts:998

getKey

getKey(id: string): Promise<string>
Reads the generated primary key for a record.
Parameters
- id: string
Returns Promise<string>
- Defined in ../../src/indexeddb.ts:1006

add

add(record: Record): Promise<void>
Inserts a new record and fails if it already exists.
Parameters
- record: Record
Returns Promise<void>
- Defined in ../../src/indexeddb.ts:1014

put

put(record: Record): Promise<void>
Inserts or replaces a record.
Parameters
- record: Record
Returns Promise<void>
- Defined in ../../src/indexeddb.ts:1021

delete

delete(id: string): Promise<void>
Deletes a record by primary key.
Parameters
- id: string
Returns Promise<void>
- Defined in ../../src/indexeddb.ts:1028

clear

clear(): Promise<void>
Removes all records from the object store.

Returns Promise<void>
- Defined in ../../src/indexeddb.ts:1035

getAll

getAll(keyRange?: KeyRange): Promise<Record[]>
Reads all records in the object store or within a key range.
Parameters
- OptionalkeyRange: KeyRange
Returns Promise<Record[]>
- Defined in ../../src/indexeddb.ts:1042

getAllKeys

getAllKeys(keyRange?: KeyRange): Promise<string[]>
Reads all primary keys in the object store or within a key range.
Parameters
- OptionalkeyRange: KeyRange
Returns Promise<string[]>
- Defined in ../../src/indexeddb.ts:1053

count

count(keyRange?: KeyRange): Promise<number>
Counts records in the object store or within a key range.
Parameters
- OptionalkeyRange: KeyRange
Returns Promise<number>
- Defined in ../../src/indexeddb.ts:1064

deleteRange

deleteRange(keyRange: KeyRange): Promise<number>
Deletes records within a key range.
Parameters
- keyRange: KeyRange
Returns Promise<number>
- Defined in ../../src/indexeddb.ts:1075

openCursor

openCursor(options?: OpenCursorOptions): Promise<Cursor | null>
Opens a cursor over the object store.
Parameters
- Optionaloptions: OpenCursorOptions
Returns Promise<Cursor | null>
- Defined in ../../src/indexeddb.ts:1086

openKeyCursor

openKeyCursor(options?: OpenCursorOptions): Promise<Cursor | null>
Opens a key-only cursor over the object store.
Parameters
- Optionaloptions: OpenCursorOptions
Returns Promise<Cursor | null>
- Defined in ../../src/indexeddb.ts:1093

index

index(name: string): Index
Returns a client bound to a secondary index.
Parameters
- name: string
Returns Index
- Defined in ../../src/indexeddb.ts:1100