Interface GetOptions<K, V, FC>

Options that may be passed to the LRUCache#get method.

Type Parameters

  • K

  • V

  • FC

Hierarchy

  • Pick<OptionsBase<K, V, FC>, "allowStale" | "updateAgeOnGet" | "noDeleteOnStaleGet">
    • GetOptions

Properties

allowStale? noDeleteOnStaleGet? status? updateAgeOnGet?

Properties

Optional allowStale

allowStale?: boolean

Allow LRUCache#get and LRUCache#fetch calls to return stale data, if available.

Optional noDeleteOnStaleGet

noDeleteOnStaleGet?: boolean

Do not delete stale items when they are retrieved with LRUCache#get.

Note that the get return value will still be undefined unless OptionsBase.allowStale is true.

Optional status

status?: Status<V>

Optional updateAgeOnGet

updateAgeOnGet?: boolean

Update the age of items on LRUCache#get, renewing their TTL

Has no effect if OptionsBase.ttl is not set.

Default

false

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc