@bemoje/max-age-cache 1.0.0

@bemoje/max-age-cache

1.0.0

MaxAgeCache ▸
- Instance members
- #maxAge
- #set
- #get
- #has
- #del
- #keys
- #values
- #entries
- #toObject
isUndefined
oSetNonEnum
repeatEvery

Need help reading this?

MaxAgeCache

new MaxAgeCache(maxAgeMs: number): MaxAgeCache

Parameters

maxAgeMs (number) The number of milliseconds that is the maximum age of entries.

Returns

MaxAgeCache: A new MaxAgeCache instance.

Instance Members

▸ maxAge(ms)

Sets the maximum age for new entries.

maxAge(ms: number): void

Parameters

ms (number) The number of milliseconds to be the maximum age of entries.

Returns

void: void

▸ set(key, value)

Add a keyval to the cache. Chainable.

set(key: string, value: any): MaxAgeCache

Parameters

key (string) The key

value (any) The value

Returns

MaxAgeCache: this self

▸ get(key, resetAge)

Add a keyval to the cache. Chainable.

get(key: string, resetAge: any): (null | any)

Parameters

key (string) The key

resetAge

(any
            = true)

Returns

(null | any): The retrieved value

▸ has(key)

Check whether a key exists.

has(key: string): boolean

Parameters

key (string) The key

Returns

boolean: boolean

▸ del(key)

Delete a key and its corresponding value.

del(key: string): void

Parameters

key (string) The key

Returns

void: void

▸ keys(key)

Returns all keys as an array.

keys(key: string): Array<string>

Parameters

key (string) The key

Returns

Array<string>: An array of string keys.

▸ values(key)

Returns all values as an array.

values(key: string): Array<any>

Parameters

key (string) The key

Returns

Array<any>: An array of values.

▸ entries(key)

Returns all entries as an array.

entries(key: string): Array<Array<string, any>>

Parameters

key (string) The key

Returns

Array<Array<string, any>>: An array of entries.

▸ toObject(key)

Returns all data as an object of the cache's keys and values.

toObject(key: string): object

Parameters

key (string) The key

Returns

object: object

isUndefined

Returns true if value 'v' is undefined.

isUndefined(value: any): boolean

Parameters

value (any) The value to evaluate

Returns

boolean: boolean

oSetNonEnum

Adds a non-enumerable property on object, 'o'

oSetNonEnum(o: object, key: string, value: string): void

Parameters

o (object) The object on which to set a property value

key (string) The property key name

value (string) The property value

Returns

void:

repeatEvery

Continuously calls the callback function with a millisecond-specified delay, 'ms'

repeatEvery(ms: number, callback: function): function

Parameters

ms (number) The millisecond delay

callback (function) The callback function that will be called every 'ms' milliseconds.

Returns

function: a cancellation function