@k-platform/core documentation
  1. Classes
  2. CacheService

File

lib/shared/modules/cache/cache.types.ts

Description

An abstract class defining methods for cache operations.

Index

Methods

Methods

Abstract del
del(...keys: string[])
Defined in lib/shared/modules/cache/cache.types.ts:33
Parameters :
Name Type Optional
keys string[] No
Returns : Promise<boolean>
Abstract expire
expire(key: string, expiresIn: number)
Defined in lib/shared/modules/cache/cache.types.ts:37
Parameters :
Name Type Optional
key string No
expiresIn number No
Returns : Promise<boolean>
Abstract get
get(key: string)
Defined in lib/shared/modules/cache/cache.types.ts:21
Parameters :
Name Type Optional
key string No
Returns : Promise<string>
Abstract getBoolean
getBoolean(key: string)
Defined in lib/shared/modules/cache/cache.types.ts:25
Parameters :
Name Type Optional
key string No
Returns : Promise<boolean>
Abstract getFromPattern
getFromPattern(pattern: string)
Defined in lib/shared/modules/cache/cache.types.ts:39
Parameters :
Name Type Optional
pattern string No
Returns : Promise<string[]>
Abstract getNumber
getNumber(key: string)
Defined in lib/shared/modules/cache/cache.types.ts:23
Parameters :
Name Type Optional
key string No
Returns : Promise<number>
Abstract incr
incr(key: string)
Defined in lib/shared/modules/cache/cache.types.ts:35
Parameters :
Name Type Optional
key string No
Returns : Promise<number>
Abstract set
set(key: string, value: string | number, expiration?: number)
Defined in lib/shared/modules/cache/cache.types.ts:27
Parameters :
Name Type Optional
key string No
value string | number No
expiration number Yes
Returns : Promise<boolean> 
export abstract class CacheService {
  abstract get(key: string): Promise<string>;

  abstract getNumber(key: string): Promise<number>;

  abstract getBoolean(key: string): Promise<boolean>;

  abstract set(
    key: string,
    value: string | number,
    expiration?: number,
  ): Promise<boolean>;

  abstract del(...keys: string[]): Promise<boolean>;

  abstract incr(key: string): Promise<number>;

  abstract expire(key: string, expiresIn: number): Promise<boolean>;

  abstract getFromPattern(pattern: string): Promise<string[]>;
}

results matching ""

    No results matching ""