IdbKeyVal
Defined in: src/client/db.ts:59
Simple Key Value store
Defaults to 'auth-client-db' with an object store of 'ic-keyval'
Methods
Section titled “Methods”get<
T>(key):Promise<T|null>
Defined in: src/client/db.ts:146
Basic getter Pass in a type T for type safety if you know the type the value will have if it is found
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”IDBValidKey
string | number | Date | BufferSource | IDBValidKey[]
Returns
Section titled “Returns”Promise<T | null>
Promise<T | null>
Example
Section titled “Example”await get<string>('exampleKey') -> 'exampleValue'remove()
Section titled “remove()”remove(
key):Promise<void>
Defined in: src/client/db.ts:155
Remove a key
Parameters
Section titled “Parameters”IDBValidKey
IDBValidKey
Returns
Section titled “Returns”Promise<void>
void
set<
T>(key,value):Promise<IDBValidKey>
Defined in: src/client/db.ts:135
Basic setter
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”IDBValidKey
string | number | Date | BufferSource | IDBValidKey[]
T
value to set
Returns
Section titled “Returns”Promise<IDBValidKey>
void
create()
Section titled “create()”
staticcreate(options?):Promise<IdbKeyVal>
Defined in: src/client/db.ts:68
Parameters
Section titled “Parameters”options?
Section titled “options?”DBCreateOptions
Returns
Section titled “Returns”Promise<IdbKeyVal>
Default
Section titled “Default”Default
Section titled “Default”