Interface IStorage

Define a storage manager

Hierarchy

IStorage

Index

Methods

clear get getKeys has isAvailable remove set updatePassword

Methods

clear

clear(): Promise<void>
Clear all stored key-value pairs

Returns Promise<void>
- Defined in storage/interfaces.ts:35

get

get(key): Promise<string>
Get the value of a key. Returns null if the key is not available in storage
Parameters
- key: string
Returns Promise<string>
- Defined in storage/interfaces.ts:18

getKeys

getKeys(): Promise<string[]>
Get all existing keys from storage.

Returns Promise<string[]>
- Defined in storage/interfaces.ts:40

has

has(key): Promise<boolean>
Check if a key exists in storage
Parameters
- key: string
Returns Promise<boolean>
- Defined in storage/interfaces.ts:24

isAvailable

isAvailable(): boolean
Check whether the storage is available to use

Returns boolean
- Defined in storage/interfaces.ts:45

remove

remove(key): Promise<void>
Remove a key out of storage.
Parameters
- key: string
Returns Promise<void>
- Defined in storage/interfaces.ts:30

set

set(key, value): Promise<void>
Set a key-value pair to storage
Parameters
- key: string
- value: string
Returns Promise<void>
- Defined in storage/interfaces.ts:11

updatePassword

updatePassword(password): Promise<void>
Update new password and re-sync all existing items in storage
Parameters
- password: string
Returns Promise<void>
- Defined in storage/interfaces.ts:51

Generated using TypeDoc