Class LocalStoreItem<T>

constructor

• new LocalStoreItem<T>(
      key: string,
      defaultExpiryMs?: number | Duration,
      store?: LocalStore,
  ): LocalStoreItem<T>

  Type Parameters

  • T

  Parameters

  • key: string
  • defaultExpiryMs: number | Duration = LocalStoreConfig.expiryMs
  • store: LocalStore = localStore

  Returns LocalStoreItem<T>

ReadonlydefaultExpiryMs

Readonlykey

Readonlystore

delete

• delete(): void

  Delete this key from the store.

  Returns void

get

• get(): T | undefined

  Get a value by key, or undefined if it does not exist.

  Returns T | undefined

getStoredObject

• getStoredObject(): StoredObject<T> | undefined

  Example usage:

  const { value, storedMs, expiryMs, storedMs } = await myLocalItem.getStoredObject();

  Returns StoredObject<T> | undefined

set

• set(value: T, expiryDeltaMs?: number | undefined): void

  Set a value in the store.

  Parameters

  • value: T
  • expiryDeltaMs: number | undefined = ...

  Returns void