Class export=<K, V>

A bounded cache in least-recently-used order, with pinning and an optional description on /admin/caches (#349).

A read (get) moves a key to the young end; an insert past the bound drops unpinned keys from the old end.

Type Parameters

K
V

Index

Constructors

Accessors

Methods

clear delete get has isPinned keys limit peek pin set stats unpin

Constructors

constructor

new "export="<K, V>(options: BoundedLruOptions<K>): export=<K, V>
Builds the cache and, when a registry is given, describes it there.
Type Parameters
- K
- V
Parameters
- options: BoundedLruOptions<K>
  the name, the bound, and the registry's description
Returns export=<K, V>

Throws
an Error when the name or the bound is missing
- Defined in common/bounded_lru.ts:139

Accessors

size

get size(): number
How many keys are held.

Returns number
the count
- Defined in common/bounded_lru.ts:183

Methods

clear

clear(): void
Drops every key and every pin. The counters are kept: they are about the life of the process, as every registered cache's are.

Returns void
- Defined in common/bounded_lru.ts:278

delete

delete(key: K): boolean
Drops a key, and any pins on it.
Parameters
- key: K
  the key
Returns boolean
true when it was held
- Defined in common/bounded_lru.ts:266

get

get(key: K): V
Reads a key, counting a hit or a miss and making it the most recently used.
Parameters
- key: K
  the key
Returns V
the value, or undefined when it is not held
- Defined in common/bounded_lru.ts:199

has

has(key: K): boolean
Whether a key is held. Neither counted nor a use.
Parameters
- key: K
  the key
Returns boolean
true when held
- Defined in common/bounded_lru.ts:238

isPinned

isPinned(key: K): boolean
Whether a key is pinned.
Parameters
- key: K
  the key
Returns boolean
true when at least one pin is held on it
- Defined in common/bounded_lru.ts:338

keys

keys(): K[]
The keys held, from the least to the most recently used.

Returns K[]
the keys
- Defined in common/bounded_lru.ts:290

limit

limit(): number
Answers the bound now, as a whole number of at least one.

Returns number
the bound
- Defined in common/bounded_lru.ts:164

peek

peek(key: K): V
Reads a key without counting it or changing its recency.
Parameters
- key: K
  the key
Returns V
the value, or undefined when it is not held
- Defined in common/bounded_lru.ts:227

pin

pin(key: K): void
Keeps a key from being evicted until it is unpinned as many times.
Parameters
- key: K
  the key
Returns void
- Defined in common/bounded_lru.ts:304

set

set(key: K, value: V): this
Puts a value under a key as the most recently used, then evicts unpinned keys from the old end until the cache is within its bound.
Parameters
- key: K
  the key
- value: V
  the value
Returns this
this cache
- Defined in common/bounded_lru.ts:251

stats

stats(): BoundedLruStats
The cache's figures, for a status page and for tests.

Returns BoundedLruStats
size, bound, pins, overrun and the counters
- Defined in common/bounded_lru.ts:393

unpin

unpin(key: K): void
Releases one pin on a key, and evicts if the cache is over its bound.
Parameters
- key: K
  the key
Returns void
- Defined in common/bounded_lru.ts:318