RedisStorageEngine

StorageEngine which uses redis as a datasource

Type parameters

Hierarchy

BaseStorageEngine<T>
- RedisStorageEngine

Index

Methods

Properties

Constructors

constructor

Methods

addToList

addToList(listId: string, id: string): Promise<void>

Overrides BaseStorageEngine.addToList
- Defined in storageEngine/RedisStorageEngine.ts:199
Add an id (or a list of them) to a list

Parameters
- listId: string
  
  id of the list
- id: string
  
  array of ids that should be added
Returns Promise<void>

filter

filter(fn: (value?: T, index?: number, array?: T[]) => unknown, ids: string[], namespace: string): Promise<any[]>

Overrides BaseStorageEngine.filter
- Defined in storageEngine/RedisStorageEngine.ts:134
Filter for an object

Parameters
- fn: (value?: T, index?: number, array?: T[]) => unknown
  
  filter function to use
  - - (value?: T, index?: number, array?: T[]): unknown
    - Parameters
      - Optional value: T
      - Optional index: number
      - Optional array: T[]
      Returns unknown
- ids: string[]
  
  array of ids that should be used for the filtering
- namespace: string
  
  namespace of the filter
Returns Promise<any[]>
filtered data

find

find(fn: (value?: T, index?: number, array?: string[]) => boolean, ids?: null | string[], namespace: string): Promise<null | T>

Overrides BaseStorageEngine.find
- Defined in storageEngine/RedisStorageEngine.ts:157
Filter for an object and return after the first search success

Parameters
- fn: (value?: T, index?: number, array?: string[]) => boolean
  
  filter function to use
  - - (value?: T, index?: number, array?: string[]): boolean
    - Parameters
      - Optional value: T
      - Optional index: number
      - Optional array: string[]
      Returns boolean
- ids: null | string[] = null
  
  array of ids that should be used for the filtering
- namespace: string
  
  namespace of the filter
Returns Promise<null | T>
the first result or null if nothing was found

get

get(id: string): Promise<null | T>
get(id: string, useHash: boolean): Promise<string>

Overrides BaseStorageEngine.get
- Defined in storageEngine/RedisStorageEngine.ts:45
Get an object from the cache via id

Parameters
- id: string
  
  id of the object
Returns Promise<null | T>
Overrides BaseStorageEngine.get
- Defined in storageEngine/RedisStorageEngine.ts:51
Get an object from the cache via id

Parameters
- id: string
  
  id of the object
- useHash: boolean
  
  whether to use hash objects for this action
Returns Promise<string>

getListCount

getListCount(listId: string): Promise<number>

Overrides BaseStorageEngine.getListCount
- Defined in storageEngine/RedisStorageEngine.ts:248
Get the amount of items within a list

Parameters
- listId: string
  
  id of the list
Returns Promise<number>

getListMembers

getListMembers(listId: string): Promise<string[]>

Overrides BaseStorageEngine.getListMembers
- Defined in storageEngine/RedisStorageEngine.ts:185
Get a list of values that are part of a list

Parameters
- listId: string
  
  id of the list
Returns Promise<string[]>
array of ids that are members of the list

initialize

initialize(): Promise<void>

Overrides BaseStorageEngine.initialize
- Defined in storageEngine/RedisStorageEngine.ts:31
Initialize the storage engine and create a connection to redis

Returns Promise<void>

isListMember

isListMember(listId: string, id: string): Promise<boolean>

Overrides BaseStorageEngine.isListMember
- Defined in storageEngine/RedisStorageEngine.ts:213
Check if an id is part of a list

Parameters
- listId: string
  
  id of the list
- id: string
  
  id that should be checked
Returns Promise<boolean>

parseData

parseData(data: null | string): null | T

- Defined in storageEngine/RedisStorageEngine.ts:267
Parse loaded data

Parameters
- data: null | string
Returns null | T

prepareData

prepareData(data: T): string

- Defined in storageEngine/RedisStorageEngine.ts:260
Prepare data for storage inside redis

Parameters
- data: T
Returns string

prepareNamespace

prepareNamespace(namespace: string): string

- Defined in storageEngine/RedisStorageEngine.ts:276
Prepare a namespace for a KEYS operation by adding a * at the end

Parameters
- namespace: string
  
  namespace to prepare
Returns string
namespace + *

remove

remove(id: string, useHash?: boolean): Promise<void>

Overrides BaseStorageEngine.remove
- Defined in storageEngine/RedisStorageEngine.ts:108
Remove an object from the cache

Parameters
- id: string
  
  id of the object
- useHash: boolean = ...
  
  whether to use hash objects for this action
Returns Promise<void>

removeFromList

removeFromList(listId: string, id: string): Promise<void>

Overrides BaseStorageEngine.removeFromList
- Defined in storageEngine/RedisStorageEngine.ts:227
Remove an id from a list

Parameters
- listId: string
  
  id of the list
- id: string
  
  id that should be removed
Returns Promise<void>

removeList

removeList(listId: string): Promise<void>

Overrides BaseStorageEngine.removeList
- Defined in storageEngine/RedisStorageEngine.ts:240
Remove a list

Parameters
- listId: string
  
  id of the list
Returns Promise<void>

upsert

upsert(id: string, updateData: any, useHash?: boolean): Promise<void>

Overrides BaseStorageEngine.upsert
- Defined in storageEngine/RedisStorageEngine.ts:79
Upsert an object into the cache

Parameters
- id: string
  
  id of the object
- updateData: any
  
  the new Data which get's merged with the old
- useHash: boolean = ...
  
  whether to use hash objects for this action
Returns Promise<void>

Properties

client

client: null | RedisClient

whether this storage engine is ready for usage

options

options: <internal>."/home/travis/build/DasWolke/RainCache/src/types".RedisStorageOptions

options that are passed to the redis client

ready

ready: boolean

useHash

useHash: boolean

whether hash objects should be used for storing data

Constructors

constructor

new RedisStorageEngine<T>(options?: <internal>."/home/travis/build/DasWolke/RainCache/src/types".RedisStorageOptions): RedisStorageEngine<T>

Overrides BaseStorageEngine.constructor
- Defined in storageEngine/RedisStorageEngine.ts:20
Create a new redis storage engine

Type parameters
- T
Parameters
- options: <internal>."/home/travis/build/DasWolke/RainCache/src/types".RedisStorageOptions = ...
Returns RedisStorageEngine<T>

Type parameters

T

Hierarchy

Index

Methods

Properties

Constructors

Methods

addToList

Parameters

listId: string

id: string

Returns Promise<void>

filter

Parameters

fn: (value?: T, index?: number, array?: T[]) => unknown

Parameters

Optional value: T

Optional index: number

Optional array: T[]

Returns unknown

ids: string[]

namespace: string

Returns Promise<any[]>

find

Parameters

fn: (value?: T, index?: number, array?: string[]) => boolean

Parameters

Optional value: T

Optional index: number

Optional array: string[]

Returns boolean

ids: null | string[] = null

namespace: string

Returns Promise<null | T>

get

Parameters

id: string

Returns Promise<null | T>

Parameters

id: string

useHash: boolean

Returns Promise<string>

getListCount

Parameters

listId: string

Returns Promise<number>

getListMembers

Parameters

listId: string

Returns Promise<string[]>

initialize

Returns Promise<void>

isListMember

Parameters

listId: string

id: string

Returns Promise<boolean>

parseData

Parameters

data: null | string

Returns null | T

prepareData

Parameters

data: T

Returns string

prepareNamespace

Parameters

namespace: string

Returns string

remove

Parameters

id: string

useHash: boolean = ...

Returns Promise<void>

removeFromList

Parameters

listId: string

id: string

Returns Promise<void>