Interface ExpiringStorage<TKey, TValue>

A KeyValueStorage in which the values can expire. Entries with no expiration date never expire.

Type Parameters

  • TKey

  • TValue

Hierarchy

Implemented by

Properties

delete entries get has

Methods

set

Properties

delete

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

Type declaration

    • (key): Promise<boolean>

    • Deletes the value stored for the given key.

      Parameters

      • key: TKey

        Key to delete.

      Returns Promise<boolean>

      If there was a value to delete.

entries

entries: (() => AsyncIterableIterator<[TKey, TValue]>)

Type declaration

    • (): AsyncIterableIterator<[TKey, TValue]>

    • An iterable of entries in the storage.

      Returns AsyncIterableIterator<[TKey, TValue]>

get

get: ((key) => Promise<undefined | TValue>)

Type declaration

    • (key): Promise<undefined | TValue>

    • Returns the value stored for the given identifier. undefined if no value is stored.

      Parameters

      • key: TKey

      Returns Promise<undefined | TValue>

has

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

Type declaration

    • (key): Promise<boolean>

    • Checks if there is a value stored for the given key.

      Parameters

      • key: TKey

      Returns Promise<boolean>

Methods

set

  • Sets the value for the given key. Should error if the data is already expired.

    Parameters

    • key: TKey

      Key to set/update.

    • value: TValue

      Value to store.

    • Optional expiration: number

      How long this data should stay valid in milliseconds.

    Returns Promise<ExpiringStorage<TKey, TValue>>

    The storage.

  • Sets the value for the given key. Should error if the data is already expired.

    Parameters

    • key: TKey

      Key to set/update.

    • value: TValue

      Value to store.

    • Optional expires: Date

      When this value expires. Never if undefined.

    Returns Promise<ExpiringStorage<TKey, TValue>>

    The storage.

Settings

Member Visibility

Theme

On This Page