Class AbstractStorage`Abstract`

Description

Abstract class representing async key-value storage

Hierarchy

AbstractStorage
- BrowserLocalStorage
- BrowserIframeStorage

Index

Constructors

Methods

clear delete getKeys init readBytes readJSON readString storeBytes storeJSON storeString

Constructors

constructor

new AbstractStorage(): AbstractStorage
Returns AbstractStorage

Methods

`Abstract` clear

clear(): Promise<boolean>
Method to clear all key-value storage

Returns
Boolean indicating whether operation was successful

Returns Promise<boolean>
- Defined in src/storage/AbstractStorage.ts:52

`Abstract` delete

delete(key: string): Promise<boolean>
Method to get all keys from storage

Returns
Strings array with all the keys
Parameters
- key: string
Returns Promise<boolean>
- Defined in src/storage/AbstractStorage.ts:66

`Abstract` getKeys

getKeys(): Promise<string[]>
Method to get all keys from storage

Returns
Strings array with all the keys

Returns Promise<string[]>
- Defined in src/storage/AbstractStorage.ts:59

`Abstract` init

init(): Promise<boolean>
Method to initialize storage and check its availability

Returns Promise<boolean>
- Defined in src/storage/AbstractStorage.ts:11

`Abstract` readBytes

readBytes(key: string): Promise<null | Uint8Array>
Method to read arbitrary bytes by key
Parameters
- key: string
  
  Key to retrieve
Returns Promise<null | Uint8Array>
- Defined in src/storage/AbstractStorage.ts:45

readJSON

readJSON<T>(key: string): Promise<null | T>
Method to read object by key
Type Parameters
- T
Parameters
- key: string
  
  Key to retrieve
Returns Promise<null | T>
- Defined in src/storage/AbstractStorage.ts:86

readString

readString(key: string): Promise<null | string>
Method to read string by key
Parameters
- key: string
  
  Key to retrieve
Returns Promise<null | string>
- Defined in src/storage/AbstractStorage.ts:73

`Abstract` storeBytes

storeBytes(key: string, bytes: Uint8Array): Promise<boolean>
Method to store arbitrary bytes array
Parameters
- key: string
  
  Key for indexation
- bytes: Uint8Array
Returns Promise<boolean>
- Defined in src/storage/AbstractStorage.ts:18

storeJSON

storeJSON(key: string, val: any): Promise<boolean>
Method to store arbitrary serializeable object
Parameters
- key: string
  
  Key for indexation
- val: any
Returns Promise<boolean>
- Defined in src/storage/AbstractStorage.ts:36

storeString

storeString(key: string, str: string): Promise<boolean>
Method to store arbitrary string
Parameters
- key: string
  
  Key for indexation
- str: string
  
  Value to store
Returns Promise<boolean>
- Defined in src/storage/AbstractStorage.ts:26

Generated using TypeDoc