Class StorageAdapter<Values>

constructor

• new StorageAdapter<Values>(
      config: StorageAdapter.Config,
  ): StorageAdapter<Values>

  Type Parameters

  • Values

  Parameters

  • config: StorageAdapter.Config

  Returns StorageAdapter<Values>

Readonlydriver

Optional Readonlyprefix

remove

reset

Readonlystructured

assign

• assign<K extends string | number | symbol>(
      key: K,
      val: Partial<Values[K]>,
  ): Promise<void>

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • key: K
  • val: Partial<Values[K]>

  Returns Promise<void>

clear

• clear(): Promise<void>

  Returns Promise<void>

entries

• entries(): Promise<[keyof Values, Values[keyof Values]][]>

  Returns Promise<[keyof Values, Values[keyof Values]][]>

get

• get(): Promise<Values>

  Returns Promise<Values>

• get<K extends string | number | symbol>(key: K): Promise<Values[K] | null>

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • key: K

  Returns Promise<Values[K] | null>

• get<K extends string | number | symbol>(keys: K[]): Promise<Partial<Values>>

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • keys: K[]

  Returns Promise<Partial<Values>>

has

• has<K extends string | number | symbol>(key: K): Promise<boolean>

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • key: K

  Returns Promise<boolean>

• has<K extends string | number | symbol>(keys: K[]): Promise<boolean[]>

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • keys: K[]

  Returns Promise<boolean[]>

keys

• keys(): Promise<(keyof Values)[]>

  Returns Promise<(keyof Values)[]>

off

• off(event: StorageEventName, listener: StorageEventListener<Values>): void

  Parameters

  • event: StorageEventName
  • listener: StorageEventListener<Values>

  Returns void

on

• on(
      event: StorageEventName,
      listener: StorageEventListener<Values>,
  ): EventGenerator<Record<string, any>, any>

  Parameters

  • event: StorageEventName
  • listener: StorageEventListener<Values>

  Returns EventGenerator<Record<string, any>, any>

rm

• rm<K extends string | number | symbol>(keyOrKeys: K | K[]): Promise<void>

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • keyOrKeys: K | K[]

  Returns Promise<void>

scope

• scope<K extends string | number | symbol>(key: K): ScopedKey<Values, K>

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • key: K

  Returns ScopedKey<Values, K>

set

• set(values: Partial<Values> & Record<string, any>): Promise<void>

  Parameters

  • values: Partial<Values> & Record<string, any>

  Returns Promise<void>

• set<K extends string | number | symbol>(key: K, value: Values[K]): Promise<void>

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • key: K
  • value: Values[K]

  Returns Promise<void>

values

• values(): Promise<Values[keyof Values][]>

  Returns Promise<Values[keyof Values][]>