Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Properties

Properties

delete

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

Deletes the value stored for the given key.

param

Key to delete.

returns

If there was a value to delete.

Type declaration

    • (key: TKey): Promise<boolean>

    • Parameters

      • key: TKey

      Returns Promise<boolean>

entries

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

An iterable of entries in the storage.

Type declaration

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

    • Returns AsyncIterableIterator<[TKey, TValue]>

get

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

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

param

Identifier to get the value for.

Type declaration

    • (key: TKey): Promise<undefined | TValue>

    • Parameters

      • key: TKey

      Returns Promise<undefined | TValue>

has

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

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

param

Identifier to check.

Type declaration

    • (key: TKey): Promise<boolean>

    • Parameters

      • key: TKey

      Returns Promise<boolean>

set

set: (key: TKey, value: TValue, expires?: Date) => Promise<ExpiringStorage<TKey, TValue>>

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

param

Key to set/update.

param

Value to store.

param

When this value expires. Never if undefined.

returns

The storage.

Type declaration

    • (key: TKey, value: TValue, expires?: Date): Promise<ExpiringStorage<TKey, TValue>>

    • Parameters

      • key: TKey
      • value: TValue
      • Optional expires: Date

      Returns Promise<ExpiringStorage<TKey, TValue>>