Faremeter API

---

Faremeter API / middleware/src / cache

​

cache

​

Classes

​

AgedLRUCache

Defined in: packages/middleware/src/cache.ts:19 An LRU cache with time-based expiration. Entries are evicted when they exceed maxAge or when the cache reaches capacity (least recently used entries are removed first).

​

Type Parameters

K

K

V

V

​

Constructors

Constructor

new AgedLRUCache<K, V>(opts): AgedLRUCache<K, V>

Defined in: packages/middleware/src/cache.ts:25

Parameters

opts

AgedLRUCacheOpts = {}

Returns

AgedLRUCache<K, V>

​

Accessors

size

Get Signature

get size(): number

Defined in: packages/middleware/src/cache.ts:61

Returns

number

​

Methods

get()

get(key): undefined | V

Defined in: packages/middleware/src/cache.ts:32

Parameters

key

K

Returns

undefined | V

put()

put(key, value): void

Defined in: packages/middleware/src/cache.ts:49

Parameters

key

K

value

V

Returns

void

​

Type Aliases

​

AgedLRUCacheOpts

AgedLRUCacheOpts = object

Defined in: packages/middleware/src/cache.ts:4 Configuration options for the AgedLRUCache.

​

Properties

capacity?

optional capacity: number

Defined in: packages/middleware/src/cache.ts:6 Maximum number of entries. Defaults to 256.

maxAge?

optional maxAge: number

Defined in: packages/middleware/src/cache.ts:8 Maximum age in milliseconds before entries expire. Defaults to 30000.

now()?

optional now: () => number

Defined in: packages/middleware/src/cache.ts:10 Custom time function for testing. Defaults to Date.now.

Returns

number