Class Cache

Abstract interface class for a cached object.

Hierarchy

Cache

Index

Constructors

constructor

Methods

Constructors

constructor

new Cache(): Cache

Returns Cache

Methods

Abstract arrayPop

arrayPop(key: string): Awaitable<undefined | string>

- Defined in src/util/cache/Cache.ts:67
Remove and return an item from the beginning of an array-like key.

Parameters
- key: string
Returns Awaitable<undefined | string>

Abstract arrayPush

arrayPush(key: string, value: string): Awaitable<void>

- Defined in src/util/cache/Cache.ts:60
Push an item onto the end an array-like key.

Parameters
- key: string
- value: string
Returns Awaitable<void>

Abstract decrement

decrement(key: string, amount?: number): Awaitable<undefined | number>

- Defined in src/util/cache/Cache.ts:53
Decrement a key in the cache by a given amount.

Parameters
- key: string
- Optional amount: number
Returns Awaitable<undefined | number>

Abstract drop

drop(key: string): Awaitable<void>

- Defined in src/util/cache/Cache.ts:33
Drop the given key from the cache.

Parameters
- key: string
Returns Awaitable<void>

Abstract fetch

fetch(key: string): Awaitable<undefined | string>

- Defined in src/util/cache/Cache.ts:12
Fetch a value from the cache by its key.

Parameters
- key: string
Returns Awaitable<undefined | string>

Promise<any|undefined>

Abstract has

has(key: string): Awaitable<boolean>

- Defined in src/util/cache/Cache.ts:27
Check if the cache has the given key.

Parameters
- key: string
Returns Awaitable<boolean>

Promise

Abstract increment

increment(key: string, amount?: number): Awaitable<undefined | number>

- Defined in src/util/cache/Cache.ts:46
Increment a key in the cache by a given amount.

Parameters
- key: string
- Optional amount: number
Returns Awaitable<undefined | number>

Abstract pop

pop(key: string): Awaitable<undefined | string>

- Defined in src/util/cache/Cache.ts:39
Fetch an item from the cache by key, and then remove it.

Parameters
- key: string
Returns Awaitable<undefined | string>

Abstract put

put(key: string, value: string, expires?: Date): Awaitable<void>

- Defined in src/util/cache/Cache.ts:20
Store the given value in the cache by key.

Parameters
- key: string
- value: string
- Optional expires: Date
Returns Awaitable<void>

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.