Class RedisBloomCMK

Hierarchy

Module
- RedisBloomCMK

Constructors

constructor

new RedisBloomCMK(clusterNodes: ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: ClusterOptions): RedisBloomCMK
new RedisBloomCMK(redisOptions: RedisOptions, moduleOptions?: RedisModuleOptions): RedisBloomCMK

Overrides Module.constructor
- Defined in modules/bloom-cmk/redisbloom-cmk.ts:18
Initializing the module object

Parameters
- clusterNodes: ClusterNode[]
  
  The nodes of the cluster
- Optional moduleOptions: RedisModuleOptions
  
  The additional module options
- Optional clusterOptions: ClusterOptions
  
  The options of the clusters
Returns RedisBloomCMK
Overrides Module.constructor
- Defined in modules/bloom-cmk/redisbloom-cmk.ts:27
Initializing the module object

Parameters
- redisOptions: RedisOptions
  
  The options of the redis database
- Optional moduleOptions: RedisModuleOptions
  
  The additional module options
Returns RedisBloomCMK

Properties

Private bloomCmkCommander

bloomCmkCommander: BloomCmkCommander = ...

cluster

cluster: Cluster

clusterNodes

clusterNodes: ClusterNode[]

clusterOptions

clusterOptions: ClusterOptions

isHandleError

isHandleError: boolean

name

name: string

redis

redis: Redis

redisOptions

redisOptions: RedisOptions

returnRawResponse

returnRawResponse: boolean

showDebugLogs

showDebugLogs: boolean

Methods

connect

connect(): Promise<void>

Inherited from Module.connect
- Defined in modules/module.base.ts:52
Connecting to the Redis database with the module

Returns Promise<void>

disconnect

disconnect(): Promise<void>

Inherited from Module.disconnect
- Defined in modules/module.base.ts:64
Disconnecting from the Redis database with the module

Returns Promise<void>

handleError

handleError(error: string): any

Inherited from Module.handleError
- Defined in modules/module.base.ts:99
Handling a error

Parameters
- error: string
  
  The message of the error
Returns any

handleResponse

handleResponse(response: any): any

Inherited from Module.handleResponse
- Defined in modules/module.base.ts:110
Simpilizing the response of the Module command

Parameters
- response: any
  
  The array response from the module
Returns any

incrby

incrby(key: string, items: CMKIncrbyItems[]): Promise<number[]>

- Defined in modules/bloom-cmk/redisbloom-cmk.ts:59
Increases the count of item's by increment.

Parameters
- key: string
  
  The name of the sketch.
- items: CMKIncrbyItems[]
  
  A list of item and increment set's
Returns Promise<number[]>

info

info(key: string): Promise<string[]>

- Defined in modules/bloom-cmk/redisbloom-cmk.ts:90
Returning information about a key

Parameters
- key: string
  
  The key of the 'CMS.INFO' command
Returns Promise<string[]>

initbydim

initbydim(key: string, width: number, depth: number): Promise<"OK">

- Defined in modules/bloom-cmk/redisbloom-cmk.ts:38
Initializes a Count-Min Sketch to dimensions specified by user.

Parameters
- key: string
  
  The name of the sketch.
- width: number
  
  The number of counter in each array. Reduces the error size.
- depth: number
  
  The number of counter-arrays. Reduces the probability for an error of a certain size (percentage of total count).
Returns Promise<"OK">

initbyprob

initbyprob(key: string, errorSize: number, probability: number): Promise<"OK">

- Defined in modules/bloom-cmk/redisbloom-cmk.ts:49
Initializes a Count-Min Sketch to accommodate requested capacity.

Parameters
- key: string
  
  The name of the sketch.
- errorSize: number
  
  Estimate size of error. The error is a percent of total counted items. This effects the width of the sketch.
- probability: number
  
  The desired probability for inflated count.
Returns Promise<"OK">

isOnlyTwoDimensionalArray

isOnlyTwoDimensionalArray(array: any[]): boolean

Inherited from Module.isOnlyTwoDimensionalArray
- Defined in modules/module.base.ts:148
Check if array is fully two dimensional. Only items in the array are arrays.

Parameters
- array: any[]
  
  The potential two dimensional array
Returns boolean

merge

merge(dest: string, numKeys: number, sources: string[], weights?: number[]): Promise<"OK">

- Defined in modules/bloom-cmk/redisbloom-cmk.ts:81
Merges several sketches into one sketch.

Parameters
- dest: string
  
  The name of destination sketch.
- numKeys: number
  
  The number of sketches to be merged.
- sources: string[]
  
  The names of source sketches to be merged.
- Optional weights: number[]
  
  A multiple of each sketch. Default =1.
Returns Promise<"OK">

paramToString

paramToString(paramValue: string): string

Inherited from Module.paramToString
- Defined in modules/module.base.ts:169
Formatting given param value to string

Parameters
- paramValue: string
  
  The given param value
Returns string
A param value converted to string

query

query(key: string, items: string[]): Promise<number[]>

- Defined in modules/bloom-cmk/redisbloom-cmk.ts:69
Returns count for item's.

Parameters
- key: string
  
  The name of the sketch.
- items: string[]
  
  A list of items.
Returns Promise<number[]>

reduceArrayDimension

reduceArrayDimension(array: any[][]): any[]

Inherited from Module.reduceArrayDimension
- Defined in modules/module.base.ts:156
Reducing an array by one level. i.e. from two dimensional to 1 dimensional.

Parameters
- array: any[][]
  
  The potentional two dimensional array
Returns any[]

sendCommand

sendCommand(data: CommandData): Promise<any>

Inherited from Module.sendCommand
- Defined in modules/module.base.ts:77
Running a Redis command

Parameters
- data: CommandData
  
  The command data of a command to send. Consists of command and args.
Returns Promise<any>

Generated using TypeDoc