Class AsyncStorage

Hierarchy

Storage
- AsyncStorage

Index

Constructors

constructor

new AsyncStorage(name, clear, get, has, remove, set): AsyncStorage
Parameters
- name: string
- clear: (() => Promise<void>)
  - - (): Promise<void>
    - Returns Promise<void>
- get: (<T>(key) => Promise<T>)
  - - <T>(key): Promise<T>
    - Type Parameters
      
      T extends StorageItem
      
      Parameters
      
      key: string
      
      Returns Promise<T>
- has: ((key) => Promise<boolean>)
  - - (key): Promise<boolean>
    - Parameters
      
      key: string
      
      Returns Promise<boolean>
- remove: ((key) => Promise<void>)
  - - (key): Promise<void>
    - Parameters
      
      key: string
      
      Returns Promise<void>
- set: (<T>(key, item) => Promise<void>)
  - - <T>(key, item): Promise<void>
    - Type Parameters
      
      T extends StorageItem
      
      Parameters
      
      key: string
      
      item: T
      
      Returns Promise<void>
Returns AsyncStorage
Overrides Storage.constructor
- Defined in src/modules/async-storage.ts:10

Properties

`Protected` `Readonly` _clear

_clear: (() => void | Error | Promise<void | Error>)

Type declaration

- (): void | Error | Promise<void | Error>
- Returns void | Error | Promise<void | Error>

`Protected` `Readonly` _get

_get: (<T>(key) => Error | T | Promise<Error | T>)

Type declaration

- <T>(key): Error | T | Promise<Error | T>
- Type Parameters
  - T extends StorageItem
  Parameters
  - key: string
  Returns Error | T | Promise<Error | T>

`Protected` `Readonly` _has

_has: ((key) => boolean | Error | Promise<boolean | Error>)

Type declaration

- (key): boolean | Error | Promise<boolean | Error>
- Parameters
  - key: string
  Returns boolean | Error | Promise<boolean | Error>

`Protected` `Readonly` _remove

_remove: ((key) => void | Error | Promise<void | Error>)

Type declaration

- (key): void | Error | Promise<void | Error>
- Parameters
  - key: string
  Returns void | Error | Promise<void | Error>

`Protected` `Readonly` _set

_set: (<T>(key, item) => void | Error | Promise<void | Error>)

Type declaration

- <T>(key, item): void | Error | Promise<void | Error>
- Type Parameters
  - T extends StorageItem
  Parameters
  - key: string
  - item: T
  Returns void | Error | Promise<void | Error>

`Readonly` name

name: string

Methods

clear

clear(): Promise<void | Error>
Returns Promise<void | Error>
Overrides Storage.clear
- Defined in src/modules/async-storage.ts:21

`Protected` clear_

clear_(cleared): void | Error
Parameters
- cleared: void | Error
Returns void | Error
Inherited from Storage.clear_
- Defined in src/modules/storage.ts:35

copy

copy<T1, T2, T>(key, target, keys?): Promise<void | Error>
Type Parameters
- T1 extends StorageItem
- T2 extends StorageTarget
- T extends StorageItem & StorageTarget
Parameters
- key: string
- target: T2
- Optional keys: (keyof T)[]
Returns Promise<void | Error>
Overrides Storage.copy
- Defined in src/modules/async-storage.ts:55

`Protected` copy_

copy_<T1, T2, T>(key, target, keys, item): void | Error
Type Parameters
- T1 extends StorageItem
- T2 extends StorageTarget
- T extends StorageItem & StorageTarget
Parameters
- key: string
- target: T2
- keys: undefined | (keyof T)[]
- item: Error | T1
Returns void | Error
Inherited from Storage.copy_
- Defined in src/modules/storage.ts:118

get

get<T>(key): Promise<Error | T>
Type Parameters
- T extends StorageItem
Parameters
- key: string
Returns Promise<Error | T>
Overrides Storage.get
- Defined in src/modules/async-storage.ts:25

`Protected` get_

get_<T>(key, item): Error | T
Type Parameters
- T extends StorageItem
Parameters
- key: string
- item: Error | T
Returns Error | T
Inherited from Storage.get_
- Defined in src/modules/storage.ts:44

has

has<T>(key, keys?): Promise<boolean>
Type Parameters
- T extends StorageItem
Parameters
- key: string
- Optional keys: (keyof T)[]
Returns Promise<boolean>
Overrides Storage.has
- Defined in src/modules/async-storage.ts:59

`Protected` has_

has_<T>(keys, item): boolean
Type Parameters
- T extends StorageItem
Parameters
- keys: undefined | (keyof T)[]
- item: Error | T
Returns boolean
Inherited from Storage.has_
- Defined in src/modules/storage.ts:150

remove

remove<T>(key, keys?): Promise<void | Error>
Type Parameters
- T extends StorageItem
Parameters
- key: string
- Optional keys: (keyof T)[]
Returns Promise<void | Error>
Overrides Storage.remove
- Defined in src/modules/async-storage.ts:29

`Protected` remove_

remove_(key, removed): void | Error
Parameters
- key: string
- removed: void | Error
Returns void | Error
Inherited from Storage.remove_
- Defined in src/modules/storage.ts:54

`Protected` remove__

remove__<T>(key, keys, item): Error | T
Type Parameters
- T extends StorageItem
Parameters
- key: string
- keys: (keyof T)[]
- item: Error | T
Returns Error | T
Inherited from Storage.remove__
- Defined in src/modules/storage.ts:59

`Protected` remove___

remove___<T>(key, item, set): void | Error
Type Parameters
- T extends StorageItem
Parameters
- key: string
- item: T
- set: void | Error
Returns void | Error
Inherited from Storage.remove___
- Defined in src/modules/storage.ts:70

set

set<T>(key, item, keys?): Promise<void | Error>
Type Parameters
- T extends StorageItem
Parameters
- key: string
- item: T
- Optional keys: (keyof T)[]
Returns Promise<void | Error>
Overrides Storage.set
- Defined in src/modules/async-storage.ts:42

`Protected` set_

set_<T>(key, item, set): void | Error
Type Parameters
- T extends StorageItem
Parameters
- key: string
- item: Error | T
- set: void | Error
Returns void | Error
Inherited from Storage.set_
- Defined in src/modules/storage.ts:88

`Protected` set__

set__<T>(item, keys, current): Error | T
Type Parameters
- T extends StorageItem
Parameters
- item: T
- keys: (keyof T)[]
- current: Error | T
Returns Error | T
Inherited from Storage.set__
- Defined in src/modules/storage.ts:95

Class AsyncStorage

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

name: string

clear: (() => Promise<void>)

Returns Promise<void>

get: (<T>(key) => Promise<T>)

Type Parameters

T extends StorageItem

Parameters

key: string

Returns Promise<T>

has: ((key) => Promise<boolean>)

Parameters

key: string

Returns Promise<boolean>

remove: ((key) => Promise<void>)

Parameters

key: string

Returns Promise<void>

set: (<T>(key, item) => Promise<void>)

Type Parameters

T extends StorageItem

Parameters

key: string

item: T

Returns Promise<void>

Returns AsyncStorage

Properties

Protected Readonly _clear

Type declaration

Returns void | Error | Promise<void | Error>

Protected Readonly _get

Type declaration

Type Parameters

T extends StorageItem

Parameters

key: string

Returns Error | T | Promise<Error | T>

Protected Readonly _has

Type declaration

Parameters

key: string

Returns boolean | Error | Promise<boolean | Error>

Protected Readonly _remove

Type declaration

Parameters

key: string

Returns void | Error | Promise<void | Error>

Protected Readonly _set

Type declaration

Type Parameters

T extends StorageItem

Parameters

key: string

item: T

Returns void | Error | Promise<void | Error>

Readonly name

Methods

clear

Returns Promise<void | Error>

Protected clear_

Parameters

cleared: void | Error

Returns void | Error

copy

Type Parameters

T1 extends StorageItem

T2 extends StorageTarget

T extends StorageItem & StorageTarget

Parameters

key: string

target: T2

Optional keys: (keyof T)[]

`Protected` `Readonly` _clear

`Protected` `Readonly` _get

`Protected` `Readonly` _has

`Protected` `Readonly` _remove

`Protected` `Readonly` _set

`Readonly` name

`Protected` clear_

`Optional` keys: (keyof T)[]

`Protected` copy_

`Protected` get_

`Optional` keys: (keyof T)[]

`Protected` has_

`Optional` keys: (keyof T)[]

`Protected` remove_

`Protected` remove__

`Protected` remove___