Skip to main content

Class: RedisCache<T>

Defined in: service-core/src/database/RedisCache.ts:18

Implements a cache system for storing entities. Uses the cache Redis datastore (when configured) as the backing database. Otherwise, provides an in-memory cache store for entities.

Extends​

  • RedisStore

Type Parameters​

T​

T extends BaseEntity | SimpleEntity

Constructors​

Constructor​

new RedisCache<T>(type): RedisCache<T>

Defined in: service-core/src/database/RedisCache.ts:26

Parameters​

type​

any

Returns​

RedisCache<T>

Overrides​

RedisStore.constructor

Properties​

baseKey​

readonly baseKey: string

Defined in: service-core/node_modules/@rapidrest/core/dist/types/RedisStore.d.ts:13

The base key that is pre-pended to all IDs.

Inherited from​

RedisStore.baseKey

client?​

optional client?: RedisClientType

Defined in: service-core/node_modules/@rapidrest/core/dist/types/RedisStore.d.ts:14

Inherited from​

RedisStore.client

defaultTTL​

defaultTTL: number

Defined in: service-core/node_modules/@rapidrest/core/dist/types/RedisStore.d.ts:16

The default record TTL (in seconds).

Inherited from​

RedisStore.defaultTTL

entries​

protected entries: Map<string, MemoryStoreEntry>

Defined in: service-core/node_modules/@rapidrest/core/dist/types/RedisStore.d.ts:17

Inherited from​

RedisStore.entries

maxSize​

maxSize: number

Defined in: service-core/node_modules/@rapidrest/core/dist/types/RedisStore.d.ts:19

The maximum number of records to store.

Inherited from​

RedisStore.maxSize

redisClient?​

protected optional redisClient?: RedisClientType

Defined in: service-core/src/database/RedisCache.ts:21

sets​

protected sets: Map<string, MemoryStoreSetEntry>

Defined in: service-core/node_modules/@rapidrest/core/dist/types/RedisStore.d.ts:20

Inherited from​

RedisStore.sets

type​

protected readonly type: any

Defined in: service-core/src/database/RedisCache.ts:24

The entity type that is to be stored in this cache.

Methods​

clear()​

clear(): Promise<void>

Defined in: service-core/node_modules/@rapidrest/core/dist/types/RedisStore.d.ts:27

Deletes all entries in the storage system.

Returns​

Promise<void>

Inherited from​

RedisStore.clear

delete()​

delete(id): Promise<void>

Defined in: service-core/node_modules/@rapidrest/core/dist/types/RedisStore.d.ts:28

Deletes a single record with the given id.

Parameters​

id​

string

The id of the record to delete.

Returns​

Promise<void>

Inherited from​

RedisStore.delete

deleteMany()​

deleteMany(ids): Promise<void>

Defined in: service-core/node_modules/@rapidrest/core/dist/types/RedisStore.d.ts:29

Deletes the records associated with the list of given ids.

Parameters​

ids​

string[]

The list of ids to delete.

Returns​

Promise<void>

Inherited from​

RedisStore.deleteMany

deleteSet()​

deleteSet(id): Promise<void>

Defined in: service-core/node_modules/@rapidrest/core/dist/types/RedisStore.d.ts:30

Deletes the set of records associated with the given id.

Parameters​

id​

string

Returns​

Promise<void>

Inherited from​

RedisStore.deleteSet

destroy()​

destroy(): void

Defined in: service-core/node_modules/@rapidrest/core/dist/types/RedisStore.d.ts:31

Returns​

void

Inherited from​

RedisStore.destroy

load()​

load(id, skipRedis?): Promise<T | undefined>

Defined in: service-core/src/database/RedisCache.ts:41

Parameters​

id​

string

skipRedis?​

boolean

Returns​

Promise<T | undefined>

Overrides​

RedisStore.load

loadMany()​

loadMany(ids): Promise<(T | undefined)[]>

Defined in: service-core/src/database/RedisCache.ts:45

Parameters​

ids​

string[]

Returns​

Promise<(T | undefined)[]>

Overrides​

RedisStore.loadMany

loadSet()​

loadSet(id): Promise<(T | undefined)[] | undefined>

Defined in: service-core/src/database/RedisCache.ts:49

Parameters​

id​

string

Returns​

Promise<(T | undefined)[] | undefined>

Overrides​

RedisStore.loadSet

save()​

save(id, data, ttl?, skipRedis?): Promise<void>

Defined in: service-core/src/database/RedisCache.ts:53

Parameters​

id​

string

data​

T

ttl?​

number = ...

skipRedis?​

boolean = false

Returns​

Promise<void>

Overrides​

RedisStore.save

saveMany()​

saveMany(ids, data, ttl?): Promise<void>

Defined in: service-core/src/database/RedisCache.ts:57

Parameters​

ids​

string[]

data​

T[]

ttl?​

number

Returns​

Promise<void>

Overrides​

RedisStore.saveMany

saveSet()​

saveSet(id, data, idProp?, ttl?): Promise<void>

Defined in: service-core/src/database/RedisCache.ts:61

Parameters​

id​

string

data​

T[]

idProp?​

string = "uid"

ttl?​

number = ...

Returns​

Promise<void>

Overrides​

RedisStore.saveSet