Interface Cache<K, T>

A cache is a vue that materializes data for latter re-use

author: Thomas Minier

Type parameters

K
T

Hierarchy

Cache

Implemented by

BaseLRUCache

Index

Methods

Methods

count

count(): number

- Defined in src/engine/cache/cache-interfaces.ts:65
Get the number of items currently in the cache

Returns number

The number of items currently in the cache

delete

delete(key: K): void

- Defined in src/engine/cache/cache-interfaces.ts:59
Remove an item from the cache

Parameters
- key: K
  
  Item's key
Returns void

get

get(key: K): T | null

- Defined in src/engine/cache/cache-interfaces.ts:53
Access an item by its key. Each call to get() should be predated by a call to has(), to check if the item is in the cache.

Parameters
- key: K
  
  Item's key
Returns T | null

The item with the given key, or null if it was not found

has

has(key: K): boolean

- Defined in src/engine/cache/cache-interfaces.ts:44
Test if the cache contains an item with a given key

Parameters
- key: K
  
  Item's key
Returns boolean

True if the cache contains the item with the given key, False otherwise

put

put(key: K, item: T): void

- Defined in src/engine/cache/cache-interfaces.ts:37
Put an item into the cache

Parameters
- key: K
  
  Item's key
- item: T
  
  Item
Returns void

Generated using TypeDoc