Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IMulti

Extends default Multi type to allow dynamic properties access on it

type

{IMulti}

Hierarchy

  • Multi
    • IMulti

Indexable

[name: string]: any

Extends default Multi type to allow dynamic properties access on it

Index

Properties

Methods

Properties

BITFIELD

BITFIELD: OverloadedKeyCommand<string | number, [number, number], Multi>

BLPOP

BLPOP: OverloadedLastCommand<string, number, [string, string], Multi>

BRPOP

BRPOP: OverloadedLastCommand<string, number, [string, string], Multi>

CLIENT

CLIENT: OverloadedCommand<string, any, Multi>

CLUSTER

CLUSTER: OverloadedCommand<string, any, this>

CONFIG

CONFIG: OverloadedCommand<string, boolean, Multi>

DEBUG

DEBUG: OverloadedCommand<string, boolean, Multi>

DEL

DEL: OverloadedCommand<string, number, Multi>

EVAL

EVAL: OverloadedCommand<string | number, any, Multi>

EVALSHA

EVALSHA: OverloadedCommand<string | number, any, Multi>

EXISTS

EXISTS: OverloadedCommand<string, number, Multi>

GEOADD

GEOADD: OverloadedKeyCommand<string | number, number, Multi>

GEODIST

GEODIST: OverloadedKeyCommand<string, string, Multi>

GEOHASH

GEOHASH: OverloadedKeyCommand<string, string, Multi>

GEOPOS

GEOPOS: OverloadedKeyCommand<string, Array<[number, number]>, Multi>

GEORADIUS

GEORADIUS: OverloadedKeyCommand<string | number, Array<string | [string, string | [string, string]]>, Multi>

GEORADIUSBYMEMBER

GEORADIUSBYMEMBER: OverloadedKeyCommand<string | number, Array<string | [string, string | [string, string]]>, Multi>

HDEL

HDEL: OverloadedKeyCommand<string, number, Multi>

HMGET

HMGET: OverloadedKeyCommand<string, string[], Multi>

HMSET

HMSET: OverloadedSetCommand<string | number, boolean, Multi>

HSCAN

HSCAN: OverloadedKeyCommand<string, [string, string[]], Multi>

LPUSH

LPUSH: OverloadedKeyCommand<string, number, Multi>

MGET

MGET: OverloadedCommand<string, string[], Multi>

MIGRATE

MIGRATE: OverloadedCommand<string, boolean, Multi>

MSET

MSET: OverloadedCommand<string, boolean, Multi>

MSETNX

MSETNX: OverloadedCommand<string, boolean, Multi>

Multi

Multi: object

Type declaration

  • constructor: function
    • new __type(): Multi
    • Returns Multi

OBJECT

OBJECT: OverloadedCommand<string, any, Multi>

PFADD

PFADD: OverloadedKeyCommand<string, number, Multi>

PFCOUNT

PFCOUNT: OverloadedCommand<string, number, Multi>

PFMERGE

PFMERGE: OverloadedCommand<string, boolean, Multi>

PSUBSCRIBE

PSUBSCRIBE: OverloadedListCommand<string, string, Multi>

PUBSUB

PUBSUB: OverloadedCommand<string, number, Multi>

PUNSUBSCRIBE

PUNSUBSCRIBE: OverloadedListCommand<string, string, Multi>

RPUSH

RPUSH: OverloadedKeyCommand<string, number, Multi>

SADD

SADD: OverloadedKeyCommand<string, number, Multi>

SCAN

SCAN: OverloadedCommand<string, [string, string[]], Multi>

SCRIPT

SCRIPT: OverloadedCommand<string, any, Multi>

SDIFF

SDIFF: OverloadedCommand<string, string[], Multi>

SDIFFSTORE

SDIFFSTORE: OverloadedKeyCommand<string, number, Multi>

SHUTDOWN

SHUTDOWN: OverloadedCommand<string, string, Multi>

SINTER

SINTER: OverloadedKeyCommand<string, string[], Multi>

SINTERSTORE

SINTERSTORE: OverloadedCommand<string, number, Multi>

SLOWLOG

SLOWLOG: OverloadedCommand<string, Array<[number, number, number, string[]]>, Multi>

SORT

SORT: OverloadedCommand<string, string[], Multi>

SREM

SREM: OverloadedKeyCommand<string, number, Multi>

SSCAN

SSCAN: OverloadedKeyCommand<string, [string, string[]], Multi>

SUBSCRIBE

SUBSCRIBE: OverloadedListCommand<string, string, Multi>

SUNION

SUNION: OverloadedCommand<string, string[], Multi>

SUNIONSTORE

SUNIONSTORE: OverloadedCommand<string, number, Multi>

UNSUBSCRIBE

UNSUBSCRIBE: OverloadedListCommand<string, string, Multi>

WATCH

WATCH: OverloadedCommand<string, "OK", Multi>

ZADD

ZADD: OverloadedKeyCommand<string | number, number, Multi>

ZINTERSTORE

ZINTERSTORE: OverloadedCommand<string | number, number, Multi>

ZREM

ZREM: OverloadedKeyCommand<string, number, Multi>

ZSCAN

ZSCAN: OverloadedKeyCommand<string, [string, string[]], Multi>

ZUNIONSTORE

ZUNIONSTORE: OverloadedCommand<string | number, number, Multi>

bitfield

bitfield: OverloadedKeyCommand<string | number, [number, number], Multi>

Perform arbitrary bitfield integer operations on strings.

blpop

blpop: OverloadedLastCommand<string, number, [string, string], Multi>

Remove and get the first element in a list, or block until one is available.

brpop

brpop: OverloadedLastCommand<string, number, [string, string], Multi>

Remove and get the last element in a list, or block until one is available.

client

client: OverloadedCommand<string, any, Multi>

KILL - Kill the connection of a client. LIST - Get the list of client connections. GETNAME - Get the current connection name. PAUSE - Stop processing commands from clients for some time. REPLY - Instruct the server whether to reply to commands. SETNAME - Set the current connection name.

cluster

cluster: OverloadedCommand<string, any, this>

ADDSLOTS - Assign new hash slots to receiving node. COUNT-FAILURE-REPORTS - Return the number of failure reports active for a given node. COUNTKEYSINSLOT - Return the number of local keys in the specified hash slot. DELSLOTS - Set hash slots as unbound in receiving node. FAILOVER - Forces a slave to perform a manual failover of its master. FORGET - Remove a node from the nodes table. GETKEYSINSLOT - Return local key names in the specified hash slot. INFO - Provides info about Redis Cluster node state. KEYSLOT - Returns the hash slot of the specified key. MEET - Force a node cluster to handshake with another node. NODES - Get cluster config for the node. REPLICATE - Reconfigure a node as a slave of the specified master node. RESET - Reset a Redis Cluster node. SAVECONFIG - Forces the node to save cluster state on disk. SET-CONFIG-EPOCH - Set the configuration epoch in a new node. SETSLOT - Bind a hash slot to a specified node. SLAVES - List slave nodes of the specified master node. SLOTS - Get array of Cluster slot to node mappings.

config

config: OverloadedCommand<string, boolean, Multi>

Get array of Redis command details.

COUNT - Get array of Redis command details. GETKEYS - Extract keys given a full Redis command. INFO - Get array of specific Redis command details. GET - Get the value of a configuration parameter. REWRITE - Rewrite the configuration file with the in memory configuration. SET - Set a configuration parameter to the given value. RESETSTAT - Reset the stats returned by INFO.

debug

debug: OverloadedCommand<string, boolean, Multi>

OBJECT - Get debugging information about a key. SEGFAULT - Make the server crash.

del

del: OverloadedCommand<string, number, Multi>

Delete a key.

eval

eval: OverloadedCommand<string | number, any, Multi>

Execute a Lua script server side.

evalsha

evalsha: OverloadedCommand<string | number, any, Multi>

Execute a Lue script server side.

exists

exists: OverloadedCommand<string, number, Multi>

Determine if a key exists.

geoadd

geoadd: OverloadedKeyCommand<string | number, number, Multi>

Add one or more geospatial items in the geospatial index represented using a sorted set.

geodist

geodist: OverloadedKeyCommand<string, string, Multi>

Returns the distance between two members of a geospatial index.

geohash

geohash: OverloadedKeyCommand<string, string, Multi>

Returns members of a geospatial index as standard geohash strings.

geopos

geopos: OverloadedKeyCommand<string, Array<[number, number]>, Multi>

Returns longitude and latitude of members of a geospatial index.

georadius

georadius: OverloadedKeyCommand<string | number, Array<string | [string, string | [string, string]]>, Multi>

Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point.

georadiusbymember

georadiusbymember: OverloadedKeyCommand<string | number, Array<string | [string, string | [string, string]]>, Multi>

Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a member.

hdel

hdel: OverloadedKeyCommand<string, number, Multi>

Delete on or more hash fields.

hmget

hmget: OverloadedKeyCommand<string, string[], Multi>

Get the values of all the given hash fields.

hmset

hmset: OverloadedSetCommand<string | number, boolean, Multi>

Set multiple hash fields to multiple values.

hscan

hscan: OverloadedKeyCommand<string, [string, string[]], Multi>

Incrementally iterate hash fields and associated values.

lpush

lpush: OverloadedKeyCommand<string, number, Multi>

Prepend one or multiple values to a list.

mget

mget: OverloadedCommand<string, string[], Multi>

Get the values of all given keys.

migrate

migrate: OverloadedCommand<string, boolean, Multi>

Atomically tranfer a key from a Redis instance to another one.

mset

mset: OverloadedCommand<string, boolean, Multi>

Set multiple keys to multiple values.

msetnx

msetnx: OverloadedCommand<string, boolean, Multi>

Set multiple keys to multiple values, only if none of the keys exist.

object

object: OverloadedCommand<string, any, Multi>

Inspect the internals of Redis objects.

pfadd

pfadd: OverloadedKeyCommand<string, number, Multi>

Adds the specified elements to the specified HyperLogLog.

pfcount

pfcount: OverloadedCommand<string, number, Multi>

Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s).

pfmerge

pfmerge: OverloadedCommand<string, boolean, Multi>

Merge N different HyperLogLogs into a single one.

psubscribe

psubscribe: OverloadedListCommand<string, string, Multi>

Listen for messages published to channels matching the given patterns.

pubsub

pubsub: OverloadedCommand<string, number, Multi>

Inspect the state of the Pub/Sub subsytem.

punsubscribe

punsubscribe: OverloadedListCommand<string, string, Multi>

Stop listening for messages posted to channels matching the given patterns.

rpush

rpush: OverloadedKeyCommand<string, number, Multi>

Append one or multiple values to a list.

sadd

sadd: OverloadedKeyCommand<string, number, Multi>

Append one or multiple members to a set.

scan

scan: OverloadedCommand<string, [string, string[]], Multi>

Incrementally iterate the keys space.

script

script: OverloadedCommand<string, any, Multi>

DEBUG - Set the debug mode for executed scripts. EXISTS - Check existence of scripts in the script cache. FLUSH - Remove all scripts from the script cache. KILL - Kill the script currently in execution. LOAD - Load the specified Lua script into the script cache.

sdiff

sdiff: OverloadedCommand<string, string[], Multi>

Subtract multiple sets.

sdiffstore

sdiffstore: OverloadedKeyCommand<string, number, Multi>

Subtract multiple sets and store the resulting set in a key.

shutdown

shutdown: OverloadedCommand<string, string, Multi>

Synchronously save the dataset to disk and then shut down the server.

sinter

sinter: OverloadedKeyCommand<string, string[], Multi>

Intersect multiple sets.

sinterstore

sinterstore: OverloadedCommand<string, number, Multi>

Intersect multiple sets and store the resulting set in a key.

slowlog

slowlog: OverloadedCommand<string, Array<[number, number, number, string[]]>, Multi>

Manages the Redis slow queries log.

sort

sort: OverloadedCommand<string, string[], Multi>

Sort the elements in a list, set or sorted set.

srem

srem: OverloadedKeyCommand<string, number, Multi>

Remove one or more members from a set.

sscan

sscan: OverloadedKeyCommand<string, [string, string[]], Multi>

Incrementally iterate Set elements.

subscribe

subscribe: OverloadedListCommand<string, string, Multi>

Listen for messages published to the given channels.

sunion

sunion: OverloadedCommand<string, string[], Multi>

Add multiple sets.

sunionstore

sunionstore: OverloadedCommand<string, number, Multi>

Add multiple sets and store the resulting set in a key.

unsubscribe

unsubscribe: OverloadedListCommand<string, string, Multi>

Stop listening for messages posted to the given channels.

watch

watch: OverloadedCommand<string, "OK", Multi>

Watch the given keys to determine execution of the MULTI/EXEC block.

zadd

zadd: OverloadedKeyCommand<string | number, number, Multi>

Add one or more members to a sorted set, or update its score if it already exists.

zinterstore

zinterstore: OverloadedCommand<string | number, number, Multi>

Intersect multiple sorted sets and store the resulting sorted set in a new key.

zrem

zrem: OverloadedKeyCommand<string, number, Multi>

Remove one or more members from a sorted set.

zscan

zscan: OverloadedKeyCommand<string, [string, string[]], Multi>

Incrementally iterate sorted sets elements and associated scores.

zunionstore

zunionstore: OverloadedCommand<string | number, number, Multi>

Add multiple sorted sets and store the resulting sorted set in a new key.

Methods

APPEND

  • APPEND(key: string, value: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

AUTH

  • AUTH(password: string, callback?: Callback<string>): Multi
  • Parameters

    • password: string
    • Optional callback: Callback<string>

    Returns Multi

BGREWRITEAOF

  • BGREWRITEAOF(cb?: Callback<"OK">): Multi
  • Parameters

    • Optional cb: Callback<"OK">

    Returns Multi

BGSAVE

  • BGSAVE(cb?: Callback<string>): Multi
  • Parameters

    • Optional cb: Callback<string>

    Returns Multi

BITCOUNT

  • BITCOUNT(key: string, cb?: Callback<number>): Multi
  • BITCOUNT(key: string, start: number, end: number, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

  • Parameters

    • key: string
    • start: number
    • end: number
    • Optional cb: Callback<number>

    Returns Multi

BITOP

  • BITOP(operation: string, destkey: string, key1: string, key2: string, key3: string, cb?: Callback<number>): Multi
  • BITOP(operation: string, destkey: string, key1: string, key2: string, cb?: Callback<number>): Multi
  • BITOP(operation: string, destkey: string, key: string, cb?: Callback<number>): Multi
  • BITOP(operation: string, destkey: string, ...args: Array<string | Callback<number>>): Multi
  • Parameters

    • operation: string
    • destkey: string
    • key1: string
    • key2: string
    • key3: string
    • Optional cb: Callback<number>

    Returns Multi

  • Parameters

    • operation: string
    • destkey: string
    • key1: string
    • key2: string
    • Optional cb: Callback<number>

    Returns Multi

  • Parameters

    • operation: string
    • destkey: string
    • key: string
    • Optional cb: Callback<number>

    Returns Multi

  • Parameters

    • operation: string
    • destkey: string
    • Rest ...args: Array<string | Callback<number>>

    Returns Multi

BITPOS

  • BITPOS(key: string, bit: number, start: number, end: number, cb?: Callback<number>): Multi
  • BITPOS(key: string, bit: number, start: number, cb?: Callback<number>): Multi
  • BITPOS(key: string, bit: number, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • bit: number
    • start: number
    • end: number
    • Optional cb: Callback<number>

    Returns Multi

  • Parameters

    • key: string
    • bit: number
    • start: number
    • Optional cb: Callback<number>

    Returns Multi

  • Parameters

    • key: string
    • bit: number
    • Optional cb: Callback<number>

    Returns Multi

BRPOPLPUSH

  • BRPOPLPUSH(source: string, destination: string, timeout: number, cb?: Callback<string | null>): Multi
  • Parameters

    • source: string
    • destination: string
    • timeout: number
    • Optional cb: Callback<string | null>

    Returns Multi

COMMAND

  • COMMAND(cb?: Callback<Array<[string, number, string[], number, number, number]>>): Multi
  • Parameters

    • Optional cb: Callback<Array<[string, number, string[], number, number, number]>>

    Returns Multi

DBSIZE

  • DBSIZE(cb?: Callback<number>): Multi
  • Parameters

    • Optional cb: Callback<number>

    Returns Multi

DECR

  • DECR(key: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

DECRBY

  • DECRBY(key: string, decrement: number, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • decrement: number
    • Optional cb: Callback<number>

    Returns Multi

DISCARD

  • DISCARD(cb?: Callback<"OK">): Multi
  • Parameters

    • Optional cb: Callback<"OK">

    Returns Multi

DUMP

  • DUMP(key: string, cb?: Callback<string>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<string>

    Returns Multi

ECHO

  • ECHO<T>(message: T, cb?: Callback<T>): Multi
  • Type parameters

    • T: string

    Parameters

    • message: T
    • Optional cb: Callback<T>

    Returns Multi

EXEC

  • EXEC(cb?: Callback<any[]>): boolean
  • Parameters

    • Optional cb: Callback<any[]>

    Returns boolean

EXEC_ATOMIC

  • EXEC_ATOMIC(cb?: Callback<any[]>): boolean
  • Parameters

    • Optional cb: Callback<any[]>

    Returns boolean

EXPIRE

  • EXPIRE(key: string, seconds: number, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • seconds: number
    • Optional cb: Callback<number>

    Returns Multi

EXPIREAT

  • EXPIREAT(key: string, timestamp: number, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • timestamp: number
    • Optional cb: Callback<number>

    Returns Multi

FLUSHALL

  • FLUSHALL(cb?: Callback<string>): Multi
  • Parameters

    • Optional cb: Callback<string>

    Returns Multi

FLUSHDB

  • FLUSHDB(cb?: Callback<string>): Multi
  • Parameters

    • Optional cb: Callback<string>

    Returns Multi

GET

  • GET(key: string, cb?: Callback<string>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<string>

    Returns Multi

GETBIT

  • GETBIT(key: string, offset: number, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • offset: number
    • Optional cb: Callback<number>

    Returns Multi

GETRANGE

  • GETRANGE(key: string, start: number, end: number, cb?: Callback<string>): Multi
  • Parameters

    • key: string
    • start: number
    • end: number
    • Optional cb: Callback<string>

    Returns Multi

GETSET

  • GETSET(key: string, value: string, cb?: Callback<string>): Multi
  • Parameters

    • key: string
    • value: string
    • Optional cb: Callback<string>

    Returns Multi

HEXISTS

  • HEXISTS(key: string, field: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • field: string
    • Optional cb: Callback<number>

    Returns Multi

HGET

  • HGET(key: string, field: string, cb?: Callback<string>): Multi
  • Parameters

    • key: string
    • field: string
    • Optional cb: Callback<string>

    Returns Multi

HGETALL

  • HGETALL(key: string, cb?: Callback<object>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<object>

    Returns Multi

HINCRBY

  • HINCRBY(key: string, field: string, increment: number, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • field: string
    • increment: number
    • Optional cb: Callback<number>

    Returns Multi

HINCRBYFLOAT

  • HINCRBYFLOAT(key: string, field: string, increment: number, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • field: string
    • increment: number
    • Optional cb: Callback<number>

    Returns Multi

HKEYS

  • HKEYS(key: string, cb?: Callback<string[]>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<string[]>

    Returns Multi

HLEN

  • HLEN(key: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

HSET

  • HSET(key: string, field: string, value: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • field: string
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

HSETNX

  • HSETNX(key: string, field: string, value: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • field: string
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

HSTRLEN

  • HSTRLEN(key: string, field: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • field: string
    • Optional cb: Callback<number>

    Returns Multi

HVALS

  • HVALS(key: string, cb?: Callback<string[]>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<string[]>

    Returns Multi

INCR

  • INCR(key: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

INCRBY

  • INCRBY(key: string, increment: number, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • increment: number
    • Optional cb: Callback<number>

    Returns Multi

INCRBYFLOAT

  • INCRBYFLOAT(key: string, increment: number, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • increment: number
    • Optional cb: Callback<number>

    Returns Multi

INFO

  • INFO(cb?: Callback<ServerInfo>): Multi
  • INFO(section?: string | string[], cb?: Callback<ServerInfo>): Multi
  • Parameters

    • Optional cb: Callback<ServerInfo>

    Returns Multi

  • Parameters

    • Optional section: string | string[]
    • Optional cb: Callback<ServerInfo>

    Returns Multi

KEYS

  • KEYS(pattern: string, cb?: Callback<string[]>): Multi
  • Parameters

    • pattern: string
    • Optional cb: Callback<string[]>

    Returns Multi

LASTSAVE

  • LASTSAVE(cb?: Callback<number>): Multi
  • Parameters

    • Optional cb: Callback<number>

    Returns Multi

LINDEX

  • LINDEX(key: string, index: number, cb?: Callback<string>): Multi
  • Parameters

    • key: string
    • index: number
    • Optional cb: Callback<string>

    Returns Multi

LINSERT

  • LINSERT(key: string, dir: "BEFORE" | "AFTER", pivot: string, value: string, cb?: Callback<string>): Multi
  • Parameters

    • key: string
    • dir: "BEFORE" | "AFTER"
    • pivot: string
    • value: string
    • Optional cb: Callback<string>

    Returns Multi

LLEN

  • LLEN(key: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

LPOP

  • LPOP(key: string, cb?: Callback<string>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<string>

    Returns Multi

LPUSHX

  • LPUSHX(key: string, value: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

LRANGE

  • LRANGE(key: string, start: number, stop: number, cb?: Callback<string[]>): Multi
  • Parameters

    • key: string
    • start: number
    • stop: number
    • Optional cb: Callback<string[]>

    Returns Multi

LREM

  • LREM(key: string, count: number, value: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • count: number
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

LSET

  • LSET(key: string, index: number, value: string, cb?: Callback<"OK">): Multi
  • Parameters

    • key: string
    • index: number
    • value: string
    • Optional cb: Callback<"OK">

    Returns Multi

LTRIM

  • LTRIM(key: string, start: number, stop: number, cb?: Callback<"OK">): Multi
  • Parameters

    • key: string
    • start: number
    • stop: number
    • Optional cb: Callback<"OK">

    Returns Multi

MONITOR

  • MONITOR(cb?: Callback<undefined>): Multi
  • Parameters

    • Optional cb: Callback<undefined>

    Returns Multi

MOVE

  • MOVE(key: string, db: string | number): Multi
  • Parameters

    • key: string
    • db: string | number

    Returns Multi

PERSIST

  • PERSIST(key: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

PEXPIRE

  • PEXPIRE(key: string, milliseconds: number, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • milliseconds: number
    • Optional cb: Callback<number>

    Returns Multi

PEXPIREAT

  • PEXPIREAT(key: string, millisecondsTimestamp: number, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • millisecondsTimestamp: number
    • Optional cb: Callback<number>

    Returns Multi

PING

  • PING(callback?: Callback<string>): Multi
  • PING(message: string, callback?: Callback<string>): Multi
  • Parameters

    • Optional callback: Callback<string>

    Returns Multi

  • Parameters

    • message: string
    • Optional callback: Callback<string>

    Returns Multi

PSETEX

  • PSETEX(key: string, milliseconds: number, value: string, cb?: Callback<"OK">): Multi
  • Parameters

    • key: string
    • milliseconds: number
    • value: string
    • Optional cb: Callback<"OK">

    Returns Multi

PTTL

  • PTTL(key: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

PUBLISH

  • PUBLISH(channel: string, value: string, cb?: Callback<number>): Multi
  • Parameters

    • channel: string
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

QUIT

  • QUIT(cb?: Callback<"OK">): Multi
  • Parameters

    • Optional cb: Callback<"OK">

    Returns Multi

RANDOMKEY

  • RANDOMKEY(cb?: Callback<string>): Multi
  • Parameters

    • Optional cb: Callback<string>

    Returns Multi

READONLY

  • READONLY(cb?: Callback<string>): Multi
  • Parameters

    • Optional cb: Callback<string>

    Returns Multi

READWRITE

  • READWRITE(cb?: Callback<string>): Multi
  • Parameters

    • Optional cb: Callback<string>

    Returns Multi

RENAME

  • RENAME(key: string, newkey: string, cb?: Callback<"OK">): Multi
  • Parameters

    • key: string
    • newkey: string
    • Optional cb: Callback<"OK">

    Returns Multi

RENAMENX

  • RENAMENX(key: string, newkey: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • newkey: string
    • Optional cb: Callback<number>

    Returns Multi

RESTORE

  • RESTORE(key: string, ttl: number, serializedValue: string, cb?: Callback<"OK">): Multi
  • Parameters

    • key: string
    • ttl: number
    • serializedValue: string
    • Optional cb: Callback<"OK">

    Returns Multi

ROLE

  • ROLE(cb?: Callback<[string, number, Array<[string, string, string]>]>): Multi
  • Parameters

    • Optional cb: Callback<[string, number, Array<[string, string, string]>]>

    Returns Multi

RPOP

  • RPOP(key: string, cb?: Callback<string>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<string>

    Returns Multi

RPOPLPUSH

  • RPOPLPUSH(source: string, destination: string, cb?: Callback<string>): Multi
  • Parameters

    • source: string
    • destination: string
    • Optional cb: Callback<string>

    Returns Multi

RPUSHX

  • RPUSHX(key: string, value: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

SAVE

  • SAVE(cb?: Callback<string>): Multi
  • Parameters

    • Optional cb: Callback<string>

    Returns Multi

SCARD

  • SCARD(key: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

SELECT

  • SELECT(index: number | string, cb?: Callback<string>): Multi
  • Parameters

    • index: number | string
    • Optional cb: Callback<string>

    Returns Multi

SET

  • SET(key: string, value: string, cb?: Callback<"OK">): Multi
  • SET(key: string, value: string, flag: string, cb?: Callback<"OK">): Multi
  • SET(key: string, value: string, mode: string, duration: number, cb?: Callback<"OK" | undefined>): Multi
  • SET(key: string, value: string, mode: string, duration: number, flag: string, cb?: Callback<"OK" | undefined>): Multi
  • Parameters

    • key: string
    • value: string
    • Optional cb: Callback<"OK">

    Returns Multi

  • Parameters

    • key: string
    • value: string
    • flag: string
    • Optional cb: Callback<"OK">

    Returns Multi

  • Parameters

    • key: string
    • value: string
    • mode: string
    • duration: number
    • Optional cb: Callback<"OK" | undefined>

    Returns Multi

  • Parameters

    • key: string
    • value: string
    • mode: string
    • duration: number
    • flag: string
    • Optional cb: Callback<"OK" | undefined>

    Returns Multi

SETBIT

  • SETBIT(key: string, offset: number, value: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • offset: number
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

SETEX

  • SETEX(key: string, seconds: number, value: string, cb?: Callback<string>): Multi
  • Parameters

    • key: string
    • seconds: number
    • value: string
    • Optional cb: Callback<string>

    Returns Multi

SETNX

  • SETNX(key: string, value: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

SETRANGE

  • SETRANGE(key: string, offset: number, value: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • offset: number
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

SISMEMBER

  • SISMEMBER(key: string, member: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • member: string
    • Optional cb: Callback<number>

    Returns Multi

SLAVEOF

  • SLAVEOF(host: string, port: string | number, cb?: Callback<string>): Multi
  • Parameters

    • host: string
    • port: string | number
    • Optional cb: Callback<string>

    Returns Multi

SMEMBERS

  • SMEMBERS(key: string, cb?: Callback<string[]>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<string[]>

    Returns Multi

SMOVE

  • SMOVE(source: string, destination: string, member: string, cb?: Callback<number>): Multi
  • Parameters

    • source: string
    • destination: string
    • member: string
    • Optional cb: Callback<number>

    Returns Multi

SPOP

  • SPOP(key: string, cb?: Callback<string>): Multi
  • SPOP(key: string, count: number, cb?: Callback<string[]>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<string>

    Returns Multi

  • Parameters

    • key: string
    • count: number
    • Optional cb: Callback<string[]>

    Returns Multi

SRANDMEMBER

  • SRANDMEMBER(key: string, cb?: Callback<string>): Multi
  • SRANDMEMBER(key: string, count: number, cb?: Callback<string[]>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<string>

    Returns Multi

  • Parameters

    • key: string
    • count: number
    • Optional cb: Callback<string[]>

    Returns Multi

STRLEN

  • STRLEN(key: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

SYNC

  • SYNC(cb?: Callback<undefined>): Multi
  • Parameters

    • Optional cb: Callback<undefined>

    Returns Multi

TIME

  • TIME(cb?: Callback<[string, string]>): Multi
  • Parameters

    • Optional cb: Callback<[string, string]>

    Returns Multi

TTL

  • TTL(key: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

TYPE

  • TYPE(key: string, cb?: Callback<string>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<string>

    Returns Multi

UNWATCH

  • UNWATCH(cb?: Callback<"OK">): Multi
  • Parameters

    • Optional cb: Callback<"OK">

    Returns Multi

WAIT

  • WAIT(numslaves: number, timeout: number, cb?: Callback<number>): Multi
  • Parameters

    • numslaves: number
    • timeout: number
    • Optional cb: Callback<number>

    Returns Multi

ZCARD

  • ZCARD(key: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

ZCOUNT

  • ZCOUNT(key: string, min: number | string, max: number | string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • min: number | string
    • max: number | string
    • Optional cb: Callback<number>

    Returns Multi

ZINCRBY

  • ZINCRBY(key: string, increment: number, member: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • increment: number
    • member: string
    • Optional cb: Callback<number>

    Returns Multi

ZLEXCOUNT

  • ZLEXCOUNT(key: string, min: string, max: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • min: string
    • max: string
    • Optional cb: Callback<number>

    Returns Multi

ZRANGE

  • ZRANGE(key: string, start: number, stop: number, cb?: Callback<string[]>): Multi
  • ZRANGE(key: string, start: number, stop: number, withscores: string, cb?: Callback<string[]>): Multi
  • Parameters

    • key: string
    • start: number
    • stop: number
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • start: number
    • stop: number
    • withscores: string
    • Optional cb: Callback<string[]>

    Returns Multi

ZRANGEBYLEX

  • ZRANGEBYLEX(key: string, min: string, max: string, cb?: Callback<string[]>): Multi
  • ZRANGEBYLEX(key: string, min: string, max: string, limit: string, offset: number, count: number, cb?: Callback<string[]>): Multi
  • Parameters

    • key: string
    • min: string
    • max: string
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • min: string
    • max: string
    • limit: string
    • offset: number
    • count: number
    • Optional cb: Callback<string[]>

    Returns Multi

ZRANGEBYSCORE

  • ZRANGEBYSCORE(key: string, min: number | string, max: number | string, cb?: Callback<string[]>): Multi
  • ZRANGEBYSCORE(key: string, min: number | string, max: number | string, withscores: string, cb?: Callback<string[]>): Multi
  • ZRANGEBYSCORE(key: string, min: number | string, max: number | string, limit: string, offset: number, count: number, cb?: Callback<string[]>): Multi
  • ZRANGEBYSCORE(key: string, min: number | string, max: number | string, withscores: string, limit: string, offset: number, count: number, cb?: Callback<string[]>): Multi
  • Parameters

    • key: string
    • min: number | string
    • max: number | string
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • min: number | string
    • max: number | string
    • withscores: string
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • min: number | string
    • max: number | string
    • limit: string
    • offset: number
    • count: number
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • min: number | string
    • max: number | string
    • withscores: string
    • limit: string
    • offset: number
    • count: number
    • Optional cb: Callback<string[]>

    Returns Multi

ZRANK

  • ZRANK(key: string, member: string, cb?: Callback<number | undefined>): Multi
  • Parameters

    • key: string
    • member: string
    • Optional cb: Callback<number | undefined>

    Returns Multi

ZREMRANGEBYLEX

  • ZREMRANGEBYLEX(key: string, min: string, max: string, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • min: string
    • max: string
    • Optional cb: Callback<number>

    Returns Multi

ZREMRANGEBYRANK

  • ZREMRANGEBYRANK(key: string, start: number, stop: number, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • start: number
    • stop: number
    • Optional cb: Callback<number>

    Returns Multi

ZREMRANGEBYSCORE

  • ZREMRANGEBYSCORE(key: string, min: string | number, max: string | number, cb?: Callback<number>): Multi
  • Parameters

    • key: string
    • min: string | number
    • max: string | number
    • Optional cb: Callback<number>

    Returns Multi

ZREVRANGE

  • ZREVRANGE(key: string, start: number, stop: number, cb?: Callback<string[]>): Multi
  • ZREVRANGE(key: string, start: number, stop: number, withscores: string, cb?: Callback<string[]>): Multi
  • Parameters

    • key: string
    • start: number
    • stop: number
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • start: number
    • stop: number
    • withscores: string
    • Optional cb: Callback<string[]>

    Returns Multi

ZREVRANGEBYLEX

  • ZREVRANGEBYLEX(key: string, min: string, max: string, cb?: Callback<string[]>): Multi
  • ZREVRANGEBYLEX(key: string, min: string, max: string, limit: string, offset: number, count: number, cb?: Callback<string[]>): Multi
  • Parameters

    • key: string
    • min: string
    • max: string
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • min: string
    • max: string
    • limit: string
    • offset: number
    • count: number
    • Optional cb: Callback<string[]>

    Returns Multi

ZREVRANGEBYSCORE

  • ZREVRANGEBYSCORE(key: string, min: number | string, max: number | string, cb?: Callback<string[]>): Multi
  • ZREVRANGEBYSCORE(key: string, min: number | string, max: number | string, withscores: string, cb?: Callback<string[]>): Multi
  • ZREVRANGEBYSCORE(key: string, min: number | string, max: number | string, limit: string, offset: number, count: number, cb?: Callback<string[]>): Multi
  • ZREVRANGEBYSCORE(key: string, min: number | string, max: number | string, withscores: string, limit: string, offset: number, count: number, cb?: Callback<string[]>): Multi
  • Parameters

    • key: string
    • min: number | string
    • max: number | string
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • min: number | string
    • max: number | string
    • withscores: string
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • min: number | string
    • max: number | string
    • limit: string
    • offset: number
    • count: number
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • min: number | string
    • max: number | string
    • withscores: string
    • limit: string
    • offset: number
    • count: number
    • Optional cb: Callback<string[]>

    Returns Multi

ZREVRANK

  • ZREVRANK(key: string, member: string, cb?: Callback<number | undefined>): Multi
  • Parameters

    • key: string
    • member: string
    • Optional cb: Callback<number | undefined>

    Returns Multi

ZSCORE

  • ZSCORE(key: string, member: string, cb?: Callback<string>): Multi
  • Parameters

    • key: string
    • member: string
    • Optional cb: Callback<string>

    Returns Multi

append

  • append(key: string, value: string, cb?: Callback<number>): Multi
  • Append a value to a key.

    Parameters

    • key: string
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

auth

  • auth(password: string, callback?: Callback<string>): Multi
  • Authenticate to the server.

    Parameters

    • password: string
    • Optional callback: Callback<string>

    Returns Multi

bgrewriteaof

  • bgrewriteaof(cb?: Callback<"OK">): Multi
  • Asynchronously rewrite the append-only file.

    Parameters

    • Optional cb: Callback<"OK">

    Returns Multi

bgsave

  • bgsave(cb?: Callback<string>): Multi
  • Asynchronously save the dataset to disk.

    Parameters

    • Optional cb: Callback<string>

    Returns Multi

bitcount

  • bitcount(key: string, cb?: Callback<number>): Multi
  • bitcount(key: string, start: number, end: number, cb?: Callback<number>): Multi
  • Count set bits in a string.

    Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

  • Parameters

    • key: string
    • start: number
    • end: number
    • Optional cb: Callback<number>

    Returns Multi

bitop

  • bitop(operation: string, destkey: string, key1: string, key2: string, key3: string, cb?: Callback<number>): Multi
  • bitop(operation: string, destkey: string, key1: string, key2: string, cb?: Callback<number>): Multi
  • bitop(operation: string, destkey: string, key: string, cb?: Callback<number>): Multi
  • bitop(operation: string, destkey: string, ...args: Array<string | Callback<number>>): Multi
  • Perform bitwise operations between strings.

    Parameters

    • operation: string
    • destkey: string
    • key1: string
    • key2: string
    • key3: string
    • Optional cb: Callback<number>

    Returns Multi

  • Parameters

    • operation: string
    • destkey: string
    • key1: string
    • key2: string
    • Optional cb: Callback<number>

    Returns Multi

  • Parameters

    • operation: string
    • destkey: string
    • key: string
    • Optional cb: Callback<number>

    Returns Multi

  • Parameters

    • operation: string
    • destkey: string
    • Rest ...args: Array<string | Callback<number>>

    Returns Multi

bitpos

  • bitpos(key: string, bit: number, start: number, end: number, cb?: Callback<number>): Multi
  • bitpos(key: string, bit: number, start: number, cb?: Callback<number>): Multi
  • bitpos(key: string, bit: number, cb?: Callback<number>): Multi
  • Find first bit set or clear in a string.

    Parameters

    • key: string
    • bit: number
    • start: number
    • end: number
    • Optional cb: Callback<number>

    Returns Multi

  • Parameters

    • key: string
    • bit: number
    • start: number
    • Optional cb: Callback<number>

    Returns Multi

  • Parameters

    • key: string
    • bit: number
    • Optional cb: Callback<number>

    Returns Multi

brpoplpush

  • brpoplpush(source: string, destination: string, timeout: number, cb?: Callback<string | null>): Multi
  • Pop a value from a list, push it to another list and return it; or block until one is available.

    Parameters

    • source: string
    • destination: string
    • timeout: number
    • Optional cb: Callback<string | null>

    Returns Multi

command

  • command(cb?: Callback<Array<[string, number, string[], number, number, number]>>): Multi
  • Get array of Redis command details.

    COUNT - Get total number of Redis commands. GETKEYS - Extract keys given a full Redis command. INFO - Get array of specific REdis command details.

    Parameters

    • Optional cb: Callback<Array<[string, number, string[], number, number, number]>>

    Returns Multi

dbsize

  • dbsize(cb?: Callback<number>): Multi
  • Return the number of keys in the selected database.

    Parameters

    • Optional cb: Callback<number>

    Returns Multi

decr

  • decr(key: string, cb?: Callback<number>): Multi
  • Decrement the integer value of a key by one.

    Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

decrby

  • decrby(key: string, decrement: number, cb?: Callback<number>): Multi
  • Decrement the integer value of a key by the given number.

    Parameters

    • key: string
    • decrement: number
    • Optional cb: Callback<number>

    Returns Multi

discard

  • discard(cb?: Callback<"OK">): Multi
  • Discard all commands issued after MULTI.

    Parameters

    • Optional cb: Callback<"OK">

    Returns Multi

dump

  • dump(key: string, cb?: Callback<string>): Multi
  • Return a serialized version of the value stored at the specified key.

    Parameters

    • key: string
    • Optional cb: Callback<string>

    Returns Multi

echo

  • echo<T>(message: T, cb?: Callback<T>): Multi
  • Echo the given string.

    Type parameters

    • T: string

    Parameters

    • message: T
    • Optional cb: Callback<T>

    Returns Multi

exec

  • exec(cb?: Callback<any[]>): boolean
  • Parameters

    • Optional cb: Callback<any[]>

    Returns boolean

exec_atomic

  • exec_atomic(cb?: Callback<any[]>): boolean
  • Parameters

    • Optional cb: Callback<any[]>

    Returns boolean

expire

  • expire(key: string, seconds: number, cb?: Callback<number>): Multi
  • Set a key's time to live in seconds.

    Parameters

    • key: string
    • seconds: number
    • Optional cb: Callback<number>

    Returns Multi

expireat

  • expireat(key: string, timestamp: number, cb?: Callback<number>): Multi
  • Set the expiration for a key as a UNIX timestamp.

    Parameters

    • key: string
    • timestamp: number
    • Optional cb: Callback<number>

    Returns Multi

flushall

  • flushall(cb?: Callback<string>): Multi
  • Remove all keys from all databases.

    Parameters

    • Optional cb: Callback<string>

    Returns Multi

flushdb

  • flushdb(cb?: Callback<string>): Multi
  • Remove all keys from the current database.

    Parameters

    • Optional cb: Callback<string>

    Returns Multi

get

  • get(key: string, cb?: Callback<string>): Multi
  • Get the value of a key.

    Parameters

    • key: string
    • Optional cb: Callback<string>

    Returns Multi

getbit

  • getbit(key: string, offset: number, cb?: Callback<number>): Multi
  • Returns the bit value at offset in the string value stored at key.

    Parameters

    • key: string
    • offset: number
    • Optional cb: Callback<number>

    Returns Multi

getrange

  • getrange(key: string, start: number, end: number, cb?: Callback<string>): Multi
  • Get a substring of the string stored at a key.

    Parameters

    • key: string
    • start: number
    • end: number
    • Optional cb: Callback<string>

    Returns Multi

getset

  • getset(key: string, value: string, cb?: Callback<string>): Multi
  • Set the string value of a key and return its old value.

    Parameters

    • key: string
    • value: string
    • Optional cb: Callback<string>

    Returns Multi

hexists

  • hexists(key: string, field: string, cb?: Callback<number>): Multi
  • Determine if a hash field exists.

    Parameters

    • key: string
    • field: string
    • Optional cb: Callback<number>

    Returns Multi

hget

  • hget(key: string, field: string, cb?: Callback<string>): Multi
  • Get the value of a hash field.

    Parameters

    • key: string
    • field: string
    • Optional cb: Callback<string>

    Returns Multi

hgetall

  • hgetall(key: string, cb?: Callback<object>): Multi
  • Get all fields and values in a hash.

    Parameters

    • key: string
    • Optional cb: Callback<object>

    Returns Multi

hincrby

  • hincrby(key: string, field: string, increment: number, cb?: Callback<number>): Multi
  • Increment the integer value of a hash field by the given number.

    Parameters

    • key: string
    • field: string
    • increment: number
    • Optional cb: Callback<number>

    Returns Multi

hincrbyfloat

  • hincrbyfloat(key: string, field: string, increment: number, cb?: Callback<number>): Multi
  • Increment the float value of a hash field by the given amount.

    Parameters

    • key: string
    • field: string
    • increment: number
    • Optional cb: Callback<number>

    Returns Multi

hkeys

  • hkeys(key: string, cb?: Callback<string[]>): Multi
  • Get all the fields of a hash.

    Parameters

    • key: string
    • Optional cb: Callback<string[]>

    Returns Multi

hlen

  • hlen(key: string, cb?: Callback<number>): Multi
  • Get the number of fields in a hash.

    Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

hset

  • hset(key: string, field: string, value: string, cb?: Callback<number>): Multi
  • Set the string value of a hash field.

    Parameters

    • key: string
    • field: string
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

hsetnx

  • hsetnx(key: string, field: string, value: string, cb?: Callback<number>): Multi
  • Set the value of a hash field, only if the field does not exist.

    Parameters

    • key: string
    • field: string
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

hstrlen

  • hstrlen(key: string, field: string, cb?: Callback<number>): Multi
  • Get the length of the value of a hash field.

    Parameters

    • key: string
    • field: string
    • Optional cb: Callback<number>

    Returns Multi

hvals

  • hvals(key: string, cb?: Callback<string[]>): Multi
  • Get all the values of a hash.

    Parameters

    • key: string
    • Optional cb: Callback<string[]>

    Returns Multi

incr

  • incr(key: string, cb?: Callback<number>): Multi
  • Increment the integer value of a key by one.

    Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

incrby

  • incrby(key: string, increment: number, cb?: Callback<number>): Multi
  • Increment the integer value of a key by the given amount.

    Parameters

    • key: string
    • increment: number
    • Optional cb: Callback<number>

    Returns Multi

incrbyfloat

  • incrbyfloat(key: string, increment: number, cb?: Callback<number>): Multi
  • Increment the float value of a key by the given amount.

    Parameters

    • key: string
    • increment: number
    • Optional cb: Callback<number>

    Returns Multi

info

  • info(cb?: Callback<ServerInfo>): Multi
  • info(section?: string | string[], cb?: Callback<ServerInfo>): Multi
  • Get information and statistics about the server.

    Parameters

    • Optional cb: Callback<ServerInfo>

    Returns Multi

  • Parameters

    • Optional section: string | string[]
    • Optional cb: Callback<ServerInfo>

    Returns Multi

keys

  • keys(pattern: string, cb?: Callback<string[]>): Multi
  • Find all keys matching the given pattern.

    Parameters

    • pattern: string
    • Optional cb: Callback<string[]>

    Returns Multi

lastsave

  • lastsave(cb?: Callback<number>): Multi
  • Get the UNIX time stamp of the last successful save to disk.

    Parameters

    • Optional cb: Callback<number>

    Returns Multi

lindex

  • lindex(key: string, index: number, cb?: Callback<string>): Multi
  • Get an element from a list by its index.

    Parameters

    • key: string
    • index: number
    • Optional cb: Callback<string>

    Returns Multi

linsert

  • linsert(key: string, dir: "BEFORE" | "AFTER", pivot: string, value: string, cb?: Callback<string>): Multi
  • Insert an element before or after another element in a list.

    Parameters

    • key: string
    • dir: "BEFORE" | "AFTER"
    • pivot: string
    • value: string
    • Optional cb: Callback<string>

    Returns Multi

llen

  • llen(key: string, cb?: Callback<number>): Multi
  • Get the length of a list.

    Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

lpop

  • lpop(key: string, cb?: Callback<string>): Multi
  • Remove and get the first element in a list.

    Parameters

    • key: string
    • Optional cb: Callback<string>

    Returns Multi

lpushx

  • lpushx(key: string, value: string, cb?: Callback<number>): Multi
  • Prepend a value to a list, only if the list exists.

    Parameters

    • key: string
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

lrange

  • lrange(key: string, start: number, stop: number, cb?: Callback<string[]>): Multi
  • Get a range of elements from a list.

    Parameters

    • key: string
    • start: number
    • stop: number
    • Optional cb: Callback<string[]>

    Returns Multi

lrem

  • lrem(key: string, count: number, value: string, cb?: Callback<number>): Multi
  • Remove elements from a list.

    Parameters

    • key: string
    • count: number
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

lset

  • lset(key: string, index: number, value: string, cb?: Callback<"OK">): Multi
  • Set the value of an element in a list by its index.

    Parameters

    • key: string
    • index: number
    • value: string
    • Optional cb: Callback<"OK">

    Returns Multi

ltrim

  • ltrim(key: string, start: number, stop: number, cb?: Callback<"OK">): Multi
  • Trim a list to the specified range.

    Parameters

    • key: string
    • start: number
    • stop: number
    • Optional cb: Callback<"OK">

    Returns Multi

monitor

  • monitor(cb?: Callback<undefined>): Multi
  • Listen for all requests received by the server in real time.

    Parameters

    • Optional cb: Callback<undefined>

    Returns Multi

move

  • move(key: string, db: string | number): Multi
  • Move a key to another database.

    Parameters

    • key: string
    • db: string | number

    Returns Multi

persist

  • persist(key: string, cb?: Callback<number>): Multi
  • Remove the expiration from a key.

    Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

pexpire

  • pexpire(key: string, milliseconds: number, cb?: Callback<number>): Multi
  • Remove a key's time to live in milliseconds.

    Parameters

    • key: string
    • milliseconds: number
    • Optional cb: Callback<number>

    Returns Multi

pexpireat

  • pexpireat(key: string, millisecondsTimestamp: number, cb?: Callback<number>): Multi
  • Set the expiration for a key as a UNIX timestamp specified in milliseconds.

    Parameters

    • key: string
    • millisecondsTimestamp: number
    • Optional cb: Callback<number>

    Returns Multi

ping

  • ping(callback?: Callback<string>): Multi
  • ping(message: string, callback?: Callback<string>): Multi
  • Ping the server.

    Parameters

    • Optional callback: Callback<string>

    Returns Multi

  • Parameters

    • message: string
    • Optional callback: Callback<string>

    Returns Multi

psetex

  • psetex(key: string, milliseconds: number, value: string, cb?: Callback<"OK">): Multi
  • Set the value and expiration in milliseconds of a key.

    Parameters

    • key: string
    • milliseconds: number
    • value: string
    • Optional cb: Callback<"OK">

    Returns Multi

pttl

  • pttl(key: string, cb?: Callback<number>): Multi
  • Get the time to live for a key in milliseconds.

    Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

publish

  • publish(channel: string, value: string, cb?: Callback<number>): Multi
  • Post a message to a channel.

    Parameters

    • channel: string
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

quit

  • quit(cb?: Callback<"OK">): Multi
  • Close the connection.

    Parameters

    • Optional cb: Callback<"OK">

    Returns Multi

randomkey

  • randomkey(cb?: Callback<string>): Multi
  • Return a random key from the keyspace.

    Parameters

    • Optional cb: Callback<string>

    Returns Multi

readonly

  • readonly(cb?: Callback<string>): Multi
  • Enables read queries for a connection to a cluster slave node.

    Parameters

    • Optional cb: Callback<string>

    Returns Multi

readwrite

  • readwrite(cb?: Callback<string>): Multi
  • Disables read queries for a connection to cluster slave node.

    Parameters

    • Optional cb: Callback<string>

    Returns Multi

rename

  • rename(key: string, newkey: string, cb?: Callback<"OK">): Multi
  • Rename a key.

    Parameters

    • key: string
    • newkey: string
    • Optional cb: Callback<"OK">

    Returns Multi

renamenx

  • renamenx(key: string, newkey: string, cb?: Callback<number>): Multi
  • Rename a key, only if the new key does not exist.

    Parameters

    • key: string
    • newkey: string
    • Optional cb: Callback<number>

    Returns Multi

restore

  • restore(key: string, ttl: number, serializedValue: string, cb?: Callback<"OK">): Multi
  • Create a key using the provided serialized value, previously obtained using DUMP.

    Parameters

    • key: string
    • ttl: number
    • serializedValue: string
    • Optional cb: Callback<"OK">

    Returns Multi

role

  • role(cb?: Callback<[string, number, Array<[string, string, string]>]>): Multi
  • Return the role of the instance in the context of replication.

    Parameters

    • Optional cb: Callback<[string, number, Array<[string, string, string]>]>

    Returns Multi

rpop

  • rpop(key: string, cb?: Callback<string>): Multi
  • Remove and get the last element in a list.

    Parameters

    • key: string
    • Optional cb: Callback<string>

    Returns Multi

rpoplpush

  • rpoplpush(source: string, destination: string, cb?: Callback<string>): Multi
  • Remove the last element in a list, prepend it to another list and return it.

    Parameters

    • source: string
    • destination: string
    • Optional cb: Callback<string>

    Returns Multi

rpushx

  • rpushx(key: string, value: string, cb?: Callback<number>): Multi
  • Append a value to a list, only if the list exists.

    Parameters

    • key: string
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

save

  • save(cb?: Callback<string>): Multi
  • Synchronously save the dataset to disk.

    Parameters

    • Optional cb: Callback<string>

    Returns Multi

scard

  • scard(key: string, cb?: Callback<number>): Multi
  • Get the number of members in a set.

    Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

select

  • select(index: number | string, cb?: Callback<string>): Multi
  • Change the selected database for the current connection.

    Parameters

    • index: number | string
    • Optional cb: Callback<string>

    Returns Multi

set

  • set(key: string, value: string, cb?: Callback<"OK">): Multi
  • set(key: string, value: string, flag: string, cb?: Callback<"OK">): Multi
  • set(key: string, value: string, mode: string, duration: number, cb?: Callback<"OK" | undefined>): Multi
  • set(key: string, value: string, mode: string, duration: number, flag: string, cb?: Callback<"OK" | undefined>): Multi
  • Set the string value of a key.

    Parameters

    • key: string
    • value: string
    • Optional cb: Callback<"OK">

    Returns Multi

  • Parameters

    • key: string
    • value: string
    • flag: string
    • Optional cb: Callback<"OK">

    Returns Multi

  • Parameters

    • key: string
    • value: string
    • mode: string
    • duration: number
    • Optional cb: Callback<"OK" | undefined>

    Returns Multi

  • Parameters

    • key: string
    • value: string
    • mode: string
    • duration: number
    • flag: string
    • Optional cb: Callback<"OK" | undefined>

    Returns Multi

setbit

  • setbit(key: string, offset: number, value: string, cb?: Callback<number>): Multi
  • Sets or clears the bit at offset in the string value stored at key.

    Parameters

    • key: string
    • offset: number
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

setex

  • setex(key: string, seconds: number, value: string, cb?: Callback<string>): Multi
  • Set the value and expiration of a key.

    Parameters

    • key: string
    • seconds: number
    • value: string
    • Optional cb: Callback<string>

    Returns Multi

setnx

  • setnx(key: string, value: string, cb?: Callback<number>): Multi
  • Set the value of a key, only if the key does not exist.

    Parameters

    • key: string
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

setrange

  • setrange(key: string, offset: number, value: string, cb?: Callback<number>): Multi
  • Overwrite part of a string at key starting at the specified offset.

    Parameters

    • key: string
    • offset: number
    • value: string
    • Optional cb: Callback<number>

    Returns Multi

sismember

  • sismember(key: string, member: string, cb?: Callback<number>): Multi
  • Determine if a given value is a member of a set.

    Parameters

    • key: string
    • member: string
    • Optional cb: Callback<number>

    Returns Multi

slaveof

  • slaveof(host: string, port: string | number, cb?: Callback<string>): Multi
  • Make the server a slave of another instance, or promote it as master.

    Parameters

    • host: string
    • port: string | number
    • Optional cb: Callback<string>

    Returns Multi

smembers

  • smembers(key: string, cb?: Callback<string[]>): Multi
  • Get all the members in a set.

    Parameters

    • key: string
    • Optional cb: Callback<string[]>

    Returns Multi

smove

  • smove(source: string, destination: string, member: string, cb?: Callback<number>): Multi
  • Move a member from one set to another.

    Parameters

    • source: string
    • destination: string
    • member: string
    • Optional cb: Callback<number>

    Returns Multi

spop

  • spop(key: string, cb?: Callback<string>): Multi
  • spop(key: string, count: number, cb?: Callback<string[]>): Multi
  • Remove and return one or multiple random members from a set.

    Parameters

    • key: string
    • Optional cb: Callback<string>

    Returns Multi

  • Parameters

    • key: string
    • count: number
    • Optional cb: Callback<string[]>

    Returns Multi

srandmember

  • srandmember(key: string, cb?: Callback<string>): Multi
  • srandmember(key: string, count: number, cb?: Callback<string[]>): Multi
  • Get one or multiple random members from a set.

    Parameters

    • key: string
    • Optional cb: Callback<string>

    Returns Multi

  • Parameters

    • key: string
    • count: number
    • Optional cb: Callback<string[]>

    Returns Multi

strlen

  • strlen(key: string, cb?: Callback<number>): Multi
  • Get the length of the value stored in a key.

    Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

sync

  • sync(cb?: Callback<undefined>): Multi
  • Internal command used for replication.

    Parameters

    • Optional cb: Callback<undefined>

    Returns Multi

time

  • time(cb?: Callback<[string, string]>): Multi
  • Return the current server time.

    Parameters

    • Optional cb: Callback<[string, string]>

    Returns Multi

ttl

  • ttl(key: string, cb?: Callback<number>): Multi
  • Get the time to live for a key.

    Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

type

  • type(key: string, cb?: Callback<string>): Multi
  • Determine the type stored at key.

    Parameters

    • key: string
    • Optional cb: Callback<string>

    Returns Multi

unwatch

  • unwatch(cb?: Callback<"OK">): Multi
  • Forget about all watched keys.

    Parameters

    • Optional cb: Callback<"OK">

    Returns Multi

wait

  • wait(numslaves: number, timeout: number, cb?: Callback<number>): Multi
  • Wait for the synchronous replication of all the write commands sent in the context of the current connection.

    Parameters

    • numslaves: number
    • timeout: number
    • Optional cb: Callback<number>

    Returns Multi

zcard

  • zcard(key: string, cb?: Callback<number>): Multi
  • Get the number of members in a sorted set.

    Parameters

    • key: string
    • Optional cb: Callback<number>

    Returns Multi

zcount

  • zcount(key: string, min: number | string, max: number | string, cb?: Callback<number>): Multi
  • Count the members in a sorted set with scores between the given values.

    Parameters

    • key: string
    • min: number | string
    • max: number | string
    • Optional cb: Callback<number>

    Returns Multi

zincrby

  • zincrby(key: string, increment: number, member: string, cb?: Callback<number>): Multi
  • Increment the score of a member in a sorted set.

    Parameters

    • key: string
    • increment: number
    • member: string
    • Optional cb: Callback<number>

    Returns Multi

zlexcount

  • zlexcount(key: string, min: string, max: string, cb?: Callback<number>): Multi
  • Count the number of members in a sorted set between a given lexicographic range.

    Parameters

    • key: string
    • min: string
    • max: string
    • Optional cb: Callback<number>

    Returns Multi

zrange

  • zrange(key: string, start: number, stop: number, cb?: Callback<string[]>): Multi
  • zrange(key: string, start: number, stop: number, withscores: string, cb?: Callback<string[]>): Multi
  • Return a range of members in a sorted set, by index.

    Parameters

    • key: string
    • start: number
    • stop: number
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • start: number
    • stop: number
    • withscores: string
    • Optional cb: Callback<string[]>

    Returns Multi

zrangebylex

  • zrangebylex(key: string, min: string, max: string, cb?: Callback<string[]>): Multi
  • zrangebylex(key: string, min: string, max: string, limit: string, offset: number, count: number, cb?: Callback<string[]>): Multi
  • Return a range of members in a sorted set, by lexicographical range.

    Parameters

    • key: string
    • min: string
    • max: string
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • min: string
    • max: string
    • limit: string
    • offset: number
    • count: number
    • Optional cb: Callback<string[]>

    Returns Multi

zrangebyscore

  • zrangebyscore(key: string, min: number | string, max: number | string, cb?: Callback<string[]>): Multi
  • zrangebyscore(key: string, min: number | string, max: number | string, withscores: string, cb?: Callback<string[]>): Multi
  • zrangebyscore(key: string, min: number | string, max: number | string, limit: string, offset: number, count: number, cb?: Callback<string[]>): Multi
  • zrangebyscore(key: string, min: number | string, max: number | string, withscores: string, limit: string, offset: number, count: number, cb?: Callback<string[]>): Multi
  • Return a range of members in a sorted set, by score.

    Parameters

    • key: string
    • min: number | string
    • max: number | string
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • min: number | string
    • max: number | string
    • withscores: string
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • min: number | string
    • max: number | string
    • limit: string
    • offset: number
    • count: number
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • min: number | string
    • max: number | string
    • withscores: string
    • limit: string
    • offset: number
    • count: number
    • Optional cb: Callback<string[]>

    Returns Multi

zrank

  • zrank(key: string, member: string, cb?: Callback<number | undefined>): Multi
  • Determine the index of a member in a sorted set.

    Parameters

    • key: string
    • member: string
    • Optional cb: Callback<number | undefined>

    Returns Multi

zremrangebylex

  • zremrangebylex(key: string, min: string, max: string, cb?: Callback<number>): Multi
  • Remove all members in a sorted set between the given lexicographical range.

    Parameters

    • key: string
    • min: string
    • max: string
    • Optional cb: Callback<number>

    Returns Multi

zremrangebyrank

  • zremrangebyrank(key: string, start: number, stop: number, cb?: Callback<number>): Multi
  • Remove all members in a sorted set within the given indexes.

    Parameters

    • key: string
    • start: number
    • stop: number
    • Optional cb: Callback<number>

    Returns Multi

zremrangebyscore

  • zremrangebyscore(key: string, min: string | number, max: string | number, cb?: Callback<number>): Multi
  • Remove all members in a sorted set within the given indexes.

    Parameters

    • key: string
    • min: string | number
    • max: string | number
    • Optional cb: Callback<number>

    Returns Multi

zrevrange

  • zrevrange(key: string, start: number, stop: number, cb?: Callback<string[]>): Multi
  • zrevrange(key: string, start: number, stop: number, withscores: string, cb?: Callback<string[]>): Multi
  • Return a range of members in a sorted set, by index, with scores ordered from high to low.

    Parameters

    • key: string
    • start: number
    • stop: number
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • start: number
    • stop: number
    • withscores: string
    • Optional cb: Callback<string[]>

    Returns Multi

zrevrangebylex

  • zrevrangebylex(key: string, min: string, max: string, cb?: Callback<string[]>): Multi
  • zrevrangebylex(key: string, min: string, max: string, limit: string, offset: number, count: number, cb?: Callback<string[]>): Multi
  • Return a range of members in a sorted set, by lexicographical range, ordered from higher to lower strings.

    Parameters

    • key: string
    • min: string
    • max: string
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • min: string
    • max: string
    • limit: string
    • offset: number
    • count: number
    • Optional cb: Callback<string[]>

    Returns Multi

zrevrangebyscore

  • zrevrangebyscore(key: string, min: number | string, max: number | string, cb?: Callback<string[]>): Multi
  • zrevrangebyscore(key: string, min: number | string, max: number | string, withscores: string, cb?: Callback<string[]>): Multi
  • zrevrangebyscore(key: string, min: number | string, max: number | string, limit: string, offset: number, count: number, cb?: Callback<string[]>): Multi
  • zrevrangebyscore(key: string, min: number | string, max: number | string, withscores: string, limit: string, offset: number, count: number, cb?: Callback<string[]>): Multi
  • Return a range of members in a sorted set, by score, with scores ordered from high to low.

    Parameters

    • key: string
    • min: number | string
    • max: number | string
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • min: number | string
    • max: number | string
    • withscores: string
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • min: number | string
    • max: number | string
    • limit: string
    • offset: number
    • count: number
    • Optional cb: Callback<string[]>

    Returns Multi

  • Parameters

    • key: string
    • min: number | string
    • max: number | string
    • withscores: string
    • limit: string
    • offset: number
    • count: number
    • Optional cb: Callback<string[]>

    Returns Multi

zrevrank

  • zrevrank(key: string, member: string, cb?: Callback<number | undefined>): Multi
  • Determine the index of a member in a sorted set, with scores ordered from high to low.

    Parameters

    • key: string
    • member: string
    • Optional cb: Callback<number | undefined>

    Returns Multi

zscore

  • zscore(key: string, member: string, cb?: Callback<string>): Multi
  • Get the score associated with the given member in a sorted set.

    Parameters

    • key: string
    • member: string
    • Optional cb: Callback<string>

    Returns Multi