Interface GenericCachingStrategy<T>

Type Parameters

T

Hierarchy

GenericCachingStrategy
- CachingStrategy

Index

Methods

clean delete expires get set with

Methods

clean

clean(): void
Cleans up any expired cache values

Returns void
- Defined in src/lib/CachingStrategies/index.ts:30

delete

delete(key: string): void
Deletes the key from the cache
Parameters
- key: string
Returns void
- Defined in src/lib/CachingStrategies/index.ts:21

expires

expires(key: string): undefined | number
Returns the expiration time, or undefined if it doesn't exist
Parameters
- key: string
Returns undefined | number
- Defined in src/lib/CachingStrategies/index.ts:17

get

get(key: string): undefined | T
Returns the cached value, or undefined if it doesn't exist
Parameters
- key: string
Returns undefined | T
- Defined in src/lib/CachingStrategies/index.ts:9

set

set(key: string, value: T, expiration?: number): void
Sets the value in the cache, with an optional expiration (as a future Game.time)
Parameters
- key: string
- value: T
- Optional expiration: number
Returns void
- Defined in src/lib/CachingStrategies/index.ts:13

with

with<T>(serializer: Serializer<T>): GenericCachingStrategy<T>
Wraps the cache in a serializer to store objects more compactly. HeapCache notably needs no serializers and simply ignores this.
Type Parameters
- T
Parameters
- serializer: Serializer<T>
Returns GenericCachingStrategy<T>
- Defined in src/lib/CachingStrategies/index.ts:26

Generated using TypeDoc