diff --git a/documentation/bloom/interfaces/commands_bloom_INFO.InfoReply.html b/documentation/bloom/interfaces/commands_bloom_INFO.InfoReply.html index 25f5e96925..fca38efa6c 100644 --- a/documentation/bloom/interfaces/commands_bloom_INFO.InfoReply.html +++ b/documentation/bloom/interfaces/commands_bloom_INFO.InfoReply.html @@ -1 +1 @@ -InfoReply | @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 | @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 7bfe2da2f3..782d5a045e 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 | @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 | @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 c44b1b3c76..6d28998624 100644 --- a/documentation/bloom/interfaces/commands_cuckoo.InsertOptions.html +++ b/documentation/bloom/interfaces/commands_cuckoo.InsertOptions.html @@ -1 +1 @@ -InsertOptions | @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 | @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 2359dd284d..5b1c1ca56b 100644 --- a/documentation/bloom/interfaces/commands_cuckoo_INFO.InfoReply.html +++ b/documentation/bloom/interfaces/commands_cuckoo_INFO.InfoReply.html @@ -1 +1 @@ -InfoReply | @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 | @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 9995edccf4..a7326248a4 100644 --- a/documentation/bloom/interfaces/commands_top_k_INFO.InfoReply.html +++ b/documentation/bloom/interfaces/commands_top_k_INFO.InfoReply.html @@ -1 +1 @@ -InfoReply | @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 | @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.html b/documentation/bloom/modules/commands.html index 3869aab6e1..311bb31b2d 100644 --- a/documentation/bloom/modules/commands.html +++ b/documentation/bloom/modules/commands.html @@ -1 +1 @@ -commands | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands

Index

Variables

Variables

default

default: { 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; LIST_WITHCOUNT: commands/top-k/LIST_WITHCOUNT; 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; listWithCount: commands/top-k/LIST_WITHCOUNT; query: commands/top-k/QUERY; reserve: commands/top-k/RESERVE } }

Type declaration

Generated using TypeDoc

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

Module commands

Index

Variables

Variables

default

default: { 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; LIST_WITHCOUNT: commands/top-k/LIST_WITHCOUNT; 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; listWithCount: commands/top-k/LIST_WITHCOUNT; query: commands/top-k/QUERY; reserve: commands/top-k/RESERVE } }

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/bloom/modules/commands_bloom.html b/documentation/bloom/modules/commands_bloom.html index 900b297082..ee920cd8b7 100644 --- a/documentation/bloom/modules/commands_bloom.html +++ b/documentation/bloom/modules/commands_bloom.html @@ -1 +1 @@ -commands/bloom | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom

Index

Variables

Variables

default

default: { 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 }

Type declaration

Generated using TypeDoc

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

Module commands/bloom

Index

Variables

Variables

default

default: { 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 }

Type declaration

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 4947776c37..66ba4c00bd 100644 --- a/documentation/bloom/modules/commands_bloom_ADD.html +++ b/documentation/bloom/modules/commands_bloom_ADD.html @@ -1 +1 @@ -commands/bloom/ADD | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/ADD

Index

Variables

Functions

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/ADD

Index

Variables

Functions

Variables

Const 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 270601df95..1a7d4c6c55 100644 --- a/documentation/bloom/modules/commands_bloom_EXISTS.html +++ b/documentation/bloom/modules/commands_bloom_EXISTS.html @@ -1 +1 @@ -commands/bloom/EXISTS | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/EXISTS

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/EXISTS

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 d35e8737e8..420fcf1f0d 100644 --- a/documentation/bloom/modules/commands_bloom_INFO.html +++ b/documentation/bloom/modules/commands_bloom_INFO.html @@ -1 +1 @@ -commands/bloom/INFO | @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

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 | @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

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 49af79151c..bbda3727f3 100644 --- a/documentation/bloom/modules/commands_bloom_INSERT.html +++ b/documentation/bloom/modules/commands_bloom_INSERT.html @@ -1 +1 @@ -commands/bloom/INSERT | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/INSERT

Index

Variables

Functions

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/INSERT

Index

Variables

Functions

Variables

Const 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 fe4e6671fd..a9776ba626 100644 --- a/documentation/bloom/modules/commands_bloom_LOADCHUNK.html +++ b/documentation/bloom/modules/commands_bloom_LOADCHUNK.html @@ -1 +1 @@ -commands/bloom/LOADCHUNK | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/LOADCHUNK

Index

Variables

Functions

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/LOADCHUNK

Index

Variables

Functions

Variables

Const 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 6f6a5c6b7b..5b90011a18 100644 --- a/documentation/bloom/modules/commands_bloom_MADD.html +++ b/documentation/bloom/modules/commands_bloom_MADD.html @@ -1 +1 @@ -commands/bloom/MADD | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/MADD

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/MADD

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

Const 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 099109f35c..ecaa5649e4 100644 --- a/documentation/bloom/modules/commands_bloom_MEXISTS.html +++ b/documentation/bloom/modules/commands_bloom_MEXISTS.html @@ -1 +1 @@ -commands/bloom/MEXISTS | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/MEXISTS

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/MEXISTS

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 7fda416891..6aa2173e47 100644 --- a/documentation/bloom/modules/commands_bloom_RESERVE.html +++ b/documentation/bloom/modules/commands_bloom_RESERVE.html @@ -1 +1 @@ -commands/bloom/RESERVE | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/RESERVE

Index

Variables

Functions

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/RESERVE

Index

Variables

Functions

Variables

Const 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 7a4c82ab52..40c0f8aaf5 100644 --- a/documentation/bloom/modules/commands_bloom_SCANDUMP.html +++ b/documentation/bloom/modules/commands_bloom_SCANDUMP.html @@ -1 +1 @@ -commands/bloom/SCANDUMP | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/SCANDUMP

Index

Variables

Functions

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/bloom/SCANDUMP

Index

Variables

Functions

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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.html b/documentation/bloom/modules/commands_count_min_sketch.html index 0d2f7b26ef..77aaa7572a 100644 --- a/documentation/bloom/modules/commands_count_min_sketch.html +++ b/documentation/bloom/modules/commands_count_min_sketch.html @@ -1 +1 @@ -commands/count-min-sketch | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch

Index

Variables

Variables

default

default: { 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 }

Type declaration

Generated using TypeDoc

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

Module commands/count-min-sketch

Index

Variables

Variables

default

default: { 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 }

Type declaration

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 555c264aed..3b85dec62b 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/INCRBY

Index

Variables

Functions

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/INCRBY

Index

Variables

Functions

Variables

Const 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 dc3eff57db..0b8dc00f77 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 | @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

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 | @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

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 3b91598f74..c002f08daf 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/INITBYDIM

Index

Variables

Functions

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/INITBYDIM

Index

Variables

Functions

Variables

Const 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 9230ccb955..88d6c17ee5 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/INITBYPROB

Index

Variables

Functions

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/INITBYPROB

Index

Variables

Functions

Variables

Const 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 dd885af453..a1a3e5bea0 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/MERGE

Index

Variables

Functions

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/MERGE

Index

Variables

Functions

Variables

Const 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 0dba5bf226..3d587d5825 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/QUERY

Index

Variables

Functions

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/count-min-sketch/QUERY

Index

Variables

Functions

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 6748e1697b..6ccd364824 100644 --- a/documentation/bloom/modules/commands_cuckoo.html +++ b/documentation/bloom/modules/commands_cuckoo.html @@ -1 +1 @@ -commands/cuckoo | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo

Index

Interfaces

Variables

Functions

Variables

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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo

Index

Interfaces

Variables

Functions

Variables

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 9cf8211737..7ed9d8abf5 100644 --- a/documentation/bloom/modules/commands_cuckoo_ADD.html +++ b/documentation/bloom/modules/commands_cuckoo_ADD.html @@ -1 +1 @@ -commands/cuckoo/ADD | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/ADD

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/ADD

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

Const 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 e04a2bd7a9..5e2afc9c92 100644 --- a/documentation/bloom/modules/commands_cuckoo_ADDNX.html +++ b/documentation/bloom/modules/commands_cuckoo_ADDNX.html @@ -1 +1 @@ -commands/cuckoo/ADDNX | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/ADDNX

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/ADDNX

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

Const 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 d43b52260c..97039ec792 100644 --- a/documentation/bloom/modules/commands_cuckoo_COUNT.html +++ b/documentation/bloom/modules/commands_cuckoo_COUNT.html @@ -1 +1 @@ -commands/cuckoo/COUNT | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/COUNT

Index

Variables

Functions

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/COUNT

Index

Variables

Functions

Variables

Const 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 5ce297ac59..bea3632f47 100644 --- a/documentation/bloom/modules/commands_cuckoo_DEL.html +++ b/documentation/bloom/modules/commands_cuckoo_DEL.html @@ -1 +1 @@ -commands/cuckoo/DEL | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/DEL

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/DEL

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

Const 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 3777b94442..a3d3cbdd29 100644 --- a/documentation/bloom/modules/commands_cuckoo_EXISTS.html +++ b/documentation/bloom/modules/commands_cuckoo_EXISTS.html @@ -1 +1 @@ -commands/cuckoo/EXISTS | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/EXISTS

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/EXISTS

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 ef09cc36db..22d0d51fe1 100644 --- a/documentation/bloom/modules/commands_cuckoo_INFO.html +++ b/documentation/bloom/modules/commands_cuckoo_INFO.html @@ -1 +1 @@ -commands/cuckoo/INFO | @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

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 | @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

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 2b6aae9c49..d4f78abc38 100644 --- a/documentation/bloom/modules/commands_cuckoo_INSERT.html +++ b/documentation/bloom/modules/commands_cuckoo_INSERT.html @@ -1 +1 @@ -commands/cuckoo/INSERT | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/INSERT

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/INSERT

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

Const 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 a19b58d813..5874fe7c4d 100644 --- a/documentation/bloom/modules/commands_cuckoo_INSERTNX.html +++ b/documentation/bloom/modules/commands_cuckoo_INSERTNX.html @@ -1 +1 @@ -commands/cuckoo/INSERTNX | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/INSERTNX

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/INSERTNX

Index

References

Variables

Functions

References

transformReply

Re-exports transformReply

Variables

Const 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 5b9098db6e..b77644cc61 100644 --- a/documentation/bloom/modules/commands_cuckoo_LOADCHUNK.html +++ b/documentation/bloom/modules/commands_cuckoo_LOADCHUNK.html @@ -1 +1 @@ -commands/cuckoo/LOADCHUNK | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/LOADCHUNK

Index

Variables

Functions

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/LOADCHUNK

Index

Variables

Functions

Variables

Const 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 f9e8966247..ae798ecc88 100644 --- a/documentation/bloom/modules/commands_cuckoo_RESERVE.html +++ b/documentation/bloom/modules/commands_cuckoo_RESERVE.html @@ -1 +1 @@ -commands/cuckoo/RESERVE | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/RESERVE

Index

Variables

Functions

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/RESERVE

Index

Variables

Functions

Variables

Const 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 6e36ac78e9..fd41adce6d 100644 --- a/documentation/bloom/modules/commands_cuckoo_SCANDUMP.html +++ b/documentation/bloom/modules/commands_cuckoo_SCANDUMP.html @@ -1 +1 @@ -commands/cuckoo/SCANDUMP | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/SCANDUMP

Index

Variables

Functions

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/cuckoo/SCANDUMP

Index

Variables

Functions

Variables

Const 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.html b/documentation/bloom/modules/commands_top_k.html index d35a738870..a721f12a84 100644 --- a/documentation/bloom/modules/commands_top_k.html +++ b/documentation/bloom/modules/commands_top_k.html @@ -1 +1 @@ -commands/top-k | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k

Index

Variables

Variables

default

default: { 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; LIST_WITHCOUNT: commands/top-k/LIST_WITHCOUNT; 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; listWithCount: commands/top-k/LIST_WITHCOUNT; query: commands/top-k/QUERY; reserve: commands/top-k/RESERVE }

Type declaration

Generated using TypeDoc

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

Module commands/top-k

Index

Variables

Variables

default

default: { 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; LIST_WITHCOUNT: commands/top-k/LIST_WITHCOUNT; 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; listWithCount: commands/top-k/LIST_WITHCOUNT; query: commands/top-k/QUERY; reserve: commands/top-k/RESERVE }

Type declaration

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 de3a931526..ad506838f6 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/ADD

Index

Variables

Functions

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/ADD

Index

Variables

Functions

Variables

Const 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 199da50392..52acd1c701 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/COUNT

Index

Variables

Functions

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/COUNT

Index

Variables

Functions

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 e1c3e48c10..e769c885d3 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/INCRBY

Index

Variables

Functions

Variables

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/INCRBY

Index

Variables

Functions

Variables

Const 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 f08ca686f2..8610fd4a46 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 | @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

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 | @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

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 9e25b4e709..2424c4ecdc 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/LIST

Index

Variables

Functions

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string): string[]

transformReply

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

Generated using TypeDoc

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

Module commands/top-k/LIST

Index

Variables

Functions

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const IS_READ_ONLY

IS_READ_ONLY: true = true

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_LIST_WITHCOUNT.html b/documentation/bloom/modules/commands_top_k_LIST_WITHCOUNT.html index 422c02c30d..f836292e29 100644 --- a/documentation/bloom/modules/commands_top_k_LIST_WITHCOUNT.html +++ b/documentation/bloom/modules/commands_top_k_LIST_WITHCOUNT.html @@ -1 +1 @@ -commands/top-k/LIST_WITHCOUNT | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/LIST_WITHCOUNT

Index

Variables

Functions

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string): string[]

transformReply

  • transformReply(rawReply: ListWithCountRawReply): ListWithCountReply

Generated using TypeDoc

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

Module commands/top-k/LIST_WITHCOUNT

Index

Variables

Functions

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const IS_READ_ONLY

IS_READ_ONLY: true = true

Functions

transformArguments

  • transformArguments(key: string): string[]

transformReply

  • transformReply(rawReply: ListWithCountRawReply): ListWithCountReply

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 b3e4a2b255..26d427cde4 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/QUERY

Index

Variables

Functions

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/QUERY

Index

Variables

Functions

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const 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 d538598bf2..27cbf9d6bc 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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/RESERVE

Index

Variables

Functions

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const IS_READ_ONLY

IS_READ_ONLY: true = true

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 | @redis/bloom
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands/top-k/RESERVE

Index

Variables

Functions

Variables

Const FIRST_KEY_INDEX

FIRST_KEY_INDEX: 1 = 1

Const IS_READ_ONLY

IS_READ_ONLY: true = true

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/client/classes/lib_client.default.html b/documentation/client/classes/lib_client.default.html index 560862a825..585a938fb1 100644 --- a/documentation/client/classes/lib_client.default.html +++ b/documentation/client/classes/lib_client.default.html @@ -1,4 +1,4 @@ -default | @redis/client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default<M, F, S>

Type parameters

Hierarchy

  • EventEmitter
    • default

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Readonly #isolationPool

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

Private Optional Readonly #options

#options?: RedisClientOptions<M, F, 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 | @redis/client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default<M, F, S>

Type parameters

Hierarchy

  • EventEmitter
    • default

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Readonly #isolationPool

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

Private Optional Readonly #options

#options?: RedisClientOptions<M, F, 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, F, 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, F, 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, F, 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, F, 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)[]

executeFunction

executeIsolated

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

executeScript

functionsExecuter

  • functionsExecuter<F>(fn: F, args: unknown[], name: string): Promise<RedisCommandReply<F>>

getMaxListeners

  • getMaxListeners(): number
  • +

    Returns (string | symbol)[]

executeFunction

executeIsolated

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

executeScript

functionsExecuter

  • functionsExecuter<F>(fn: F, args: unknown[], name: string): Promise<RedisCommandReply<F>>

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, F, S>
  • +

    Parameters

    • eventName: string | symbol

    Returns Function[]

multi

multiExecutor

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): default<M, F, 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, F, S>

on

  • on(eventName: string | symbol, listener: (...args: any[]) => void): default<M, F, 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, F, S>

sScanIterator

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

scanIterator

scriptsExecuter

sendCommand

setMaxListeners

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

    Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default<M, F, S>

sScanIterator

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

scanIterator

scriptsExecuter

sendCommand

setMaxListeners

  • setMaxListeners(n: number): default<M, F, 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, F, 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, F, 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,7 +202,7 @@ 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

Static setMaxListeners

  • setMaxListeners(n?: number, ...eventTargets: (EventEmitter | DOMEventTarget)[]): void
  • +

    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

Static setMaxListeners

  • setMaxListeners(n?: number, ...eventTargets: (EventEmitter | DOMEventTarget)[]): void

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[]

quit

  • quit(): Promise<void>

rawListeners

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

      • Parameters

        • Rest ...args: any[]

        Returns void

Returns default<M, F, S>

quit

  • quit(): 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');
@@ -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, F, S>

scriptsExecutor

sendCommand

setMaxListeners

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

    Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default<M, F, S>

scriptsExecutor

sendCommand

setMaxListeners

  • setMaxListeners(n: number): default<M, F, 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, F, S>

Static create

Static extractFirstKey

Static getEventListeners

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

    Parameters

    • n: number

    Returns default<M, F, S>

Static create

Static extractFirstKey

Static getEventListeners

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