Class MemoryStorageEngine<T>

StorageEngine which uses a Map in the process memory space as a datasource

Type parameters

T

Hierarchy

BaseStorageEngine<T>
- MemoryStorageEngine

Index

Methods

Constructors

constructor

Properties

Methods

addToList

addToList(listId: string, id: string): void

Overrides BaseStorageEngine.addToList
- Defined in storageEngine/MemoryStorageEngine.ts:113
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 void

filter

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

Overrides BaseStorageEngine.filter
- Defined in storageEngine/MemoryStorageEngine.ts:53
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 T[]
filtered data

find

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

Overrides BaseStorageEngine.find
- Defined in storageEngine/MemoryStorageEngine.ts:76
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 null | T
the first result or null if nothing was found

get

get(id: string): null | T
get(id: string, DO_NOT_USE_THIS_OVERLOAD?: unknown): string | Promise<string>

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

Parameters
- id: string
  
  id of the object
Returns null | T
Overrides BaseStorageEngine.get
- Defined in storageEngine/MemoryStorageEngine.ts:19
Parameters
- id: string
- Optional DO_NOT_USE_THIS_OVERLOAD: unknown
Returns string | Promise<string>

getListCount

getListCount(listId: string): number

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

Parameters
- listId: string
  
  id of the list
Returns number

getListMembers

getListMembers(listId: string): string[]

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

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

initialize

initialize(): void | Promise<void>

Inherited from BaseStorageEngine.initialize
- Defined in storageEngine/BaseStorageEngine.ts:14
Initializes the engine, e.g. db connection, etc..

Returns void | Promise<void>

isListMember

isListMember(listId: string, id: string): boolean

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

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

Private parseData

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

- Defined in storageEngine/MemoryStorageEngine.ts:168
Parse loaded data

Parameters
- data: undefined | null | string
Returns null | T

Private prepareData

prepareData(data: T): string

- Defined in storageEngine/MemoryStorageEngine.ts:161
Prepare data for storage inside redis

Parameters
- data: T
Returns string

remove

remove(id: string): void

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

Parameters
- id: string
  
  id of the object
Returns void

removeFromList

removeFromList(listId: string, id: string): void

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

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

removeList

removeList(listId: string): void

Overrides BaseStorageEngine.removeList
- Defined in storageEngine/MemoryStorageEngine.ts:146
Remove a list

Parameters
- listId: string
  
  id of the list
Returns void

upsert

upsert(id: string, updateData: T): void

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

Parameters
- id: string
  
  id of the object
- updateData: T
  
  the new Data which get's merged with the old
Returns void

Constructors

constructor

new MemoryStorageEngine<T>(): MemoryStorageEngine<T>

Overrides BaseStorageEngine.constructor
- Defined in storageEngine/MemoryStorageEngine.ts:10
Type parameters
- T
Returns MemoryStorageEngine<T>

Properties

index

index: Map<string, string[]> = ...

map

map: Map<string, string> = ...

ready

ready: boolean

Generated using TypeDoc