Class LRUCache<K, V>

Type Parameters

  • K = string
  • V = unknown

Constructors

constructor

Properties

cache options

Methods

clear delete dump get info keys load purgeStale set values

Constructors

constructor

Properties

Protectedcache

cache: Map<K, LRUCacheItem<V>> = ...

Protectedoptions

options: Required<LRUCacheOptions<K, V>>

Methods

clear

delete

  • delete(key: K, reason?: DisposeReason): boolean

  • Deletes a key out of the cache

    Parameters

    • key: K
    • reason: DisposeReason = 'delete'

    Returns boolean

dump

get

  • get<T = V>(key: K, options?: { updateAgeOnGet?: boolean }): undefined | T

  • Return a value from the cache

    Type Parameters

    • T = V

    Parameters

    • key: K
    • options: { updateAgeOnGet?: boolean } = {}

    Returns undefined | T

info

  • info(): { capacity: number; size: number }

  • Returns { capacity: number; size: number }

    • capacity: number
    • size: number

      The total number of items held in the cache at the current moment

keys

load

purgeStale

set

  • set<T = V>(key: K, value: T, opts?: { ttl?: number }): void

  • Add a value to the cache

    Type Parameters

    • T = V

    Parameters

    • key: K
    • value: T
    • Optionalopts: { ttl?: number }

    Returns void

values

Settings

Member Visibility

On This Page

Constructors
Properties
Methods