diff --git a/documentation/bloom/index.html b/documentation/bloom/index.html index 4694937e51..bb2b743288 100644 --- a/documentation/bloom/index.html +++ b/documentation/bloom/index.html @@ -2,4 +2,5 @@

@node-redis/bloom

 +

The source code and documentation for this package are in the main node-redis repo.

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/interfaces/commands_bloom_INFO.InfoReply.html b/documentation/bloom/interfaces/commands_bloom_INFO.InfoReply.html index 7672cd5c9c..9b0ec60df1 100644 --- a/documentation/bloom/interfaces/commands_bloom_INFO.InfoReply.html +++ b/documentation/bloom/interfaces/commands_bloom_INFO.InfoReply.html @@ -1 +1 @@ -InfoReply | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfoReply

Hierarchy

  • InfoReply

Index

Properties

Properties

capacity

capacity: number

expansionRate

expansionRate: number

numberOfFilters

numberOfFilters: number

numberOfInsertedItems

numberOfInsertedItems: number

size

size: number

Generated using TypeDoc

\ No newline at end of file +InfoReply | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfoReply

Hierarchy

  • InfoReply

Index

Properties

Properties

capacity

capacity: number

expansionRate

expansionRate: number

numberOfFilters

numberOfFilters: number

numberOfInsertedItems

numberOfInsertedItems: number

size

size: number

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/interfaces/commands_count_min_sketch_INFO.InfoReply.html b/documentation/bloom/interfaces/commands_count_min_sketch_INFO.InfoReply.html index 789076d85b..ee1a0f5d8c 100644 --- a/documentation/bloom/interfaces/commands_count_min_sketch_INFO.InfoReply.html +++ b/documentation/bloom/interfaces/commands_count_min_sketch_INFO.InfoReply.html @@ -1 +1 @@ -InfoReply | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfoReply

Hierarchy

  • InfoReply

Index

Properties

Properties

count

count: number

depth

depth: number

width

width: number

Generated using TypeDoc

\ No newline at end of file +InfoReply | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfoReply

Hierarchy

  • InfoReply

Index

Properties

Properties

count

count: number

depth

depth: number

width

width: number

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/interfaces/commands_cuckoo.InsertOptions.html b/documentation/bloom/interfaces/commands_cuckoo.InsertOptions.html index 643c4bc0b0..c81186c768 100644 --- a/documentation/bloom/interfaces/commands_cuckoo.InsertOptions.html +++ b/documentation/bloom/interfaces/commands_cuckoo.InsertOptions.html @@ -1 +1 @@ -InsertOptions | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InsertOptions

Hierarchy

  • InsertOptions

Index

Properties

Properties

Optional CAPACITY

CAPACITY?: number

Optional NOCREATE

NOCREATE?: true

Generated using TypeDoc

\ No newline at end of file +InsertOptions | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InsertOptions

Hierarchy

  • InsertOptions

Index

Properties

Properties

Optional CAPACITY

CAPACITY?: number

Optional NOCREATE

NOCREATE?: true

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/interfaces/commands_cuckoo_INFO.InfoReply.html b/documentation/bloom/interfaces/commands_cuckoo_INFO.InfoReply.html index 7947841ee5..ec9b83f093 100644 --- a/documentation/bloom/interfaces/commands_cuckoo_INFO.InfoReply.html +++ b/documentation/bloom/interfaces/commands_cuckoo_INFO.InfoReply.html @@ -1 +1 @@ -InfoReply | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfoReply

Hierarchy

  • InfoReply

Index

Properties

Properties

bucketSize

bucketSize: number

expansionRate

expansionRate: number

maxIteration

maxIteration: number

numberOfBuckets

numberOfBuckets: number

numberOfDeletedItems

numberOfDeletedItems: number

numberOfFilters

numberOfFilters: number

numberOfInsertedItems

numberOfInsertedItems: number

size

size: number

Generated using TypeDoc

\ No newline at end of file +InfoReply | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfoReply

Hierarchy

  • InfoReply

Index

Properties

Properties

bucketSize

bucketSize: number

expansionRate

expansionRate: number

maxIteration

maxIteration: number

numberOfBuckets

numberOfBuckets: number

numberOfDeletedItems

numberOfDeletedItems: number

numberOfFilters

numberOfFilters: number

numberOfInsertedItems

numberOfInsertedItems: number

size

size: number

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/interfaces/commands_top_k_INFO.InfoReply.html b/documentation/bloom/interfaces/commands_top_k_INFO.InfoReply.html index 668c427f82..55cf1775d0 100644 --- a/documentation/bloom/interfaces/commands_top_k_INFO.InfoReply.html +++ b/documentation/bloom/interfaces/commands_top_k_INFO.InfoReply.html @@ -1 +1 @@ -InfoReply | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfoReply

Hierarchy

  • InfoReply

Index

Properties

Properties

decay

decay: number

depth

depth: number

k

k: number

width

width: number

Generated using TypeDoc

\ No newline at end of file +InfoReply | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfoReply

Hierarchy

  • InfoReply

Index

Properties

Properties

decay

decay: number

depth

depth: number

k

k: number

width

width: number

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_bloom_ADD.html b/documentation/bloom/modules/commands_bloom_ADD.html index ebcd86ef78..f6e03982bf 100644 --- a/documentation/bloom/modules/commands_bloom_ADD.html +++ b/documentation/bloom/modules/commands_bloom_ADD.html @@ -1 +1 @@ -commands/bloom/ADD | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/ADD

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, item: string): string[]

transformReply

  • transformReply(reply: number): boolean

  • Parameters

    • reply: number

    Returns boolean

Generated using TypeDoc

\ No newline at end of file +commands/bloom/ADD | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/ADD

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, item: string): string[]

transformReply

  • transformReply(reply: number): boolean

  • Parameters

    • reply: number

    Returns boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_bloom_EXISTS.html b/documentation/bloom/modules/commands_bloom_EXISTS.html index 068182601b..487bad8f6d 100644 --- a/documentation/bloom/modules/commands_bloom_EXISTS.html +++ b/documentation/bloom/modules/commands_bloom_EXISTS.html @@ -1 +1 @@ -commands/bloom/EXISTS | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/EXISTS

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string, item: string): string[]

Generated using TypeDoc

\ No newline at end of file +commands/bloom/EXISTS | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/EXISTS

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string, item: string): string[]

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_bloom_INFO.html b/documentation/bloom/modules/commands_bloom_INFO.html index 8208f45ad8..5fee800ccd 100644 --- a/documentation/bloom/modules/commands_bloom_INFO.html +++ b/documentation/bloom/modules/commands_bloom_INFO.html @@ -1 +1 @@ -commands/bloom/INFO | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/INFO

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

InfoRawReply

InfoRawReply: [_: string, capacity: number, _: string, size: number, _: string, numberOfFilters: number, _: string, numberOfInsertedItems: number, _: string, expansionRate: number]

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string): string[]

transformReply

Generated using TypeDoc

\ No newline at end of file +commands/bloom/INFO | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/INFO

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

InfoRawReply

InfoRawReply: [_: string, capacity: number, _: string, size: number, _: string, numberOfFilters: number, _: string, numberOfInsertedItems: number, _: string, expansionRate: number]

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string): string[]

transformReply

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_bloom_INSERT.html b/documentation/bloom/modules/commands_bloom_INSERT.html index 32c30eed63..d96e1ed124 100644 --- a/documentation/bloom/modules/commands_bloom_INSERT.html +++ b/documentation/bloom/modules/commands_bloom_INSERT.html @@ -1 +1 @@ -commands/bloom/INSERT | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/INSERT

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, items: string | string[], options?: InsertOptions): string[]

transformReply

  • transformReply(reply: number[]): boolean[]

  • Parameters

    • reply: number[]

    Returns boolean[]

Generated using TypeDoc

\ No newline at end of file +commands/bloom/INSERT | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/INSERT

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, items: string | string[], options?: InsertOptions): string[]

transformReply

  • transformReply(reply: number[]): boolean[]

  • Parameters

    • reply: number[]

    Returns boolean[]

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_bloom_LOADCHUNK.html b/documentation/bloom/modules/commands_bloom_LOADCHUNK.html index c9def70e92..581ceddee7 100644 --- a/documentation/bloom/modules/commands_bloom_LOADCHUNK.html +++ b/documentation/bloom/modules/commands_bloom_LOADCHUNK.html @@ -1 +1 @@ -commands/bloom/LOADCHUNK | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/LOADCHUNK

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, iteretor: number, chunk: RedisCommandArgument): RedisCommandArguments

transformReply

  • transformReply(): "OK"

Generated using TypeDoc

\ No newline at end of file +commands/bloom/LOADCHUNK | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/LOADCHUNK

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, iteretor: number, chunk: RedisCommandArgument): RedisCommandArguments

transformReply

  • transformReply(): "OK"

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_bloom_MADD.html b/documentation/bloom/modules/commands_bloom_MADD.html index cd1804cb65..faa631a0e5 100644 --- a/documentation/bloom/modules/commands_bloom_MADD.html +++ b/documentation/bloom/modules/commands_bloom_MADD.html @@ -1 +1 @@ -commands/bloom/MADD | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/MADD

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, items: string[]): string[]

Generated using TypeDoc

\ No newline at end of file +commands/bloom/MADD | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/MADD

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, items: string[]): string[]

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_bloom_MEXISTS.html b/documentation/bloom/modules/commands_bloom_MEXISTS.html index e797c929da..cbb795c400 100644 --- a/documentation/bloom/modules/commands_bloom_MEXISTS.html +++ b/documentation/bloom/modules/commands_bloom_MEXISTS.html @@ -1 +1 @@ -commands/bloom/MEXISTS | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/MEXISTS

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string, items: string[]): string[]

Generated using TypeDoc

\ No newline at end of file +commands/bloom/MEXISTS | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/MEXISTS

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string, items: string[]): string[]

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_bloom_RESERVE.html b/documentation/bloom/modules/commands_bloom_RESERVE.html index e310e2fcf0..6003750181 100644 --- a/documentation/bloom/modules/commands_bloom_RESERVE.html +++ b/documentation/bloom/modules/commands_bloom_RESERVE.html @@ -1 +1 @@ -commands/bloom/RESERVE | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/RESERVE

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, errorRate: number, capacity: number, options?: ReserveOptions): string[]

transformReply

  • transformReply(): "OK"

Generated using TypeDoc

\ No newline at end of file +commands/bloom/RESERVE | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/RESERVE

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, errorRate: number, capacity: number, options?: ReserveOptions): string[]

transformReply

  • transformReply(): "OK"

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_bloom_SCANDUMP.html b/documentation/bloom/modules/commands_bloom_SCANDUMP.html index ef43b6ef98..951f44a797 100644 --- a/documentation/bloom/modules/commands_bloom_SCANDUMP.html +++ b/documentation/bloom/modules/commands_bloom_SCANDUMP.html @@ -1 +1 @@ -commands/bloom/SCANDUMP | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/SCANDUMP

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string, iterator: number): string[]

transformReply

  • transformReply(__namedParameters: ScanDumpRawReply): ScanDumpReply

Generated using TypeDoc

\ No newline at end of file +commands/bloom/SCANDUMP | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/SCANDUMP

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string, iterator: number): string[]

transformReply

  • transformReply(__namedParameters: ScanDumpRawReply): ScanDumpReply

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_count_min_sketch_INCRBY.html b/documentation/bloom/modules/commands_count_min_sketch_INCRBY.html index 94b7d0514c..48ee68c0fb 100644 --- a/documentation/bloom/modules/commands_count_min_sketch_INCRBY.html +++ b/documentation/bloom/modules/commands_count_min_sketch_INCRBY.html @@ -1 +1 @@ -commands/count-min-sketch/INCRBY | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/INCRBY

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, items: IncrByItem | IncrByItem[]): string[]

transformReply

  • transformReply(): number[]

Generated using TypeDoc

\ No newline at end of file +commands/count-min-sketch/INCRBY | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/INCRBY

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, items: IncrByItem | IncrByItem[]): string[]

transformReply

  • transformReply(): number[]

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_count_min_sketch_INFO.html b/documentation/bloom/modules/commands_count_min_sketch_INFO.html index df64688946..3a20e602ed 100644 --- a/documentation/bloom/modules/commands_count_min_sketch_INFO.html +++ b/documentation/bloom/modules/commands_count_min_sketch_INFO.html @@ -1 +1 @@ -commands/count-min-sketch/INFO | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/INFO

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

InfoRawReply

InfoRawReply: [_: string, width: number, _: string, depth: number, _: string, count: number]

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string): string[]

transformReply

Generated using TypeDoc

\ No newline at end of file +commands/count-min-sketch/INFO | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/INFO

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

InfoRawReply

InfoRawReply: [_: string, width: number, _: string, depth: number, _: string, count: number]

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string): string[]

transformReply

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_count_min_sketch_INITBYDIM.html b/documentation/bloom/modules/commands_count_min_sketch_INITBYDIM.html index 7a51481f6f..f0797a6dff 100644 --- a/documentation/bloom/modules/commands_count_min_sketch_INITBYDIM.html +++ b/documentation/bloom/modules/commands_count_min_sketch_INITBYDIM.html @@ -1 +1 @@ -commands/count-min-sketch/INITBYDIM | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/INITBYDIM

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, width: number, depth: number): string[]

transformReply

  • transformReply(): "OK"

Generated using TypeDoc

\ No newline at end of file +commands/count-min-sketch/INITBYDIM | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/INITBYDIM

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, width: number, depth: number): string[]

transformReply

  • transformReply(): "OK"

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_count_min_sketch_INITBYPROB.html b/documentation/bloom/modules/commands_count_min_sketch_INITBYPROB.html index 5b0ab0e737..5ec9061996 100644 --- a/documentation/bloom/modules/commands_count_min_sketch_INITBYPROB.html +++ b/documentation/bloom/modules/commands_count_min_sketch_INITBYPROB.html @@ -1 +1 @@ -commands/count-min-sketch/INITBYPROB | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/INITBYPROB

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, error: number, probability: number): string[]

transformReply

  • transformReply(): "OK"

Generated using TypeDoc

\ No newline at end of file +commands/count-min-sketch/INITBYPROB | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/INITBYPROB

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, error: number, probability: number): string[]

transformReply

  • transformReply(): "OK"

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_count_min_sketch_MERGE.html b/documentation/bloom/modules/commands_count_min_sketch_MERGE.html index 3c8d581e1b..658b7c0f7f 100644 --- a/documentation/bloom/modules/commands_count_min_sketch_MERGE.html +++ b/documentation/bloom/modules/commands_count_min_sketch_MERGE.html @@ -1 +1 @@ -commands/count-min-sketch/MERGE | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/MERGE

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(dest: string, src: Sketches): string[]

transformReply

  • transformReply(): "OK"

Generated using TypeDoc

\ No newline at end of file +commands/count-min-sketch/MERGE | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/MERGE

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(dest: string, src: Sketches): string[]

transformReply

  • transformReply(): "OK"

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_count_min_sketch_QUERY.html b/documentation/bloom/modules/commands_count_min_sketch_QUERY.html index 2a073c9ced..b9276c8ede 100644 --- a/documentation/bloom/modules/commands_count_min_sketch_QUERY.html +++ b/documentation/bloom/modules/commands_count_min_sketch_QUERY.html @@ -1 +1 @@ -commands/count-min-sketch/QUERY | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/QUERY

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string, items: string | string[]): RedisCommandArguments

transformReply

  • transformReply(): number[]

Generated using TypeDoc

\ No newline at end of file +commands/count-min-sketch/QUERY | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/QUERY

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string, items: string | string[]): RedisCommandArguments

transformReply

  • transformReply(): number[]

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_cuckoo.html b/documentation/bloom/modules/commands_cuckoo.html index c24af2e08f..bcfe442c1e 100644 --- a/documentation/bloom/modules/commands_cuckoo.html +++ b/documentation/bloom/modules/commands_cuckoo.html @@ -1 +1 @@ -commands/cuckoo | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo

Index

Interfaces

Properties

Functions

Properties

default

default: { ADD: commands/cuckoo/ADD; ADDNX: commands/cuckoo/ADDNX; COUNT: commands/cuckoo/COUNT; DEL: commands/cuckoo/DEL; EXISTS: commands/cuckoo/EXISTS; INFO: commands/cuckoo/INFO; INSERT: commands/cuckoo/INSERT; INSERTNX: commands/cuckoo/INSERTNX; LOADCHUNK: commands/cuckoo/LOADCHUNK; RESERVE: commands/cuckoo/RESERVE; SCANDUMP: commands/cuckoo/SCANDUMP; add: commands/cuckoo/ADD; addNX: commands/cuckoo/ADDNX; count: commands/cuckoo/COUNT; del: commands/cuckoo/DEL; exists: commands/cuckoo/EXISTS; info: commands/cuckoo/INFO; insert: commands/cuckoo/INSERT; insertNX: commands/cuckoo/INSERTNX; loadChunk: commands/cuckoo/LOADCHUNK; reserve: commands/cuckoo/RESERVE; scanDump: commands/cuckoo/SCANDUMP }

Type declaration

Functions

pushInsertOptions

  • pushInsertOptions(args: RedisCommandArguments, items: string | string[], options?: InsertOptions): RedisCommandArguments

Generated using TypeDoc

\ No newline at end of file +commands/cuckoo | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo

Index

Interfaces

Properties

Functions

Properties

default

default: { ADD: commands/cuckoo/ADD; ADDNX: commands/cuckoo/ADDNX; COUNT: commands/cuckoo/COUNT; DEL: commands/cuckoo/DEL; EXISTS: commands/cuckoo/EXISTS; INFO: commands/cuckoo/INFO; INSERT: commands/cuckoo/INSERT; INSERTNX: commands/cuckoo/INSERTNX; LOADCHUNK: commands/cuckoo/LOADCHUNK; RESERVE: commands/cuckoo/RESERVE; SCANDUMP: commands/cuckoo/SCANDUMP; add: commands/cuckoo/ADD; addNX: commands/cuckoo/ADDNX; count: commands/cuckoo/COUNT; del: commands/cuckoo/DEL; exists: commands/cuckoo/EXISTS; info: commands/cuckoo/INFO; insert: commands/cuckoo/INSERT; insertNX: commands/cuckoo/INSERTNX; loadChunk: commands/cuckoo/LOADCHUNK; reserve: commands/cuckoo/RESERVE; scanDump: commands/cuckoo/SCANDUMP }

Type declaration

Functions

pushInsertOptions

  • pushInsertOptions(args: RedisCommandArguments, items: string | string[], options?: InsertOptions): RedisCommandArguments

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_cuckoo_ADD.html b/documentation/bloom/modules/commands_cuckoo_ADD.html index 288ac50dce..d10d2a7aeb 100644 --- a/documentation/bloom/modules/commands_cuckoo_ADD.html +++ b/documentation/bloom/modules/commands_cuckoo_ADD.html @@ -1 +1 @@ -commands/cuckoo/ADD | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/ADD

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, item: string): string[]

Generated using TypeDoc

\ No newline at end of file +commands/cuckoo/ADD | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/ADD

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, item: string): string[]

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_cuckoo_ADDNX.html b/documentation/bloom/modules/commands_cuckoo_ADDNX.html index a294f60a3b..2fda2de9cd 100644 --- a/documentation/bloom/modules/commands_cuckoo_ADDNX.html +++ b/documentation/bloom/modules/commands_cuckoo_ADDNX.html @@ -1 +1 @@ -commands/cuckoo/ADDNX | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/ADDNX

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, item: string): string[]

Generated using TypeDoc

\ No newline at end of file +commands/cuckoo/ADDNX | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/ADDNX

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, item: string): string[]

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_cuckoo_COUNT.html b/documentation/bloom/modules/commands_cuckoo_COUNT.html index 134d642eb2..a129065625 100644 --- a/documentation/bloom/modules/commands_cuckoo_COUNT.html +++ b/documentation/bloom/modules/commands_cuckoo_COUNT.html @@ -1 +1 @@ -commands/cuckoo/COUNT | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/COUNT

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, item: string): string[]

transformReply

  • transformReply(): number

Generated using TypeDoc

\ No newline at end of file +commands/cuckoo/COUNT | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/COUNT

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, item: string): string[]

transformReply

  • transformReply(): number

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_cuckoo_DEL.html b/documentation/bloom/modules/commands_cuckoo_DEL.html index 9edeb3a364..324a3b2bb1 100644 --- a/documentation/bloom/modules/commands_cuckoo_DEL.html +++ b/documentation/bloom/modules/commands_cuckoo_DEL.html @@ -1 +1 @@ -commands/cuckoo/DEL | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/DEL

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, item: string): string[]

Generated using TypeDoc

\ No newline at end of file +commands/cuckoo/DEL | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/DEL

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, item: string): string[]

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_cuckoo_EXISTS.html b/documentation/bloom/modules/commands_cuckoo_EXISTS.html index 0b2b05beab..9be3ee6b1e 100644 --- a/documentation/bloom/modules/commands_cuckoo_EXISTS.html +++ b/documentation/bloom/modules/commands_cuckoo_EXISTS.html @@ -1 +1 @@ -commands/cuckoo/EXISTS | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/EXISTS

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string, item: string): string[]

Generated using TypeDoc

\ No newline at end of file +commands/cuckoo/EXISTS | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/EXISTS

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string, item: string): string[]

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_cuckoo_INFO.html b/documentation/bloom/modules/commands_cuckoo_INFO.html index 5207e0ce44..b77da6d7ad 100644 --- a/documentation/bloom/modules/commands_cuckoo_INFO.html +++ b/documentation/bloom/modules/commands_cuckoo_INFO.html @@ -1 +1 @@ -commands/cuckoo/INFO | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/INFO

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

InfoRawReply

InfoRawReply: [_: string, size: number, _: string, numberOfBuckets: number, _: string, numberOfFilters: number, _: string, numberOfInsertedItems: number, _: string, numberOfDeletedItems: number, _: string, bucketSize: number, _: string, expansionRate: number, _: string, maxIteration: number]

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string): string[]

transformReply

Generated using TypeDoc

\ No newline at end of file +commands/cuckoo/INFO | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/INFO

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

InfoRawReply

InfoRawReply: [_: string, size: number, _: string, numberOfBuckets: number, _: string, numberOfFilters: number, _: string, numberOfInsertedItems: number, _: string, numberOfDeletedItems: number, _: string, bucketSize: number, _: string, expansionRate: number, _: string, maxIteration: number]

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string): string[]

transformReply

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_cuckoo_INSERT.html b/documentation/bloom/modules/commands_cuckoo_INSERT.html index 59c36dd572..8ae05b761a 100644 --- a/documentation/bloom/modules/commands_cuckoo_INSERT.html +++ b/documentation/bloom/modules/commands_cuckoo_INSERT.html @@ -1 +1 @@ -commands/cuckoo/INSERT | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/INSERT

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, items: string | string[], options?: InsertOptions): RedisCommandArguments

Generated using TypeDoc

\ No newline at end of file +commands/cuckoo/INSERT | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/INSERT

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, items: string | string[], options?: InsertOptions): RedisCommandArguments

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_cuckoo_INSERTNX.html b/documentation/bloom/modules/commands_cuckoo_INSERTNX.html index 08010666b6..9ad349af25 100644 --- a/documentation/bloom/modules/commands_cuckoo_INSERTNX.html +++ b/documentation/bloom/modules/commands_cuckoo_INSERTNX.html @@ -1 +1 @@ -commands/cuckoo/INSERTNX | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/INSERTNX

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, items: string | string[], options?: InsertOptions): RedisCommandArguments

Generated using TypeDoc

\ No newline at end of file +commands/cuckoo/INSERTNX | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/INSERTNX

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, items: string | string[], options?: InsertOptions): RedisCommandArguments

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_cuckoo_LOADCHUNK.html b/documentation/bloom/modules/commands_cuckoo_LOADCHUNK.html index 67aaf533e9..a91c0cf506 100644 --- a/documentation/bloom/modules/commands_cuckoo_LOADCHUNK.html +++ b/documentation/bloom/modules/commands_cuckoo_LOADCHUNK.html @@ -1 +1 @@ -commands/cuckoo/LOADCHUNK | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/LOADCHUNK

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, iterator: number, chunk: RedisCommandArgument): RedisCommandArguments

transformReply

  • transformReply(): "OK"

Generated using TypeDoc

\ No newline at end of file +commands/cuckoo/LOADCHUNK | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/LOADCHUNK

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, iterator: number, chunk: RedisCommandArgument): RedisCommandArguments

transformReply

  • transformReply(): "OK"

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_cuckoo_RESERVE.html b/documentation/bloom/modules/commands_cuckoo_RESERVE.html index a995d6d4f3..c47faddb6f 100644 --- a/documentation/bloom/modules/commands_cuckoo_RESERVE.html +++ b/documentation/bloom/modules/commands_cuckoo_RESERVE.html @@ -1 +1 @@ -commands/cuckoo/RESERVE | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/RESERVE

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, capacity: number, options?: ReserveOptions): string[]

transformReply

  • transformReply(): "OK"

Generated using TypeDoc

\ No newline at end of file +commands/cuckoo/RESERVE | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/RESERVE

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, capacity: number, options?: ReserveOptions): string[]

transformReply

  • transformReply(): "OK"

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_cuckoo_SCANDUMP.html b/documentation/bloom/modules/commands_cuckoo_SCANDUMP.html index ce98e525fb..7b1837e253 100644 --- a/documentation/bloom/modules/commands_cuckoo_SCANDUMP.html +++ b/documentation/bloom/modules/commands_cuckoo_SCANDUMP.html @@ -1 +1 @@ -commands/cuckoo/SCANDUMP | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/SCANDUMP

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, iterator: number): string[]

transformReply

  • transformReply(__namedParameters: ScanDumpRawReply): ScanDumpReply

Generated using TypeDoc

\ No newline at end of file +commands/cuckoo/SCANDUMP | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/SCANDUMP

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, iterator: number): string[]

transformReply

  • transformReply(__namedParameters: ScanDumpRawReply): ScanDumpReply

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_top_k_ADD.html b/documentation/bloom/modules/commands_top_k_ADD.html index ed2768c413..48d0bdf8d8 100644 --- a/documentation/bloom/modules/commands_top_k_ADD.html +++ b/documentation/bloom/modules/commands_top_k_ADD.html @@ -1 +1 @@ -commands/top-k/ADD | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/ADD

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, items: string | string[]): RedisCommandArguments

transformReply

  • transformReply(): (null | string)[]

Generated using TypeDoc

\ No newline at end of file +commands/top-k/ADD | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/ADD

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, items: string | string[]): RedisCommandArguments

transformReply

  • transformReply(): (null | string)[]

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_top_k_COUNT.html b/documentation/bloom/modules/commands_top_k_COUNT.html index de7f9e552f..49a780a124 100644 --- a/documentation/bloom/modules/commands_top_k_COUNT.html +++ b/documentation/bloom/modules/commands_top_k_COUNT.html @@ -1 +1 @@ -commands/top-k/COUNT | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/COUNT

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string, items: string | string[]): RedisCommandArguments

transformReply

  • transformReply(): number[]

Generated using TypeDoc

\ No newline at end of file +commands/top-k/COUNT | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/COUNT

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string, items: string | string[]): RedisCommandArguments

transformReply

  • transformReply(): number[]

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_top_k_INCRBY.html b/documentation/bloom/modules/commands_top_k_INCRBY.html index e44b466874..71b328cb21 100644 --- a/documentation/bloom/modules/commands_top_k_INCRBY.html +++ b/documentation/bloom/modules/commands_top_k_INCRBY.html @@ -1 +1 @@ -commands/top-k/INCRBY | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/INCRBY

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, items: IncrByItem | IncrByItem[]): string[]

transformReply

  • transformReply(): (string | null)[]

Generated using TypeDoc

\ No newline at end of file +commands/top-k/INCRBY | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/INCRBY

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, items: IncrByItem | IncrByItem[]): string[]

transformReply

  • transformReply(): (string | null)[]

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_top_k_INFO.html b/documentation/bloom/modules/commands_top_k_INFO.html index 0811643236..b1c5f74808 100644 --- a/documentation/bloom/modules/commands_top_k_INFO.html +++ b/documentation/bloom/modules/commands_top_k_INFO.html @@ -1 +1 @@ -commands/top-k/INFO | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/INFO

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

InfoRawReply

InfoRawReply: [_: string, k: number, _: string, width: number, _: string, depth: number, _: string, decay: string]

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string): string[]

transformReply

Generated using TypeDoc

\ No newline at end of file +commands/top-k/INFO | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/INFO

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

InfoRawReply

InfoRawReply: [_: string, k: number, _: string, width: number, _: string, depth: number, _: string, decay: string]

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string): string[]

transformReply

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_top_k_LIST.html b/documentation/bloom/modules/commands_top_k_LIST.html index 40b9120b88..7e40671860 100644 --- a/documentation/bloom/modules/commands_top_k_LIST.html +++ b/documentation/bloom/modules/commands_top_k_LIST.html @@ -1 +1 @@ -commands/top-k/LIST | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/LIST

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string): string[]

transformReply

  • transformReply(): (string | null)[]

Generated using TypeDoc

\ No newline at end of file +commands/top-k/LIST | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/LIST

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string): string[]

transformReply

  • transformReply(): (string | null)[]

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_top_k_QUERY.html b/documentation/bloom/modules/commands_top_k_QUERY.html index 91d517c748..df2551eff7 100644 --- a/documentation/bloom/modules/commands_top_k_QUERY.html +++ b/documentation/bloom/modules/commands_top_k_QUERY.html @@ -1 +1 @@ -commands/top-k/QUERY | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/QUERY

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string, items: string | string[]): RedisCommandArguments

transformReply

  • transformReply(): number[]

Generated using TypeDoc

\ No newline at end of file +commands/top-k/QUERY | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/QUERY

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string, items: string | string[]): RedisCommandArguments

transformReply

  • transformReply(): number[]

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_top_k_RESERVE.html b/documentation/bloom/modules/commands_top_k_RESERVE.html index 3886ec01e4..966bbda534 100644 --- a/documentation/bloom/modules/commands_top_k_RESERVE.html +++ b/documentation/bloom/modules/commands_top_k_RESERVE.html @@ -1 +1 @@ -commands/top-k/RESERVE | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/RESERVE

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, topK: number, options?: ReserveOptions): string[]

transformReply

  • transformReply(): "OK"

Generated using TypeDoc

\ No newline at end of file +commands/top-k/RESERVE | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/RESERVE

Index

Variables

Functions

Variables

FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Functions

transformArguments

  • transformArguments(key: string, topK: number, options?: ReserveOptions): string[]

transformReply

  • transformReply(): "OK"

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/test_utils.html b/documentation/bloom/modules/test_utils.html index 03958322a9..bd662d8e5c 100644 --- a/documentation/bloom/modules/test_utils.html +++ b/documentation/bloom/modules/test_utils.html @@ -1 +1 @@ -test-utils | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module test-utils

Index

Properties

Variables

Properties

default

default: default

Variables

GLOBAL

GLOBAL: { SERVERS: { OPEN: { clientOptions: { modules: { bf: { ADD: commands/bloom/ADD; EXISTS: commands/bloom/EXISTS; INFO: commands/bloom/INFO; INSERT: commands/bloom/INSERT; LOADCHUNK: commands/bloom/LOADCHUNK; MADD: commands/bloom/MADD; MEXISTS: commands/bloom/MEXISTS; RESERVE: commands/bloom/RESERVE; SCANDUMP: commands/bloom/SCANDUMP; add: commands/bloom/ADD; exists: commands/bloom/EXISTS; info: commands/bloom/INFO; insert: commands/bloom/INSERT; loadChunk: commands/bloom/LOADCHUNK; mAdd: commands/bloom/MADD; mExists: commands/bloom/MEXISTS; reserve: commands/bloom/RESERVE; scanDump: commands/bloom/SCANDUMP }; cf: { ADD: commands/cuckoo/ADD; ADDNX: commands/cuckoo/ADDNX; COUNT: commands/cuckoo/COUNT; DEL: commands/cuckoo/DEL; EXISTS: commands/cuckoo/EXISTS; INFO: commands/cuckoo/INFO; INSERT: commands/cuckoo/INSERT; INSERTNX: commands/cuckoo/INSERTNX; LOADCHUNK: commands/cuckoo/LOADCHUNK; RESERVE: commands/cuckoo/RESERVE; SCANDUMP: commands/cuckoo/SCANDUMP; add: commands/cuckoo/ADD; addNX: commands/cuckoo/ADDNX; count: commands/cuckoo/COUNT; del: commands/cuckoo/DEL; exists: commands/cuckoo/EXISTS; info: commands/cuckoo/INFO; insert: commands/cuckoo/INSERT; insertNX: commands/cuckoo/INSERTNX; loadChunk: commands/cuckoo/LOADCHUNK; reserve: commands/cuckoo/RESERVE; scanDump: commands/cuckoo/SCANDUMP }; cms: { INCRBY: commands/count-min-sketch/INCRBY; INFO: commands/count-min-sketch/INFO; INITBYDIM: commands/count-min-sketch/INITBYDIM; INITBYPROB: commands/count-min-sketch/INITBYPROB; MERGE: commands/count-min-sketch/MERGE; QUERY: commands/count-min-sketch/QUERY; incrBy: commands/count-min-sketch/INCRBY; info: commands/count-min-sketch/INFO; initByDim: commands/count-min-sketch/INITBYDIM; initByProb: commands/count-min-sketch/INITBYPROB; merge: commands/count-min-sketch/MERGE; query: commands/count-min-sketch/QUERY }; topK: { ADD: commands/top-k/ADD; COUNT: commands/top-k/COUNT; INCRBY: commands/top-k/INCRBY; INFO: commands/top-k/INFO; LIST: commands/top-k/LIST; QUERY: commands/top-k/QUERY; RESERVE: commands/top-k/RESERVE; add: commands/top-k/ADD; count: commands/top-k/COUNT; incrBy: commands/top-k/INCRBY; info: commands/top-k/INFO; list: commands/top-k/LIST; query: commands/top-k/QUERY; reserve: commands/top-k/RESERVE } } }; serverArguments: string[] } } } = ...

Type declaration

Generated using TypeDoc

\ No newline at end of file +test-utils | @node-redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module test-utils

Index

Properties

Variables

Properties

default

default: default

Variables

GLOBAL

GLOBAL: { SERVERS: { OPEN: { clientOptions: { modules: { bf: { ADD: commands/bloom/ADD; EXISTS: commands/bloom/EXISTS; INFO: commands/bloom/INFO; INSERT: commands/bloom/INSERT; LOADCHUNK: commands/bloom/LOADCHUNK; MADD: commands/bloom/MADD; MEXISTS: commands/bloom/MEXISTS; RESERVE: commands/bloom/RESERVE; SCANDUMP: commands/bloom/SCANDUMP; add: commands/bloom/ADD; exists: commands/bloom/EXISTS; info: commands/bloom/INFO; insert: commands/bloom/INSERT; loadChunk: commands/bloom/LOADCHUNK; mAdd: commands/bloom/MADD; mExists: commands/bloom/MEXISTS; reserve: commands/bloom/RESERVE; scanDump: commands/bloom/SCANDUMP }; cf: { ADD: commands/cuckoo/ADD; ADDNX: commands/cuckoo/ADDNX; COUNT: commands/cuckoo/COUNT; DEL: commands/cuckoo/DEL; EXISTS: commands/cuckoo/EXISTS; INFO: commands/cuckoo/INFO; INSERT: commands/cuckoo/INSERT; INSERTNX: commands/cuckoo/INSERTNX; LOADCHUNK: commands/cuckoo/LOADCHUNK; RESERVE: commands/cuckoo/RESERVE; SCANDUMP: commands/cuckoo/SCANDUMP; add: commands/cuckoo/ADD; addNX: commands/cuckoo/ADDNX; count: commands/cuckoo/COUNT; del: commands/cuckoo/DEL; exists: commands/cuckoo/EXISTS; info: commands/cuckoo/INFO; insert: commands/cuckoo/INSERT; insertNX: commands/cuckoo/INSERTNX; loadChunk: commands/cuckoo/LOADCHUNK; reserve: commands/cuckoo/RESERVE; scanDump: commands/cuckoo/SCANDUMP }; cms: { INCRBY: commands/count-min-sketch/INCRBY; INFO: commands/count-min-sketch/INFO; INITBYDIM: commands/count-min-sketch/INITBYDIM; INITBYPROB: commands/count-min-sketch/INITBYPROB; MERGE: commands/count-min-sketch/MERGE; QUERY: commands/count-min-sketch/QUERY; incrBy: commands/count-min-sketch/INCRBY; info: commands/count-min-sketch/INFO; initByDim: commands/count-min-sketch/INITBYDIM; initByProb: commands/count-min-sketch/INITBYPROB; merge: commands/count-min-sketch/MERGE; query: commands/count-min-sketch/QUERY }; topK: { ADD: commands/top-k/ADD; COUNT: commands/top-k/COUNT; INCRBY: commands/top-k/INCRBY; INFO: commands/top-k/INFO; LIST: commands/top-k/LIST; QUERY: commands/top-k/QUERY; RESERVE: commands/top-k/RESERVE; add: commands/top-k/ADD; count: commands/top-k/COUNT; incrBy: commands/top-k/INCRBY; info: commands/top-k/INFO; list: commands/top-k/LIST; query: commands/top-k/QUERY; reserve: commands/top-k/RESERVE } } }; serverArguments: string[] } } } = ...

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/client/classes/lib_client.default.html b/documentation/client/classes/lib_client.default.html index 70f6e81da9..0762f255e6 100644 --- a/documentation/client/classes/lib_client.default.html +++ b/documentation/client/classes/lib_client.default.html @@ -1,4 +1,4 @@ -default | @node-redis/client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default<M, S>

Type parameters

Hierarchy

  • EventEmitter
    • default

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Readonly #isolationPool

#isolationPool: Pool<RedisClientType<M, S>>

Private Optional Readonly #options

#options?: RedisClientOptions<M, S>

Private Readonly #queue

#queue: default

Private #selectedDB

#selectedDB: number = 0

Private Readonly #socket

#socket: default

Private Readonly #v4

#v4: Record<string, any> = {}

commandOptions

commandOptions: <T>(options: T) => CommandOptions<T> = RedisClient.commandOptions

Type declaration

pSubscribe

pSubscribe: <T>(patterns: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T) => Promise<void> = ...

Type declaration

    • <T>(patterns: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

    • Type parameters

      • T: boolean = false

      Parameters

      • patterns: string | string[]
      • listener: PubSubListener<T, T extends true ? Buffer : string>
      • Optional bufferMode: T

      Returns Promise<void>

pUnsubscribe

pUnsubscribe: <T>(patterns?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T) => Promise<void> = ...

Type declaration

    • <T>(patterns?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

    • Type parameters

      • T: boolean = false

      Parameters

      • Optional patterns: string | string[]
      • Optional listener: PubSubListener<T, T extends true ? Buffer : string>
      • Optional bufferMode: T

      Returns Promise<void>

quit

quit: () => Promise<void> = ...

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

select

select: { (db: number): Promise<void>; (options: CommandOptions<ClientCommandOptions>, db: number): Promise<void> } = ...

Type declaration

subscribe

subscribe: <T>(channels: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T) => Promise<void> = ...

Type declaration

    • <T>(channels: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

    • Type parameters

      • T: boolean = false

      Parameters

      • channels: string | string[]
      • listener: PubSubListener<T, T extends true ? Buffer : string>
      • Optional bufferMode: T

      Returns Promise<void>

unsubscribe

unsubscribe: <T>(channels?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T) => Promise<void> = ...

Type declaration

    • <T>(channels?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

    • Type parameters

      • T: boolean = false

      Parameters

      • Optional channels: string | string[]
      • Optional listener: PubSubListener<T, T extends true ? Buffer : string>
      • Optional bufferMode: T

      Returns Promise<void>

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean
+default | @node-redis/client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default<M, S>

Type parameters

Hierarchy

  • EventEmitter
    • default

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Readonly #isolationPool

#isolationPool: Pool<RedisClientType<M, S>>

Private Optional Readonly #options

#options?: RedisClientOptions<M, S>

Private Readonly #queue

#queue: default

Private #selectedDB

#selectedDB: number = 0

Private Readonly #socket

#socket: default

Private Readonly #v4

#v4: Record<string, any> = {}

commandOptions

commandOptions: <T>(options: T) => CommandOptions<T> = RedisClient.commandOptions

Type declaration

pSubscribe

pSubscribe: <T>(patterns: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T) => Promise<void> = ...

Type declaration

    • <T>(patterns: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

    • Type parameters

      • T: boolean = false

      Parameters

      • patterns: string | string[]
      • listener: PubSubListener<T, T extends true ? Buffer : string>
      • Optional bufferMode: T

      Returns Promise<void>

pUnsubscribe

pUnsubscribe: <T>(patterns?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T) => Promise<void> = ...

Type declaration

    • <T>(patterns?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

    • Type parameters

      • T: boolean = false

      Parameters

      • Optional patterns: string | string[]
      • Optional listener: PubSubListener<T, T extends true ? Buffer : string>
      • Optional bufferMode: T

      Returns Promise<void>

quit

quit: () => Promise<void> = ...

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

select

select: { (db: number): Promise<void>; (options: CommandOptions<ClientCommandOptions>, db: number): Promise<void> } = ...

Type declaration

subscribe

subscribe: <T>(channels: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T) => Promise<void> = ...

Type declaration

    • <T>(channels: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

    • Type parameters

      • T: boolean = false

      Parameters

      • channels: string | string[]
      • listener: PubSubListener<T, T extends true ? Buffer : string>
      • Optional bufferMode: T

      Returns Promise<void>

unsubscribe

unsubscribe: <T>(channels?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T) => Promise<void> = ...

Type declaration

    • <T>(channels?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

    • Type parameters

      • T: boolean = false

      Parameters

      • Optional channels: string | string[]
      • Optional listener: PubSubListener<T, T extends true ? Buffer : string>
      • Optional bufferMode: T

      Returns Promise<void>

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' @@ -7,10 +7,10 @@ events. Listeners installed using this symbol are called before the regular

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

-

Accessors

isOpen

  • get isOpen(): boolean

options

v4

  • get v4(): Record<string, any>

Methods

Private #defineLegacyCommand

  • #defineLegacyCommand(name: string): void

Private #destroyIsolationPool

  • #destroyIsolationPool(): Promise<void>

Private #initiateOptions

Private #initiateQueue

Private #initiateSocket

Private #legacyMode

  • #legacyMode(): void

Private #sendCommand

Private #subscribe

Private #tick

  • #tick(force?: boolean): void

Private #unsubscribe

PSUBSCRIBE

  • PSUBSCRIBE<T>(patterns: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

PUNSUBSCRIBE

  • PUNSUBSCRIBE<T>(patterns?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

QUIT

  • QUIT(): Promise<void>

SELECT

SUBSCRIBE

  • SUBSCRIBE<T>(channels: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

UNSUBSCRIBE

  • UNSUBSCRIBE<T>(channels?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

addListener

  • addListener(eventName: string | symbol, listener: (...args: any[]) => void): default<M, S>
  • +

Accessors

isOpen

  • get isOpen(): boolean

options

v4

  • get v4(): Record<string, any>

Methods

Private #defineLegacyCommand

  • #defineLegacyCommand(name: string): void

Private #destroyIsolationPool

  • #destroyIsolationPool(): Promise<void>

Private #initiateOptions

Private #initiateQueue

Private #initiateSocket

Private #legacyMode

  • #legacyMode(): void

Private #sendCommand

Private #subscribe

Private #tick

  • #tick(force?: boolean): void

Private #unsubscribe

PSUBSCRIBE

  • PSUBSCRIBE<T>(patterns: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

PUNSUBSCRIBE

  • PUNSUBSCRIBE<T>(patterns?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

QUIT

  • QUIT(): Promise<void>

SELECT

SUBSCRIBE

  • SUBSCRIBE<T>(channels: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

UNSUBSCRIBE

  • UNSUBSCRIBE<T>(channels?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

addListener

  • addListener(eventName: string | symbol, listener: (...args: any[]) => void): default<M, S>

  • Alias for emitter.on(eventName, listener).

    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default<M, S>

commandsExecutor

connect

  • connect(): Promise<void>

disconnect

  • disconnect(): Promise<void>

duplicate

emit

  • emit(eventName: string | symbol, ...args: any[]): boolean
  • +

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default<M, S>

commandsExecutor

connect

  • connect(): Promise<void>

disconnect

  • disconnect(): Promise<void>

duplicate

emit

  • emit(eventName: string | symbol, ...args: any[]): boolean

  • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

    @@ -23,11 +23,11 @@ listeners. The values in the array are strings or Symbols.

    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
    since

    v6.0.0

    -

    Returns (string | symbol)[]

executeIsolated

  • executeIsolated<T>(fn: (client: RedisClientType<M, S>) => T | Promise<T>): Promise<T>

executeScript

getMaxListeners

  • getMaxListeners(): number
  • +

    Returns (string | symbol)[]

executeIsolated

  • executeIsolated<T>(fn: (client: RedisClientType<M, S>) => T | Promise<T>): Promise<T>

executeScript

getMaxListeners

  • getMaxListeners(): number

  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    since

    v1.0.0

    -

    Returns number

hScanIterator

  • hScanIterator(key: string, options?: ScanOptions): AsyncIterable<{ field: string; value: string }>

listenerCount

  • listenerCount(eventName: string | symbol): number
  • +

    Returns number

hScanIterator

  • hScanIterator(key: string, options?: ScanOptions): AsyncIterable<{ field: string; value: string }>

listenerCount

  • listenerCount(eventName: string | symbol): number

multi

multiExecutor

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): default<M, S>
  • +

    Parameters

    • eventName: string | symbol

    Returns Function[]

multi

multiExecutor

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): default<M, S>

  • Alias for emitter.removeListener().

    since

    v10.0.0

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default<M, S>

on

  • on(eventName: string | symbol, listener: (...args: any[]) => void): default<M, S>
  • @@ -134,14 +134,14 @@ recently added instance. In the example the once('ping')lis

    Returns a reference to the EventEmitter, so that calls can be chained.

    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default<M, S>

sScanIterator

  • sScanIterator(key: string, options?: ScanOptions): AsyncIterable<string>

scanIterator

scriptsExecutor

sendCommand

setMaxListeners

  • setMaxListeners(n: number): default<M, S>
  • +

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default<M, S>

sScanIterator

  • sScanIterator(key: string, options?: ScanOptions): AsyncIterable<string>

scanIterator

scriptsExecutor

sendCommand

setMaxListeners

  • setMaxListeners(n: number): default<M, S>

  • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter, so that calls can be chained.

    since

    v0.3.5

    -

    Parameters

    • n: number

    Returns default<M, S>

zScanIterator

  • zScanIterator(key: string, options?: ScanOptions): AsyncIterable<{ score: number; value: string }>

Static commandOptions

Static create

Static extend

Static getEventListeners

  • getEventListeners(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]
  • +

    Parameters

    • n: number

    Returns default<M, S>

zScanIterator

  • zScanIterator(key: string, options?: ScanOptions): AsyncIterable<{ score: number; value: string }>

Static commandOptions

Static create

Static extend

Static getEventListeners

  • getEventListeners(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]

  • Returns a copy of the array of listeners for the event named eventName.

    For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

    @@ -202,4 +202,4 @@ special handling:

    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
    since

    v11.13.0, v10.16.0

    -

    Parameters

    • emitter: NodeEventTarget
    • eventName: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • eventName: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

Static parseURL

Legend

  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Type alias with type parameter
  • Class
  • Class with type parameter
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Private property
  • Private method
  • Enumeration
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • emitter: NodeEventTarget
  • eventName: string | symbol
  • Optional options: StaticEventEmitterOptions

Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • eventName: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

    • Static parseURL

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/client/classes/lib_client_commands_queue.default.html b/documentation/client/classes/lib_client_commands_queue.default.html index 911be3a3fb..56f6146641 100644 --- a/documentation/client/classes/lib_client_commands_queue.default.html +++ b/documentation/client/classes/lib_client_commands_queue.default.html @@ -1 +1 @@ -default | @node-redis/client
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class default

    Hierarchy

    • default

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new default(maxLength: undefined | null | number): default

    Properties

    Private #chainInExecution

    #chainInExecution: undefined | symbol

    Private Readonly #maxLength

    #maxLength: undefined | null | number

    Private Readonly #parser

    #parser: any = ...

    Private #pubSubState

    #pubSubState: undefined | PubSubState

    Private Readonly #waitingForReply

    #waitingForReply: Yallist<CommandWaitingForReply> = ...

    Private Readonly #waitingToBeSent

    #waitingToBeSent: Yallist<CommandWaitingToBeSent> = ...

    Static Private Readonly #PUB_SUB_MESSAGES

    #PUB_SUB_MESSAGES: { message: Buffer; pMessage: Buffer; pSubscribe: Buffer; pUnsubscribe: Buffer; subscribe: Buffer; unsubscribe: Buffer } = ...

    Type declaration

    • message: Buffer
    • pMessage: Buffer
    • pSubscribe: Buffer
    • pUnsubscribe: Buffer
    • subscribe: Buffer
    • unsubscribe: Buffer

    Methods

    Private #initiatePubSubState

    • #initiatePubSubState(): PubSubState

    Private #pushPubSubCommand

    Private #setReturnBuffers

    • #setReturnBuffers(): void

    Private #shiftWaitingForReply

    • #shiftWaitingForReply(): CommandWaitingForReply

    addCommand

    flushAll

    • flushAll(err: Error): void

    flushWaitingForReply

    • flushWaitingForReply(err: Error): void

    getCommandToSend

    parseResponse

    • parseResponse(data: Buffer): void

    resubscribe

    • resubscribe(): undefined | Promise<any>

    subscribe

    unsubscribe

    Static Private #emitPubSubMessage

    • #emitPubSubMessage(listenersMap: PubSubListenersMap, message: Buffer, channel: Buffer, pattern?: Buffer): void

    Static Private #flushQueue

    • #flushQueue<T>(queue: Yallist<T>, err: Error): void

    Generated using TypeDoc

    \ No newline at end of file +default | @node-redis/client
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class default

    Hierarchy

    • default

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new default(maxLength: undefined | null | number): default

    Properties

    Private #chainInExecution

    #chainInExecution: undefined | symbol

    Private Readonly #maxLength

    #maxLength: undefined | null | number

    Private Readonly #parser

    #parser: any = ...

    Private #pubSubState

    #pubSubState: undefined | PubSubState

    Private Readonly #waitingForReply

    #waitingForReply: Yallist<CommandWaitingForReply> = ...

    Private Readonly #waitingToBeSent

    #waitingToBeSent: Yallist<CommandWaitingToBeSent> = ...

    Static Private Readonly #PUB_SUB_MESSAGES

    #PUB_SUB_MESSAGES: { message: Buffer; pMessage: Buffer; pSubscribe: Buffer; pUnsubscribe: Buffer; subscribe: Buffer; unsubscribe: Buffer } = ...

    Type declaration

    • message: Buffer
    • pMessage: Buffer
    • pSubscribe: Buffer
    • pUnsubscribe: Buffer
    • subscribe: Buffer
    • unsubscribe: Buffer

    Methods

    Private #initiatePubSubState

    • #initiatePubSubState(): PubSubState

    Private #pushPubSubCommand

    Private #setReturnBuffers

    • #setReturnBuffers(): void

    Private #shiftWaitingForReply

    • #shiftWaitingForReply(): CommandWaitingForReply

    addCommand

    flushAll

    • flushAll(err: Error): void

    flushWaitingForReply

    • flushWaitingForReply(err: Error): void

    getCommandToSend

    parseResponse

    • parseResponse(data: Buffer): void

    resubscribe

    • resubscribe(): undefined | Promise<any>

    subscribe

    unsubscribe

    Static Private #emitPubSubMessage

    • #emitPubSubMessage(listenersMap: PubSubListenersMap, message: Buffer, channel: Buffer, pattern?: Buffer): void

    Static Private #flushQueue

    • #flushQueue<T>(queue: Yallist<T>, err: Error): void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/client/classes/lib_client_multi_command.default.html b/documentation/client/classes/lib_client_multi_command.default.html index 8fbd372f63..4353ed98d4 100644 --- a/documentation/client/classes/lib_client_multi_command.default.html +++ b/documentation/client/classes/lib_client_multi_command.default.html @@ -1 +1 @@ -default | @node-redis/client
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class default

    Hierarchy

    • default

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    Properties

    Private Readonly #executor

    #executor: RedisClientMultiExecutor

    Private Readonly #multi

    #multi: default = ...

    EXEC

    EXEC: (execAsPipeline?: boolean) => Promise<RedisCommandRawReply[]> = ...

    Type declaration

    Readonly v4

    v4: Record<string, any> = {}

    Methods

    Private #defineLegacyCommand

    • #defineLegacyCommand(name: string): void

    Private #legacyMode

    • #legacyMode(): void

    addCommand

    commandsExecutor

    exec

    execAsPipeline

    scriptsExecutor

    Static extend

    Generated using TypeDoc

    \ No newline at end of file +default | @node-redis/client
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class default

    Hierarchy

    • default

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    Properties

    Private Readonly #executor

    #executor: RedisClientMultiExecutor

    Private Readonly #multi

    #multi: default = ...

    EXEC

    EXEC: (execAsPipeline?: boolean) => Promise<RedisCommandRawReply[]> = ...

    Type declaration

    Readonly v4

    v4: Record<string, any> = {}

    Methods

    Private #defineLegacyCommand

    • #defineLegacyCommand(name: string): void

    Private #legacyMode

    • #legacyMode(): void

    addCommand

    commandsExecutor

    exec

    execAsPipeline

    scriptsExecutor

    Static extend

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/client/classes/lib_client_socket.default.html b/documentation/client/classes/lib_client_socket.default.html index 8b9edd53ec..bc17b87c36 100644 --- a/documentation/client/classes/lib_client_socket.default.html +++ b/documentation/client/classes/lib_client_socket.default.html @@ -1,4 +1,4 @@ -default | @node-redis/client
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class default

    Hierarchy

    • EventEmitter
      • default

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    Private Optional Readonly #initiator

    #initiator?: RedisSocketInitiator

    Private #isCorked

    #isCorked: boolean = false

    Private #isOpen

    #isOpen: boolean = false

    Private #isReady

    #isReady: boolean = false

    Private Readonly #options

    #options: RedisSocketOptions

    Private Optional #socket

    #socket?: Socket | TLSSocket

    Private #writableNeedDrain

    #writableNeedDrain: boolean = false

    Static Readonly captureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol

    Static captureRejections

    captureRejections: boolean
    +default | @node-redis/client
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class default

    Hierarchy

    • EventEmitter
      • default

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    Private Optional Readonly #initiator

    #initiator?: RedisSocketInitiator

    Private #isCorked

    #isCorked: boolean = false

    Private #isOpen

    #isOpen: boolean = false

    Private #isReady

    #isReady: boolean = false

    Private Readonly #options

    #options: RedisSocketOptions

    Private Optional #socket

    #socket?: Socket | TLSSocket

    Private #writableNeedDrain

    #writableNeedDrain: boolean = false

    Static Readonly captureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol

    Static captureRejections

    captureRejections: boolean

    Sets or gets the default captureRejection value for all emitters.

    Static defaultMaxListeners

    defaultMaxListeners: number

    Static Readonly errorMonitor

    errorMonitor: typeof errorMonitor

    This symbol shall be used to install a listener for only monitoring 'error' @@ -7,10 +7,10 @@ events. Listeners installed using this symbol are called before the regular

    Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

    -

    Accessors

    isOpen

    • get isOpen(): boolean

    isReady

    • get isReady(): boolean

    writableNeedDrain

    • get writableNeedDrain(): boolean

    Methods

    Private #connect

    • #connect(hadError?: boolean): Promise<void>

    Private #createNetSocket

    • #createNetSocket(): CreateSocketReturn<Socket>

    Private #createSocket

    • #createSocket(): Promise<Socket | TLSSocket>

    Private #createTlsSocket

    • #createTlsSocket(): CreateSocketReturn<TLSSocket>

    Private #onSocketError

    • #onSocketError(err: Error): void

    Private #retryConnection

    • #retryConnection(retries: number, hadError?: boolean): Promise<Socket | TLSSocket>

    addListener

    • addListener(eventName: string | symbol, listener: (...args: any[]) => void): default
    • +

    Accessors

    isOpen

    • get isOpen(): boolean

    isReady

    • get isReady(): boolean

    writableNeedDrain

    • get writableNeedDrain(): boolean

    Methods

    Private #connect

    • #connect(hadError?: boolean): Promise<void>

    Private #createNetSocket

    • #createNetSocket(): CreateSocketReturn<Socket>

    Private #createSocket

    • #createSocket(): Promise<Socket | TLSSocket>

    Private #createTlsSocket

    • #createTlsSocket(): CreateSocketReturn<TLSSocket>

    Private #onSocketError

    • #onSocketError(err: Error): void

    Private #retryConnection

    • #retryConnection(retries: number, hadError?: boolean): Promise<Socket | TLSSocket>

    addListener

    • addListener(eventName: string | symbol, listener: (...args: any[]) => void): default

    • Alias for emitter.on(eventName, listener).

      since

      v0.1.26

      -

      Parameters

      • eventName: string | symbol
      • listener: (...args: any[]) => void
          • (...args: any[]): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns default

    connect

    • connect(): Promise<void>

    cork

    • cork(): void

    disconnect

    • disconnect(): void

    emit

    • emit(eventName: string | symbol, ...args: any[]): boolean
    • +

      Parameters

      • eventName: string | symbol
      • listener: (...args: any[]) => void
          • (...args: any[]): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns default

    connect

    • connect(): Promise<void>

    cork

    • cork(): void

    disconnect

    • disconnect(): void

    emit

    • emit(eventName: string | symbol, ...args: any[]): boolean

    • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

      Returns true if the event had listeners, false otherwise.

      @@ -96,7 +96,7 @@ listener is removed, and then invoked.

      The name of the event.

    • listener: (...args: any[]) => void

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default

    quit

    • quit(fn: () => Promise<unknown>): Promise<void>

    rawListeners

    • rawListeners(eventName: string | symbol): Function[]
    • +
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default

    quit

    • quit(fn: () => Promise<unknown>): Promise<void>

    rawListeners

    • rawListeners(eventName: string | symbol): Function[]

    • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

      const emitter = new EventEmitter();
      emitter.once('log', () => console.log('log once'));

      // Returns a new Array with a function `onceWrapper` which has a property
      // `listener` which contains the original listener bound above
      const listeners = emitter.rawListeners('log');
      const logFnWrapper = listeners[0];

      // Logs "log once" to the console and does not unbind the `once` event
      logFnWrapper.listener();

      // Logs "log once" to the console and removes the listener
      logFnWrapper();

      emitter.on('log', () => console.log('log persistently'));
      // Will return a new Array with a single function bound by `.on()` above
      const newListeners = emitter.rawListeners('log');

      // Logs "log persistently" twice
      newListeners[0]();
      emitter.emit('log');
@@ -141,7 +141,7 @@ memory leaks. The emitter.setMaxListeners() method allows the limit
 modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

      Returns a reference to the EventEmitter, so that calls can be chained.

      since

      v0.3.5

      -

      Parameters

      • n: number

      Returns default

    writeCommand

    Static Private #defaultReconnectStrategy

    • #defaultReconnectStrategy(retries: number): number

    Static Private #initiateOptions

    Static Private #isTlsSocket

    Static getEventListeners

    • getEventListeners(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]
    • +

      Parameters

      • n: number

      Returns default

    writeCommand

    Static Private #defaultReconnectStrategy

    • #defaultReconnectStrategy(retries: number): number

    Static Private #initiateOptions

    Static Private #isTlsSocket

    Static getEventListeners

    • getEventListeners(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]