Class TTLCacheManager<T>

Type Parameters

Hierarchy (view full)

Map<string, T>
- TTLCacheManager
  - AsyncTTLCacheManager

Implements

TTLCacheManagerOptions

Constructors

constructor

new TTLCacheManager<T>(options): TTLCacheManager<T>
Type Parameters
- T
Parameters
- options: TTLCacheManagerOptions
Returns TTLCacheManager<T>
Overrides Map<string, T>.constructor
- Defined in src/data-structures/Cache/TTLCacheManager.ts:55

Properties

`Readonly` [toStringTag]

[toStringTag]: string

cacheAdds

cacheAdds: number = 0

cacheCapacityExceeded

cacheCapacityExceeded: number = 0

cacheClears

cacheClears: number = 0

cacheDeletes

cacheDeletes: number = 0

cacheExpirations

cacheExpirations: number = 0

cacheHits

cacheHits: number = 0

cacheMisses

cacheMisses: number = 0

cacheUpdates

cacheUpdates: number = 0

capacity

capacity: null | number

Maximum number of items to store in this cache

`Private` expireIds

expireIds: Map<string, Timeout> = ...

Map of TimeoutIds for each key - used to track TTL

`Optional` onCapacityExceeded

onCapacityExceeded?: ((key) => void | Promise<void>)

Callback to run when cache capacity is exceeded

Type declaration

- (key): void | Promise<void>
- Parameters
  - key: string
  Returns void | Promise<void>

`Optional` onClear

onClear?: ((itemCount) => void | Promise<void>)

Callback to run when cache is cleared

Type declaration

- (itemCount): void | Promise<void>
- Parameters
  - itemCount: number
  Returns void | Promise<void>

`Optional` onKeyAdd

onKeyAdd?: ((key) => void | Promise<void>)

Callback to run when a key is added

Type declaration

- (key): void | Promise<void>
- Parameters
  - key: string
  Returns void | Promise<void>

`Optional` onKeyDelete

onKeyDelete?: ((key, reason?) => void | Promise<void>)

Callback to run when a key is deleted

Type declaration

- (key, reason?): void | Promise<void>
- Parameters
  - key: string
  - Optional reason: string
  Returns void | Promise<void>

`Optional` onKeyExpire

onKeyExpire?: ((key) => void | Promise<void>)

Callback to run when a key expires

Type declaration

- (key): void | Promise<void>
- Parameters
  - key: string
  Returns void | Promise<void>

`Optional` onKeyUpdate

onKeyUpdate?: ((key) => void | Promise<void>)

Callback to run when a key is updated

Type declaration

- (key): void | Promise<void>
- Parameters
  - key: string
  Returns void | Promise<void>

`Readonly` size

size: number

Returns

the number of elements in the Map.

ttl

ttl: number

Time to live for data added to this cache

`Static` `Readonly` [species]

[species]: MapConstructor

Methods

[iterator]

[iterator](): IterableIterator<[string, T]>
Returns an iterable of entries in the map.

Returns IterableIterator<[string, T]>
Inherited from Map.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:119

clear

clear(): void
Returns void
Overrides Map.clear
- Defined in src/data-structures/Cache/TTLCacheManager.ts:78

clearAllTtl

clearAllTtl(): void
Returns void
- Defined in src/data-structures/Cache/TTLCacheManager.ts:156

clearKeyTtl

clearKeyTtl(key): boolean
Parameters
- key: string
Returns boolean
- Defined in src/data-structures/Cache/TTLCacheManager.ts:148

clearManyKeyTtl

clearManyKeyTtl(keys): boolean[]
Parameters
- keys: string[]
Returns boolean[]
- Defined in src/data-structures/Cache/TTLCacheManager.ts:178

delete

delete(key, reason?): boolean
Parameters
- key: string
- reason: RemoveReason = RemoveReason.REQUESTED
Returns boolean
Overrides Map.delete
- Defined in src/data-structures/Cache/TTLCacheManager.ts:88

deleteMany

deleteMany(keys, reason?): boolean[]
Parameters
- keys: string[]
- reason: RemoveReason = RemoveReason.REQUESTED
Returns boolean[]
- Defined in src/data-structures/Cache/TTLCacheManager.ts:165

entries

entries(): IterableIterator<[string, T]>
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[string, T]>
Inherited from Map.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:124

expireKey

expireKey(key): boolean
Parameters
- key: string
Returns boolean
- Defined in src/data-structures/Cache/TTLCacheManager.ts:124

forEach

forEach(callbackfn, thisArg?): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: ((value, key, map) => void)
  - - (value, key, map): void
    - Parameters
      value: T
      key: string
      map: Map<string, T>
      Returns void
- Optional thisArg: any
Returns void
Inherited from Map.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:28

get

get(key): undefined | T
Parameters
- key: string
Returns undefined | T
Overrides Map.get
- Defined in src/data-structures/Cache/TTLCacheManager.ts:68

getMany

getMany(keys): (undefined | T)[]
Parameters
- keys: string[]
Returns (undefined | T)[]
- Defined in src/data-structures/Cache/TTLCacheManager.ts:161

handleMaxCapacity

handleMaxCapacity(): void
Returns void
- Defined in src/data-structures/Cache/TTLCacheManager.ts:114

has

has(key): boolean
Parameters
- key: string
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Inherited from Map.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:37

keys

keys(): IterableIterator<string>
Returns an iterable of keys in the map

Returns IterableIterator<string>
Inherited from Map.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:129

set

set(key, value, ttl?): this
Parameters
- key: string
- value: T
- ttl: number = ...
Returns this
Overrides Map.set
- Defined in src/data-structures/Cache/TTLCacheManager.ts:98

setKeyTtl

setKeyTtl(key, ttl): boolean
Parameters
- key: string
- ttl: number
Returns boolean
- Defined in src/data-structures/Cache/TTLCacheManager.ts:134

setMany

setMany(keyValuePairs, ttl?): this
Parameters
- keyValuePairs: [string, T][]
- ttl: number = ...
Returns this
- Defined in src/data-structures/Cache/TTLCacheManager.ts:169

setManyKeyTtl

setManyKeyTtl(keys, ttl): boolean[]
Parameters
- keys: string[]
- ttl: number
Returns boolean[]
- Defined in src/data-structures/Cache/TTLCacheManager.ts:174

values

values(): IterableIterator<T>
Returns an iterable of values in the map

Returns IterableIterator<T>
Inherited from Map.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:134

Class TTLCacheManager<T>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TTLCacheManager<T>

Properties

Readonly [toStringTag]

cacheAdds

cacheCapacityExceeded

cacheClears

cacheDeletes

cacheExpirations

cacheHits

cacheMisses

cacheUpdates

capacity

Private expireIds

Optional onCapacityExceeded

Type declaration

Parameters

Returns void | Promise<void>

Optional onClear

Type declaration

Parameters

Returns void | Promise<void>

Optional onKeyAdd

Type declaration

Parameters

Returns void | Promise<void>

Optional onKeyDelete

Type declaration

Parameters

Returns void | Promise<void>

Optional onKeyExpire

Type declaration

Parameters

Returns void | Promise<void>

Optional onKeyUpdate

Type declaration

Parameters

Returns void | Promise<void>

Readonly size

Returns

ttl

Static Readonly [species]

Methods

[iterator]

Returns IterableIterator<[string, T]>

clear

Returns void

clearAllTtl

Returns void

clearKeyTtl

Parameters

Returns boolean

clearManyKeyTtl

Parameters

Returns boolean[]

delete

Parameters

Returns boolean

deleteMany

Parameters

Returns boolean[]

entries

Returns IterableIterator<[string, T]>

expireKey

Parameters

Returns boolean

forEach

Parameters

Parameters

`Readonly` [toStringTag]

`Private` expireIds

`Optional` onCapacityExceeded

`Optional` onClear

`Optional` onKeyAdd

`Optional` onKeyDelete

`Optional` onKeyExpire

`Optional` onKeyUpdate

`Readonly` size

`Static` `Readonly` [species]