Class KvStore

constructor

• new KvStore(
      dbName: string,
      options?: {
          dbVersion?: number;
          defaultExpiryMs?: number | Duration;
          gcIntervalMs?: number | Duration;
          storeName?: string;
      },
  ): KvStore

  Parameters

  • dbName: string
  • Optionaloptions: {
        dbVersion?: number;
        defaultExpiryMs?: number | Duration;
        gcIntervalMs?: number | Duration;
        storeName?: string;
    }

  Returns KvStore

ReadonlydbName

ReadonlydbVersion

ReadonlydefaultExpiryMs

ReadonlygcIntervalMs

ReadonlygcMsStorageKey

ReadonlystoreName

lastGcMs

• get lastGcMs(): number

  Returns the ms timestamp for the last GC (garbage collection).

  Returns number

• set lastGcMs(ms: number): void

  Set the ms timestamp for the last GC (garbage collection).

  Parameters

  • ms: number

  Returns void

asMap

• asMap<T>(): Promise<Map<string, StoredObject<T>>>

  Returns all items as map of key to value, mainly used for debugging dumps. The type T is applied to all values, even though they might not be of type T (in the case when you store different data types in the same store).

  Type Parameters

  • T

  Returns Promise<Map<string, StoredObject<T>>>

asStorageAdapter

• asStorageAdapter<T>(): StorageAdapter<T>

  Returns this casted into a StorageAdapter.

  Type Parameters

  • T

  Returns StorageAdapter<T>

clear

• clear(): Promise<void>

  Remove all items from the store.

  Returns Promise<void>

delete

• delete(key: string | string[]): Promise<void>

  Delete one or multiple keys.

  Parameters

  • key: string | string[]

  Returns Promise<void>

forEach

• forEach<T>(
      callback: (
          key: string,
          value: T,
          expiryMs: number,
          storedMs: number,
      ) => void | Promise<void>,
  ): Promise<void>

  Generic way to iterate through all entries.

  Type Parameters

  • T

  Parameters

  • callback: (
        key: string,
        value: T,
        expiryMs: number,
        storedMs: number,
    ) => void | Promise<void>

  Returns Promise<void>

gc

• gc(): Promise<void>

  Perform garbage-collection if due, else do nothing.

  Returns Promise<void>

gcNow

• gcNow(): Promise<void>

  Perform garbage collection immediately without checking whether we are due for the next GC or not.

  Returns Promise<void>

get

• get<T>(key: string): Promise<T | undefined>

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

  Type Parameters

  • T

  Parameters

  • key: string

  Returns Promise<T | undefined>

getStoredObject

• getStoredObject<T>(key: string): Promise<KvStoredObject<T> | undefined>

  Mainly used to get the expiration timestamp of an object.

  Type Parameters

  • T

  Parameters

  • key: string

  Returns Promise<KvStoredObject<T> | undefined>

set

• set<T>(key: string, value: T, expiryDeltaMs?: number | Duration): Promise<T>

  Set a value in the store.

  Type Parameters

  • T

  Parameters

  • key: string
  • value: T
  • expiryDeltaMs: number | Duration = ...

  Returns Promise<T>

size

• size(): Promise<number>

  Returns the number of items in the store. Note that getting the size requires iterating through the entire store because the items could expire at any time, and hence the size is a dynamic number.

  Returns Promise<number>