Class Cache`Abstract`

Abstract interface class for a cached object.

Hierarchy

Cache

Index

Constructors

Methods

arrayPop arrayPush decrement drop fetch has increment pop put safe

Constructors

constructor

new Cache(): Cache
Returns Cache

Methods

`Abstract` arrayPop

arrayPop(key: string): Awaitable<undefined | string>
Remove and return an item from the beginning of an array-like key.
Parameters
- key: string
Returns Awaitable<undefined | string>
- Defined in src/util/cache/Cache.ts:76

`Abstract` arrayPush

arrayPush(key: string, value: string): Awaitable<void>
Push an item onto the end an array-like key.
Parameters
- key: string
- value: string
Returns Awaitable<void>
- Defined in src/util/cache/Cache.ts:69

`Abstract` decrement

decrement(key: string, amount?: number): Awaitable<undefined | number>
Decrement a key in the cache by a given amount.
Parameters
- key: string
- Optional amount: number
Returns Awaitable<undefined | number>
- Defined in src/util/cache/Cache.ts:62

`Abstract` drop

drop(key: string): Awaitable<void>
Drop the given key from the cache.
Parameters
- key: string
Returns Awaitable<void>
- Defined in src/util/cache/Cache.ts:42

`Abstract` fetch

fetch(key: string): Awaitable<undefined | string>
Fetch a value from the cache by its key.

Returns
Promise<any|undefined>
Parameters
- key: string
Returns Awaitable<undefined | string>
- Defined in src/util/cache/Cache.ts:13

`Abstract` has

has(key: string): Awaitable<boolean>
Check if the cache has the given key.

Returns
Promise
Parameters
- key: string
Returns Awaitable<boolean>
- Defined in src/util/cache/Cache.ts:36

`Abstract` increment

increment(key: string, amount?: number): Awaitable<undefined | number>
Increment a key in the cache by a given amount.
Parameters
- key: string
- Optional amount: number
Returns Awaitable<undefined | number>
- Defined in src/util/cache/Cache.ts:55

`Abstract` pop

pop(key: string): Awaitable<undefined | string>
Fetch an item from the cache by key, and then remove it.
Parameters
- key: string
Returns Awaitable<undefined | string>
- Defined in src/util/cache/Cache.ts:48

`Abstract` put

put(key: string, value: string, expires?: Date): Awaitable<void>
Store the given value in the cache by key.
Parameters
- key: string
- value: string
- Optional expires: Date
Returns Awaitable<void>
- Defined in src/util/cache/Cache.ts:29

safe

safe(key: string): Promise<Safe>
Fetch a value from the cache by its key as a Safe value.
Parameters
- key: string
Returns Promise<Safe>
- Defined in src/util/cache/Cache.ts:19