Preview environment

interface LifetimeFilterOptions

export interface LifetimeFilterOptions<Key, Value>

Options for generating a filter function based on lifetime

Type Parameters

Key

Value

optional
excludeFromSweep? : (value: Value, key: Key, collection: LimitedCollection<Key, Value>) => boolean

A function that takes an entry, key, and the collection and returns a boolean, true when the entry should not be checked for sweepability. (default: () = false)

optional
getComparisonTimestamp? : (value: Value, key: Key, collection: LimitedCollection<Key, Value>) => number

A function that takes an entry, key, and the collection and returns a timestamp to compare against in order to determine the lifetime of the entry. (default: e = e?.createdTimestamp)

optional
lifetime? : number

How long, in seconds, an entry should stay in the collection before it is considered sweepable. (default: 14400)