Class IdbKeyVal

Simple Key Value store Defaults to 'auth-client-db' with an object store of 'ic-keyval'

Hierarchy

IdbKeyVal

Index

Constructors

constructor

Methods

Constructors

Private constructor

new IdbKeyVal(_db: Database, _storeName: string): IdbKeyVal

- Defined in db.ts:77
Parameters
- _db: Database
- _storeName: string
Returns IdbKeyVal

Methods

get

get<T>(key: IDBValidKey): Promise<null | T>

- Defined in db.ts:96
Basic getter Pass in a type T for type safety if you know the type the value will have if it is found

example
await get('exampleKey') -> 'exampleValue'

Type Parameters
- T
Parameters
- key: IDBValidKey
  
  string | number | Date | BufferSource | IDBValidKey[]
Returns Promise<null | T>
Promise<T | null>

remove

remove(key: IDBValidKey): Promise<void>

- Defined in db.ts:105
Remove a key

Parameters
- key: IDBValidKey
  
  {@link IDBValidKey}
Returns Promise<void>
void

set

set<T>(key: IDBValidKey, value: T): Promise<IDBValidKey>

- Defined in db.ts:85
Basic setter

Type Parameters
- T
Parameters
- key: IDBValidKey
  
  string | number | Date | BufferSource | IDBValidKey[]
- value: T
  
  value to set
Returns Promise<IDBValidKey>
void

Static create

create(options?: DBCreateOptions): Promise<IdbKeyVal>

- Defined in db.ts:70
default
default
constructs
an IdbKeyVal

Parameters
- Optional options: DBCreateOptions
  
  DBCreateOptions
Returns Promise<IdbKeyVal>

Generated using TypeDoc