Interface AsyncCache<K, T, I>

An async cache is cache which stores collections of items that are built over time. Writers will call the update and commit method to update the cache content & mark items as available.

author: Thomas Minier

Type parameters

K
T
I

Hierarchy

AsyncCache
- BGPCache

Implemented by

Index

Methods

Methods

commit

commit(key: K, writerID: I): void

- Defined in src/engine/cache/cache-interfaces.ts:87
Mark an item as available from the cache

Parameters
- key: K
  
  Item's key
- writerID: I
Returns void

count

count(): number

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

Returns number

The number of items currently in the cache

delete

delete(key: K, writerID: I): void

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

Parameters
- key: K
  
  Item's key
- writerID: I
Returns void

get

get(key: K): Promise<T[]> | null

- Defined in src/engine/cache/cache-interfaces.ts:102
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 Promise<T[]> | null

The values of 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:94
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

update

update(key: K, item: T, writerID: I): void

- Defined in src/engine/cache/cache-interfaces.ts:80
Update an item into the cache

Parameters
- key: K
  
  Item's key
- item: T
  
  Item
- writerID: I
  
  ID of the writer
Returns void

Generated using TypeDoc