Interface CacheService

interface CacheService {
    connect(): Promise<void>;
    delete(key: string): Promise<void>;
    deleteMultiple(keys: string[]): Promise<void>;
    disconnect(): Promise<void>;
    flushAll(): Promise<void>;
    get<T = unknown>(key: string): Promise<null | T>;
    getMultiple<T = unknown>(keys: string[]): Promise<CacheItem<null | T>[]>;
    has(key: string): Promise<boolean>;
    listKeys(): Promise<null | string[]>;
    set(key: string, value: unknown, ttl?: number): Promise<void>;
    setMultiple(items: CacheItem[], ttl?: number): Promise<void>;
}

Index

Methods

connect delete deleteMultiple disconnect flushAll get getMultiple has listKeys set setMultiple

Methods

connect

connect(): Promise<void>
Connect to the cache

Returns Promise<void>
- Defined in packages/services/src/services/Cache/CacheService.ts:7

delete

delete(key: string): Promise<void>
Delete a value from the cache
Parameters
- key: string
  The key to delete the value for
Returns Promise<void>
- Defined in packages/services/src/services/Cache/CacheService.ts:56

deleteMultiple

deleteMultiple(keys: string[]): Promise<void>
Delete multiple values from the cache
Parameters
- keys: string[]
  The keys to delete the values for
Returns Promise<void>
- Defined in packages/services/src/services/Cache/CacheService.ts:62

disconnect

disconnect(): Promise<void>
Disconnect from the cache

Returns Promise<void>
- Defined in packages/services/src/services/Cache/CacheService.ts:12

flushAll

flushAll(): Promise<void>
Flush the cache

Returns Promise<void>
- Defined in packages/services/src/services/Cache/CacheService.ts:67

get

get<T = unknown>(key: string): Promise<null | T>
Get a value from the cache
Type Parameters
- T = unknown
Parameters
- key: string
  The key to get the value for
Returns Promise<null | T>
- Defined in packages/services/src/services/Cache/CacheService.ts:33

getMultiple

getMultiple<T = unknown>(keys: string[]): Promise<CacheItem<null | T>[]>
Get multiple values from the cache
Type Parameters
- T = unknown
Parameters
- keys: string[]
  The keys to get the values for
Returns Promise<CacheItem<null | T>[]>
- Defined in packages/services/src/services/Cache/CacheService.ts:39

has

has(key: string): Promise<boolean>
Check if a key exists in the cache
Parameters
- key: string
  The key to check for
Returns Promise<boolean>
- Defined in packages/services/src/services/Cache/CacheService.ts:45

listKeys

listKeys(): Promise<null | string[]>
Get all keys in the cache

Returns Promise<null | string[]>
- Defined in packages/services/src/services/Cache/CacheService.ts:50

set

set(key: string, value: unknown, ttl?: number): Promise<void>
Set a value in the cache
Parameters
- key: string
  The key to store the value under
- value: unknown
  The value to store
- Optionalttl: number
  The time to live for the value
Returns Promise<void>
- Defined in packages/services/src/services/Cache/CacheService.ts:20

setMultiple

setMultiple(items: CacheItem[], ttl?: number): Promise<void>
Set multiple values in the cache
Parameters
- items: CacheItem[]
  The items to store
- Optionalttl: number
  The time to live for the values
Returns Promise<void>
- Defined in packages/services/src/services/Cache/CacheService.ts:27

Interface CacheService

Index

Methods

Methods

connect

Returns Promise<void>

delete

Parameters

Returns Promise<void>

deleteMultiple

Parameters

Returns Promise<void>

disconnect

Returns Promise<void>

flushAll

Returns Promise<void>

get

Type Parameters

Parameters

Returns Promise<null | T>

getMultiple

Type Parameters

Parameters

Returns Promise<CacheItem<null | T>[]>

has

Parameters

Returns Promise<boolean>

listKeys

Returns Promise<null | string[]>

set

Parameters

Returns Promise<void>

setMultiple

Parameters

Returns Promise<void>

Settings

On This Page