LimitedCollectionOptions

typedef · Source

Options for defining the behavior of a LimitedCollection Type: Object

Properties

maxSize

nullable · optional

maxSize: number

The maximum size of the Collection

Default: Infinity

keepOverLimit

nullable · optional

keepOverLimit: function

A function, which is passed the value and key of an entry, ran to decide to keep an entry past the maximum size

Default: null

sweepFilter

nullable · optional

sweepFilter: SweepFilter

DEPRECATED: There is no direct alternative to this, however most of its purpose is fulfilled by Client#sweepers A function ran every sweepInterval to determine how to sweep

Default: null

sweepInterval

nullable · optional

sweepInterval: number

DEPRECATED: There is no direct alternative to this, however most of its purpose is fulfilled by Client#sweepers How frequently, in seconds, to sweep the collection.

Default: 0