Class BrowserLocalStorage

Description

Class representing browser local storage

Hierarchy

AbstractStorage
- BrowserLocalStorage

Index

Constructors

Methods

clear delete getKeys init readBytes readJSON readString storeBytes storeJSON storeString

Constructors

constructor

new BrowserLocalStorage(): BrowserLocalStorage
Returns BrowserLocalStorage

Inherited from AbstractStorage.constructor

Methods

clear

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

Returns
Boolean indicating whether operation was successful

Returns Promise<boolean>
Overrides AbstractStorage.clear
- Defined in src/storage/BrowserLocalStorage.ts:35

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>
Overrides AbstractStorage.delete
- Defined in src/storage/BrowserLocalStorage.ts:48

getKeys

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

Returns
Strings array with all the keys

Returns Promise<string[]>
Overrides AbstractStorage.getKeys
- Defined in src/storage/BrowserLocalStorage.ts:44

init

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

Returns Promise<boolean>
Overrides AbstractStorage.init
- Defined in src/storage/BrowserLocalStorage.ts:10

readBytes

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

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>
Inherited from AbstractStorage.readJSON
- 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>
Inherited from AbstractStorage.readString
- Defined in src/storage/AbstractStorage.ts:73

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>
Overrides AbstractStorage.storeBytes
- Defined in src/storage/BrowserLocalStorage.ts:14

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>
Inherited from AbstractStorage.storeJSON
- 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>
Inherited from AbstractStorage.storeString
- Defined in src/storage/AbstractStorage.ts:26

Generated using TypeDoc