Type Alias Options<KeyType, ValueType>

type Options<KeyType, ValueType> = {
    maxAge?: number;
    maxSize: number;
    onEviction?: (key: KeyType, value: ValueType) => void;
}

Properties

maxAge?: number

The maximum number of milliseconds an item should remain in the cache.

Infinity

By default, maxAge will be Infinity, which means that items will never expire. Lazy expiration occurs upon the next write or read call.

Individual expiration of an item can be specified with the set(key, value, {maxAge}) method.

maxSize: number

The maximum number of items before evicting the least recently used items.

onEviction?: (key: KeyType, value: ValueType) => void

Called right before an item is evicted from the cache.

Useful for side effects or for items like object URLs that need explicit cleanup (revokeObjectURL).