Type Alias CacheStore

type CacheStore = {
    close?: () => void;
    del(key: string): number | boolean | void | Promise<void>;
    flushAll(): void | Promise<void>;
    get<T>(key: string): T | Promise<T> | undefined;
    set<T>(key: string, value: T): number | boolean | void | Promise<void>;
}

Index

Properties

Methods

del flushAll get set

Properties

`Optional`close

close?: () => void

Methods

del

del(key: string): number | boolean | void | Promise<void>
delete a key from the cache
Parameters
- key: string
Returns number | boolean | void | Promise<void>
- Defined in lib/Types/Socket.d.ts:17

flushAll

flushAll(): void | Promise<void>
flush all data

Returns void | Promise<void>
- Defined in lib/Types/Socket.d.ts:19

get

get<T>(key: string): T | Promise<T> | undefined
get a cached key and change the stats
Type Parameters
- T
Parameters
- key: string
Returns T | Promise<T> | undefined
- Defined in lib/Types/Socket.d.ts:13

set

set<T>(key: string, value: T): number | boolean | void | Promise<void>
set a key in the cache
Type Parameters
- T
Parameters
- key: string
- value: T
Returns number | boolean | void | Promise<void>
- Defined in lib/Types/Socket.d.ts:15