Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LRUMap<K, V>

LRU (Least Recently Used) Map implementation

Type parameters

  • K = any

  • V = any

Hierarchy

Index

Constructors Functional

Properties

Methods

Functional Constructors

constructor

  • new LRUMap<K, V>(maxSize?: number): LRUMap<K, V>

  • LRU (Least Recently Used) Map implementation

    will remove the oldest item when reach the size limit

    category

    Functional

    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

Static Readonly [species]

[species]: MapConstructor

Methods

[iterator]

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

  • Returns an iterable of entries in the map.

    Returns IterableIterator<[K, V]>

clear

  • clear(): void

  • Returns void

delete

  • delete(key: K): boolean

  • Parameters

    • key: K

    Returns boolean

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: (value: V, key: K, map: Map<K, V>) => void, thisArg?: any): void

  • 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

  • get(key: K): V

  • Parameters

    • key: K

    Returns V

getMaxSize

  • getMaxSize(): number

  • Returns number

has

  • has(key: K): boolean

  • Parameters

    • key: K

    Returns boolean

keys

  • keys(): IterableIterator<K>

  • Returns an iterable of keys in the map

    Returns IterableIterator<K>

set

  • set(key: K, val: V): LRUMap<K, V>

  • Parameters

    • key: K
    • val: V

    Returns LRUMap<K, V>

setMaxSize

  • setMaxSize(maxSize: number): void

  • Parameters

    • maxSize: number

    Returns void

values

  • values(): IterableIterator<V>

  • Returns an iterable of values in the map

    Returns IterableIterator<V>