Class CacheService<CacheValue>

class CacheService

common service to provide cache

Type Parameters

CacheValue = any

Hierarchy

CacheService
- DummyCacheService

Implements

CacheSupportable<CacheValue>

Index

Constructors

`Protected` constructor

new CacheService<CacheValue>(backend: CacheBackend, params?: { maker?: CacheKeyMakable; ns?: string; options?: CacheOptions }): CacheService<CacheValue>
Protected
Protected constructor -> use CacheService.create() WARN! - do not create directly.˜
Type Parameters
- CacheValue = any
Parameters
- backend: CacheBackend
  
  cache backend object
- Optional params: { maker?: CacheKeyMakable; ns?: string; options?: CacheOptions }
  
  params to create service.
  - Optional maker?: CacheKeyMakable
    
    custom key-maker
  - Optional ns?: string
    
    (optional) namespace of cache key (default: '')
  - Optional options?: CacheOptions
    
    (optional) the final options to create()
Returns CacheService<CacheValue>
- Defined in src/cores/cache/cache-service.ts:214

Properties

`Private` `Readonly` backend

backend: CacheBackend

Cache backend instance

`Readonly` maker

maker: CacheKeyMakable

maker of cache-key

`Readonly` ns

ns: string

Namespace of cache key

`Readonly` options

options: CacheOptions

the final options to create this service.

`Static` `Readonly` DEF_CACHE_DEFAULT_TIMEOUT

DEF_CACHE_DEFAULT_TIMEOUT: number = ...

Default cache timeout

Static

`Static` `Readonly` ENV_CACHE_DEFAULT_TIMEOUT

ENV_CACHE_DEFAULT_TIMEOUT: "CACHE_DEFAULT_TIMEOUT" = 'CACHE_DEFAULT_TIMEOUT'

Environment variable name for default cache timeout

Static

`Static` `Readonly` ENV_CACHE_ENDPOINT

ENV_CACHE_ENDPOINT: "CACHE_ENDPOINT" = 'CACHE_ENDPOINT'

Environment variable name for cache server endpoint

Static

`Static` `Private` `Readonly` NAMESPACE_DELIMITER

NAMESPACE_DELIMITER: "::" = '::'

Namespace delimiter

Static

Methods

`Protected` asNamespacedKey

asNamespacedKey(key: CacheKey): string
Protected
Get namespace prefixed cache key
Parameters
- key: CacheKey
Returns string
- Defined in src/cores/cache/cache-service.ts:515

cloneByType

cloneByType(type: string, delimiter?: string): CacheService<any>
for convient, make another typed service.
- it add type into key automatically.
Returns
the typed CacheService
Parameters
- type: string
  
  model-type like 'test'
- delimiter: string = ':'
  
  (optional) delim bewteen type and key (default ':')
Returns CacheService<any>
- Defined in src/cores/cache/cache-service.ts:249

close

close(): Promise<void>
Close backend and connection

Returns Promise<void>
- Defined in src/cores/cache/cache-service.ts:258

delete

delete(key: CacheKey): Promise<boolean>
Delete a key

Returns
true on success
Parameters
- key: CacheKey
Returns Promise<boolean>
- Defined in src/cores/cache/cache-service.ts:440

deleteMulti

deleteMulti(keys: CacheKey[]): Promise<boolean[]>
Delete multiple keys

Returns
number of deleted entries
Parameters
- keys: CacheKey[]
Returns Promise<boolean[]>
- Defined in src/cores/cache/cache-service.ts:454

exists

exists(key: CacheKey): Promise<boolean>
Check whether the key is cached

Returns
true if the key is cached
Parameters
- key: CacheKey
Returns Promise<boolean>
- Defined in src/cores/cache/cache-service.ts:267

get

get(key: CacheKey): Promise<CacheValue>
Retrieve a key
Parameters
- key: CacheKey
Returns Promise<CacheValue>
Implementation of CacheSupportable.get
- Defined in src/cores/cache/cache-service.ts:334

getAndDelete

getAndDelete(key: CacheKey): Promise<CacheValue>
Get and delete the key
Parameters
- key: CacheKey
Returns Promise<CacheValue>
- Defined in src/cores/cache/cache-service.ts:418

getAndSet

getAndSet(key: CacheKey, val: CacheValue): Promise<CacheValue>
Set the value of a key and return its old value
Parameters
- key: CacheKey
- val: CacheValue
Returns Promise<CacheValue>
- Defined in src/cores/cache/cache-service.ts:389

getMulti

getMulti(keys: CacheKey[]): Promise<KeyValueMap<CacheValue>>
Get multiple keys
Parameters
- keys: CacheKey[]
Returns Promise<KeyValueMap<CacheValue>>
- Defined in src/cores/cache/cache-service.ts:347

getTimeout

getTimeout(key: CacheKey): Promise<number>
Get remaining time to live in milliseconds

Returns
- number of milliseconds to expire
- undefined if the key does not exist
- 0 if the key has no timeout
Parameters
- key: CacheKey
Returns Promise<number>
- Defined in src/cores/cache/cache-service.ts:488

hello

hello(): string
Say hello

Returns string
- Defined in src/cores/cache/cache-service.ts:237

inc

inc(key: CacheKey, inc: number): Promise<number>
same as increment()
Parameters
- key: CacheKey
- inc: number
Returns Promise<number>
Implementation of CacheSupportable.inc
- Defined in src/cores/cache/cache-service.ts:382

increment

increment(key: CacheKey, inc: number): Promise<number>
Increment the integer value of a key
Parameters
- key: CacheKey
- inc: number
  
  number to increment
Returns Promise<number>
- Defined in src/cores/cache/cache-service.ts:370

keys

keys(): Promise<string[]>
List all keys

Returns
list of keys

Returns Promise<string[]>
- Defined in src/cores/cache/cache-service.ts:279

removeTimeout

removeTimeout(key: CacheKey): Promise<boolean>
Remove the timeout from a key
Parameters
- key: CacheKey
Returns Promise<boolean>
- Defined in src/cores/cache/cache-service.ts:501

set

set(key: CacheKey, val: CacheValue, timeout?: number | Timeout): Promise<boolean>
Store a key

Returns
true on success
Parameters
- key: CacheKey
- val: CacheValue
- Optional timeout: number | Timeout
  
  (optional) TTL in seconds or Timeout object
Returns Promise<boolean>
Implementation of CacheSupportable.set
- Defined in src/cores/cache/cache-service.ts:298

setMulti

setMulti(entries: CacheEntry<CacheValue>[]): Promise<boolean>
Store multiple keys

Returns
true on success
Parameters
- entries: CacheEntry<CacheValue>[]
Returns Promise<boolean>
- Defined in src/cores/cache/cache-service.ts:314

setTimeout

setTimeout(key: CacheKey, timeout: number | Timeout): Promise<boolean>
Set or update the timeout of a key

Returns
true on success
Parameters
- key: CacheKey
- timeout: number | Timeout
  
  TTL in seconds or Timeout object
Returns Promise<boolean>
- Defined in src/cores/cache/cache-service.ts:472

`Static` create

create(options?: CacheOptions, maker?: CacheKeyMakable): CacheService<any>
Factory method

Static
Parameters
- Optional options: CacheOptions
  
  (optional) cache options
- Optional maker: CacheKeyMakable
  
  (optional) custome cache-pkey generator.
Returns CacheService<any>
- Defined in src/cores/cache/cache-service.ts:176

Class CacheService<CacheValue>

Type Parameters

CacheValue = any

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Type Parameters

CacheValue = any

Parameters

backend: CacheBackend

Optional params: { maker?: CacheKeyMakable; ns?: string; options?: CacheOptions }

Optional maker?: CacheKeyMakable

Optional ns?: string

Optional options?: CacheOptions

Returns CacheService<CacheValue>

Properties

Private Readonly backend

Readonly maker

Readonly ns

Readonly options

Static Readonly DEF_CACHE_DEFAULT_TIMEOUT

Static

Static Readonly ENV_CACHE_DEFAULT_TIMEOUT

Static

Static Readonly ENV_CACHE_ENDPOINT

Static

Static Private Readonly NAMESPACE_DELIMITER

Static

Methods

Protected asNamespacedKey

Parameters

key: CacheKey

Returns string

cloneByType

Returns

Parameters

type: string

delimiter: string = ':'

Returns CacheService<any>

close

Returns Promise<void>

delete

Returns

Parameters

key: CacheKey

Returns Promise<boolean>

deleteMulti

Returns

Parameters

keys: CacheKey[]

Returns Promise<boolean[]>

exists

Returns

Parameters

key: CacheKey

Returns Promise<boolean>

get

Parameters

key: CacheKey

Returns Promise<CacheValue>

getAndDelete

Parameters

key: CacheKey

Returns Promise<CacheValue>

getAndSet

Parameters

key: CacheKey

val: CacheValue

Returns Promise<CacheValue>

getMulti

Parameters

keys: CacheKey[]

Returns Promise<KeyValueMap<CacheValue>>

getTimeout

Returns

`Protected` constructor

`Optional` params: { maker?: CacheKeyMakable; ns?: string; options?: CacheOptions }

`Optional` maker?: CacheKeyMakable

`Optional` ns?: string

`Optional` options?: CacheOptions

`Private` `Readonly` backend

`Readonly` maker

`Readonly` ns

`Readonly` options

`Static` `Readonly` DEF_CACHE_DEFAULT_TIMEOUT

`Static` `Readonly` ENV_CACHE_DEFAULT_TIMEOUT

`Static` `Readonly` ENV_CACHE_ENDPOINT

`Static` `Private` `Readonly` NAMESPACE_DELIMITER

`Protected` asNamespacedKey

`Optional` timeout: number | Timeout

`Static` create

`Optional` options: CacheOptions

`Optional` maker: CacheKeyMakable