Class Cache

Hierarchy

Cache

Implements

ICache

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Cache(): Cache

Returns Cache

Properties

Private adapterClasses

adapterClasses: { clazz: ClassType<ICacheAdapter>; type: string }[] = []

Private adapters

adapters: {} = {}

Type declaration

[k: string]: ICacheAdapter

Private bins

bins: {} = {}

Type declaration

[k: string]: CacheBin

Private nodeId

nodeId: string

Private options

options: ICacheConfig = ...

Static NAME

NAME: string = ...

Methods

configure

configure(nodeId: string, config?: ICacheConfig): Promise<void>

- Defined in src/libs/cache/Cache.ts:68
Parameters
- nodeId: string
- Optional config: ICacheConfig
Returns Promise<void>

get

get<T>(key: string, bin?: string, options?: ICacheGetOptions): Promise<T>

Implementation of ICache.get
- Defined in src/libs/cache/Cache.ts:56
Type parameters
- T
Parameters
- key: string
- bin: string = ...
- Optional options: ICacheGetOptions
Returns Promise<T>

getAdapterClasses

getAdapterClasses(): { clazz: ClassType<ICacheAdapter>; type: string }[]

- Defined in src/libs/cache/Cache.ts:138
Returns { clazz: ClassType<ICacheAdapter>; type: string }[]

getAdapters

getAdapters(): {}

- Defined in src/libs/cache/Cache.ts:143
Returns {}
- [k: string]: ICacheAdapter

getBin

getBin(name: string): CacheBin

- Defined in src/libs/cache/Cache.ts:48
Parameters
- name: string
Returns CacheBin

getBins

getBins(): {}

- Defined in src/libs/cache/Cache.ts:148
Returns {}
- [k: string]: CacheBin

getOptions

getOptions(): ICacheConfig

- Defined in src/libs/cache/Cache.ts:133
Returns ICacheConfig

register

register(s: ClassType<ICacheAdapter>): Promise<boolean>

- Defined in src/libs/cache/Cache.ts:120
Parameters
- s: ClassType<ICacheAdapter>
Returns Promise<boolean>

set

set<T>(key: string, value: T, bin?: string, options?: ICacheSetOptions): Promise<T>

Implementation of ICache.set
- Defined in src/libs/cache/Cache.ts:62
Type parameters
- T
Parameters
- key: string
- value: T
- bin: string = ...
- Optional options: ICacheSetOptions
Returns Promise<T>

shutdown

shutdown(): Promise<void[]>

- Defined in src/libs/cache/Cache.ts:152
Returns Promise<void[]>

Generated using TypeDoc