Class TTLMap<K, V>

TTL (Time to Life) Map

it will lazy remove values when perform operations

Since

5.18.0

Type Parameters

  • K = any

  • V = any

Hierarchy

Constructors

  • TTLMap (Time to Life) Map

    it will lazy remove values when perform operations

    Type Parameters

    • K = any

    • V = any

    Parameters

    • defaultTTL: number = ...

      time to live, in milliseconds, default value is 60 seconds

    • cleanAfterOperation: number = 100

      execute full clean after operations. default value is 100, it means, at least 100 operations performed, the TTL evict logic will be executed

    Returns TTLMap<K, V>

Properties

[toStringTag]: string
[species]: MapConstructor

Accessors

  • get size(): number
  • Returns number

Methods

  • Returns an iterable of entries in the map.

    Returns IterableIterator<[K, V]>

  • manually directly clean all timeout items

    Returns void

  • Returns void

  • Parameters

    • k: K

    Returns boolean

  • Returns IterableIterator<[K, V]>

  • Parameters

    • callbackfn: ((value: V, key: K, map: Map<K, V>) => void)
        • (value: V, key: K, map: Map<K, V>): void
        • Parameters

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

          Returns void

    • Optional thisArg: any

    Returns void

  • Parameters

    • k: K

    Returns V

  • Parameters

    • k: K

    Returns boolean

  • Returns IterableIterator<K>

  • set value

    Returns

    Parameters

    • k: K

      key

    • v: V

      value

    • ttl: number = ...

      time to live, in milliseconds, if undefined, will use instance level defaultTTL

    Returns TTLMap<K, V>

  • Returns IterableIterator<V>