Class LruTtlMap<K, V>

An LruMap where each entry additionally carries an absolute expiry deadline, in the same units as the now timestamps supplied to reads (milliseconds since the Unix epoch, by default).

Type Parameters

  • K
  • V

Hierarchy (view full)

Constructors

constructor

Properties

[toStringTag] expiry limit size [species]

Methods

[iterator] clear delete entries forEach get has keys set values groupBy

Constructors

constructor

Properties

Readonly [toStringTag]

[toStringTag]: string

Private Readonly expiry

expiry: Map<K, number> = ...

Readonly limit

limit: number = 1073741823

Readonly size

size: number

Returns

the number of elements in the Map.

Static Readonly [species]

[species]: MapConstructor

Methods

[iterator]

  • [iterator](): IterableIterator<[K, V]>

  • Returns an iterable of entries in the map.

    Returns IterableIterator<[K, V]>

clear

delete

entries

  • entries(): IterableIterator<[K, V]>

  • Returns an iterable of key, value pairs for every entry in the map.

    Returns IterableIterator<[K, V]>

forEach

  • forEach(callbackfn, thisArg?): void

  • Executes a provided function once per each key/value pair in the Map, in insertion order.

    Parameters

    • callbackfn: ((value, key, map) => void)
        • (value, key, map): void

        • Parameters

          • value: V
          • key: K
          • map: Map<K, V>

          Returns void

    • Optional thisArg: any

    Returns void

get

  • get(key, now?): undefined | V

  • Parameters

    • key: K
    • Optional now: number

      Current time, defaults to Date.now(). Entries with a deadline strictly below it are treated as missing and are removed.

    Returns undefined | V

has

  • has(key, now?): boolean

  • Parameters

    • key: K
    • now: number = ...

      Current time, defaults to Date.now(). Entries with a deadline strictly below it are treated as missing and are removed.

    Returns boolean

keys

  • keys(): IterableIterator<K>

  • Returns an iterable of keys in the map

    Returns IterableIterator<K>

set

  • set(key, value, expiry?): this

  • Parameters

    • key: K
    • value: V
    • expiry: number = Infinity

      Absolute deadline after which the entry expires, defaults to Infinity (never expires). For a relative TTL use Date.now() + ttl.

    Returns this

values

  • values(): IterableIterator<V>

  • Returns an iterable of values in the map

    Returns IterableIterator<V>

Static groupBy

  • groupBy<K, T>(items, keySelector): Map<K, T[]>

  • Groups members of an iterable according to the return value of the passed callback.

    Type Parameters

    • K
    • T

    Parameters

    • items: Iterable<T>

      An iterable.

    • keySelector: ((item, index) => K)

      A callback which will be invoked for each item in items.

        • (item, index): K

        • Parameters

          • item: T
          • index: number

          Returns K

    Returns Map<K, T[]>

Settings

Member Visibility

Theme

On This Page

constructor[toStringTag]expirylimitsize[species][iterator]cleardeleteentriesforEachgethaskeyssetvaluesgroupBy