Class LRUMap<K, V>

LRU (Least Recently Used) Map implementation

Type Parameters

  • K = any

  • V = any

Hierarchy

Constructors - Functional

constructor

Properties

[toStringTag] size [species]

Methods

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

Functional Constructors

constructor

  • LRU (Least Recently Used) Map implementation

    will remove the oldest item when reach the size limit

    Since

    5.15.0

    Example

    const m = new LRUMap(1)
    m.set('a','v') // {'a':'v'}
    m.set('b','c') // {'b':'c'}

    Type Parameters

    • K = any

    • V = any

    Parameters

    • maxSize: number = 1024

      maximum cache item number, default is 1024

    Returns LRUMap<K, V>

Properties

Readonly [toStringTag]

[toStringTag]: string

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

  • Returns void

delete

  • Returns

    true if an element in the Map existed and has been removed, or false if the element does not exist.

    Parameters

    • key: K

    Returns boolean

entries

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

    Returns IterableIterator<[K, V]>

forEach

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

    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

get

  • Parameters

    • key: K

    Returns V

getMaxSize

  • Returns number

has

  • Returns

    boolean indicating whether an element with the specified key exists or not.

    Parameters

    • key: K

    Returns boolean

keys

  • Returns an iterable of keys in the map

    Returns IterableIterator<K>

set

  • Parameters

    • key: K
    • val: V

    Returns LRUMap<K, V>

setMaxSize

  • Parameters

    • maxSize: number

    Returns void

values

  • Returns an iterable of values in the map

    Returns IterableIterator<V>

Settings

Member Visibility

Theme