Class AsyncStorage<T>

A wrapper class for AsyncStorage for strict typing and inbuilt JSON serialization.

TODO: add support for custom JSON serializer if needed

Type Parameters

T

Index

Constructors

Methods

clear getItem removeItem setItem withInitialData

Constructors

constructor

new AsyncStorage<T>(storage, keyPrefix?): AsyncStorage<T>
Create a new AsyncStorage instance. The keyPrefix is used to namespace the keys in the underlying storage layer. It's optional, but recommended to avoid key collisions.
Type Parameters
- T
Parameters
- storage: IAsyncStorage
- Optional keyPrefix: string
Returns AsyncStorage<T>

Methods

clear

clear(): Promise<void>
Calling this method will clear all data for the given storage layer.

It might lead to unexpected behavior and/or data loss if other modules are using the same storage layer.

Returns Promise<void>

getItem

getItem(key): Promise<null | T>
Get the value for the given key.
Parameters
- key: string
Returns Promise<null | T>

removeItem

removeItem(key): Promise<void>
Remove the value for the given key.
Parameters
- key: string
Returns Promise<void>

setItem

setItem(key, value): Promise<void>
Set the value for the given key.
Parameters
- key: string
- value: T
Returns Promise<void>

`Static` withInitialData

withInitialData<T>(storage, initialData, keyPrefix?): Promise<AsyncStorage<T>>
Create a new AsyncStorage instance with initial data.
Type Parameters
- T
Parameters
- storage: IAsyncStorage
- initialData: Record<string, T>
- Optional keyPrefix: string
Returns Promise<AsyncStorage<T>>