![\"TypeScript](\"resources/ts-screenshot.png\")
\n\n# Versions\n\n| Version | Branch | Node.js Version | Redis Version |\n| -------------- | ------ | --------------- | --------------- |\n| 5.x.x (latest) | main | >= 12 | 2.6.12 ~ latest |\n| 4.x.x | v4 | >= 8 | 2.6.12 ~ 7 |\n\nRefer to [CHANGELOG.md](CHANGELOG.md) for features and bug fixes introduced in v5.\n\nπ [Upgrading from v4 to v5](https://github.com/redis/ioredis/wiki/Upgrading-from-v4-to-v5)\n\n# Links\n\n- [API Documentation](https://redis.github.io/ioredis/) ([Redis](https://redis.github.io/ioredis/classes/Redis.html), [Cluster](https://redis.github.io/ioredis/classes/Cluster.html))\n- [Changelog](CHANGELOG.md)\n\nOtherwise, `ready` will be emitted immediately right after the `connect` event. |\n| error | emits when an error occurs while connecting.
However, ioredis emits all `error` events silently (only emits when there's at least one listener) so that your application won't crash if you're not listening to the `error` event.
When `redis.connect()` is explicitly called the error will also be rejected from the returned promise, in addition to emitting it. If `redis.connect()` is not called explicitly and `lazyConnect` is true, ioredis will try to connect automatically on the first command and emit the `error` event silently. |\n| close | emits when an established Redis server connection has closed. |\n| reconnecting | emits after `close` when a reconnection will be made. The argument of the event is the time (in ms) before reconnecting. |\n| end | emits after `close` when no more reconnections will be made, or the connection is failed to establish. |\n| wait | emits when `lazyConnect` is set and will wait for the first command to be called before connecting. |\n\nYou can also check out the `Redis#status` property to get the current connection status.\n\nBesides the above connection events, there are several other custom events:\n\n| Event | Description |\n| :----- | :------------------------------------------------------------------ |\n| select | emits when the database changed. The argument is the new db number. |\n\n## Offline Queue\n\nWhen a command can't be processed by Redis (being sent before the `ready` event), by default, it's added to the offline queue and will be\nexecuted when it can be processed. You can disable this feature by setting the `enableOfflineQueue`\noption to `false`:\n\n```javascript\nconst redis = new Redis({ enableOfflineQueue: false });\n```\n\n## TLS Options\n\nRedis doesn't support TLS natively, however if the redis server you want to connect to is hosted behind a TLS proxy (e.g. [stunnel](https://www.stunnel.org/)) or is offered by a PaaS service that supports TLS connection (e.g. [Redis.com](https://redis.com/)), you can set the `tls` option:\n\n```javascript\nconst redis = new Redis({\n host: \"localhost\",\n tls: {\n // Refer to `tls.connect()` section in\n // https://nodejs.org/api/tls.html\n // for all supported options\n ca: fs.readFileSync(\"cert.pem\"),\n },\n});\n```\n\nAlternatively, specify the connection through a [`rediss://` URL](https://www.iana.org/assignments/uri-schemes/prov/rediss).\n\n```javascript\nconst redis = new Redis(\"rediss://redis.my-service.com\");\n```\n\nIf you do not want to use a connection string, you can also specify an empty `tls: {}` object:\n\n```javascript\nconst redis = new Redis({\n host: \"redis.my-service.com\",\n tls: {},\n});\n```\n\n### TLS Profiles\n\n> **Warning**\n> TLS profiles described in this section are going to be deprecated in the next major version. Please provide TLS options explicitly.\n\nTo make it easier to configure we provide a few pre-configured TLS profiles that can be specified by setting the `tls` option to the profile's name or specifying a `tls.profile` option in case you need to customize some values of the profile.\n\nProfiles:\n\n- `RedisCloudFixed`: Contains the CA for [Redis.com](https://redis.com/) Cloud fixed subscriptions\n- `RedisCloudFlexible`: Contains the CA for [Redis.com](https://redis.com/) Cloud flexible subscriptions\n\n```javascript\nconst redis = new Redis({\n host: \"localhost\",\n tls: \"RedisCloudFixed\",\n});\n\nconst redisWithClientCertificate = new Redis({\n host: \"localhost\",\n tls: {\n profile: \"RedisCloudFixed\",\n key: \"123\",\n },\n});\n```\n\n
\n\n## Sentinel\n\nioredis supports Sentinel out of the box. It works transparently as all features that work when\nyou connect to a single node also work when you connect to a sentinel group. Make sure to run Redis >= 2.8.12 if you want to use this feature. Sentinels have a default port of 26379.\n\nTo connect using Sentinel, use:\n\n```javascript\nconst redis = new Redis({\n sentinels: [\n { host: \"localhost\", port: 26379 },\n { host: \"localhost\", port: 26380 },\n ],\n name: \"mymaster\",\n});\n\nredis.set(\"foo\", \"bar\");\n```\n\nThe arguments passed to the constructor are different from the ones you use to connect to a single node, where:\n\n- `name` identifies a group of Redis instances composed of a master and one or more slaves (`mymaster` in the example);\n- `sentinelPassword` (optional) password for Sentinel instances.\n- `sentinels` are a list of sentinels to connect to. The list does not need to enumerate all your sentinel instances, but a few so that if one is down the client will try the next one.\n- `role` (optional) with a value of `slave` will return a random slave from the Sentinel group.\n- `preferredSlaves` (optional) can be used to prefer a particular slave or set of slaves based on priority. It accepts a function or array.\n- `enableTLSForSentinelMode` (optional) set to true if connecting to sentinel instances that are encrypted\n\nioredis **guarantees** that the node you connected to is always a master even after a failover. When a failover happens, instead of trying to reconnect to the failed node (which will be demoted to slave when it's available again), ioredis will ask sentinels for the new master node and connect to it. All commands sent during the failover are queued and will be executed when the new connection is established so that none of the commands will be lost.\n\nIt's possible to connect to a slave instead of a master by specifying the option `role` with the value of `slave` and ioredis will try to connect to a random slave of the specified master, with the guarantee that the connected node is always a slave. If the current node is promoted to master due to a failover, ioredis will disconnect from it and ask the sentinels for another slave node to connect to.\n\nIf you specify the option `preferredSlaves` along with `role: 'slave'` ioredis will attempt to use this value when selecting the slave from the pool of available slaves. The value of `preferredSlaves` should either be a function that accepts an array of available slaves and returns a single result, or an array of slave values priorities by the lowest `prio` value first with a default value of `1`.\n\n```javascript\n// available slaves format\nconst availableSlaves = [{ ip: \"127.0.0.1\", port: \"31231\", flags: \"slave\" }];\n\n// preferredSlaves array format\nlet preferredSlaves = [\n { ip: \"127.0.0.1\", port: \"31231\", prio: 1 },\n { ip: \"127.0.0.1\", port: \"31232\", prio: 2 },\n];\n\n// preferredSlaves function format\npreferredSlaves = function (availableSlaves) {\n for (let i = 0; i < availableSlaves.length; i++) {\n const slave = availableSlaves[i];\n if (slave.ip === \"127.0.0.1\") {\n if (slave.port === \"31234\") {\n return slave;\n }\n }\n }\n // if no preferred slaves are available a random one is used\n return false;\n};\n\nconst redis = new Redis({\n sentinels: [\n { host: \"127.0.0.1\", port: 26379 },\n { host: \"127.0.0.1\", port: 26380 },\n ],\n name: \"mymaster\",\n role: \"slave\",\n preferredSlaves: preferredSlaves,\n});\n```\n\nBesides the `retryStrategy` option, there's also a `sentinelRetryStrategy` in Sentinel mode which will be invoked when all the sentinel nodes are unreachable during connecting. If `sentinelRetryStrategy` returns a valid delay time, ioredis will try to reconnect from scratch. The default value of `sentinelRetryStrategy` is:\n\n```javascript\nfunction (times) {\n const delay = Math.min(times * 10, 1000);\n return delay;\n}\n```\n\n## Cluster\n\nRedis Cluster provides a way to run a Redis installation where data is automatically sharded across multiple Redis nodes.\nYou can connect to a Redis Cluster like this:\n\n```javascript\nconst Redis = require(\"ioredis\");\n\nconst cluster = new Redis.Cluster([\n {\n port: 6380,\n host: \"127.0.0.1\",\n },\n {\n port: 6381,\n host: \"127.0.0.1\",\n },\n]);\n\ncluster.set(\"foo\", \"bar\");\ncluster.get(\"foo\", (err, res) => {\n // res === 'bar'\n});\n```\n\n`Cluster` constructor accepts two arguments, where:\n\n0. The first argument is a list of nodes of the cluster you want to connect to.\n Just like Sentinel, the list does not need to enumerate all your cluster nodes,\n but a few so that if one is unreachable the client will try the next one, and the client will discover other nodes automatically when at least one node is connected.\n1. The second argument is the options, where:\n\n - `clusterRetryStrategy`: When none of the startup nodes are reachable, `clusterRetryStrategy` will be invoked. When a number is returned,\n ioredis will try to reconnect to the startup nodes from scratch after the specified delay (in ms). Otherwise, an error of \"None of startup nodes is available\" will be returned.\n The default value of this option is:\n\n ```javascript\n function (times) {\n const delay = Math.min(100 + times * 2, 2000);\n return delay;\n }\n ```\n\n It's possible to modify the `startupNodes` property in order to switch to another set of nodes here:\n\n ```javascript\n function (times) {\n this.startupNodes = [{ port: 6790, host: '127.0.0.1' }];\n return Math.min(100 + times * 2, 2000);\n }\n ```\n\n - `dnsLookup`: Alternative DNS lookup function (`dns.lookup()` is used by default). It may be useful to override this in special cases, such as when AWS ElastiCache used with TLS enabled.\n - `enableOfflineQueue`: Similar to the `enableOfflineQueue` option of `Redis` class.\n - `enableReadyCheck`: When enabled, \"ready\" event will only be emitted when `CLUSTER INFO` command\n reporting the cluster is ready for handling commands. Otherwise, it will be emitted immediately after \"connect\" is emitted.\n - `scaleReads`: Config where to send the read queries. See below for more details.\n - `maxRedirections`: When a cluster related error (e.g. `MOVED`, `ASK` and `CLUSTERDOWN` etc.) is received, the client will redirect the\n command to another node. This option limits the max redirections allowed when sending a command. The default value is `16`.\n - `retryDelayOnFailover`: If the target node is disconnected when sending a command,\n ioredis will retry after the specified delay. The default value is `100`. You should make sure `retryDelayOnFailover * maxRedirections > cluster-node-timeout`\n to insure that no command will fail during a failover.\n - `retryDelayOnClusterDown`: When a cluster is down, all commands will be rejected with the error of `CLUSTERDOWN`. If this option is a number (by default, it is `100`), the client\n will resend the commands after the specified time (in ms).\n - `retryDelayOnTryAgain`: If this option is a number (by default, it is `100`), the client\n will resend the commands rejected with `TRYAGAIN` error after the specified time (in ms).\n - `retryDelayOnMoved`: By default, this value is `0` (in ms), which means when a `MOVED` error is received, the client will resend\n the command instantly to the node returned together with the `MOVED` error. However, sometimes it takes time for a cluster to become\n state stabilized after a failover, so adding a delay before resending can prevent a ping pong effect.\n - `redisOptions`: Default options passed to the constructor of `Redis` when connecting to a node.\n - `slotsRefreshTimeout`: Milliseconds before a timeout occurs while refreshing slots from the cluster (default `1000`).\n - `slotsRefreshInterval`: Milliseconds between every automatic slots refresh (by default, it is disabled).\n\n### Read-Write Splitting\n\nA typical redis cluster contains three or more masters and several slaves for each master. It's possible to scale out redis cluster by sending read queries to slaves and write queries to masters by setting the `scaleReads` option.\n\n`scaleReads` is \"master\" by default, which means ioredis will never send any queries to slaves. There are other three available options:\n\n1. \"all\": Send write queries to masters and read queries to masters or slaves randomly.\n2. \"slave\": Send write queries to masters and read queries to slaves.\n3. a custom `function(nodes, command): node`: Will choose the custom function to select to which node to send read queries (write queries keep being sent to master). The first node in `nodes` is always the master serving the relevant slots. If the function returns an array of nodes, a random node of that list will be selected.\n\nFor example:\n\n```javascript\nconst cluster = new Redis.Cluster(\n [\n /* nodes */\n ],\n {\n scaleReads: \"slave\",\n }\n);\ncluster.set(\"foo\", \"bar\"); // This query will be sent to one of the masters.\ncluster.get(\"foo\", (err, res) => {\n // This query will be sent to one of the slaves.\n});\n```\n\n**NB** In the code snippet above, the `res` may not be equal to \"bar\" because of the lag of replication between the master and slaves.\n\n### Running Commands to Multiple Nodes\n\nEvery command will be sent to exactly one node. For commands containing keys, (e.g. `GET`, `SET` and `HGETALL`), ioredis sends them to the node that serving the keys, and for other commands not containing keys, (e.g. `INFO`, `KEYS` and `FLUSHDB`), ioredis sends them to a random node.\n\nSometimes you may want to send a command to multiple nodes (masters or slaves) of the cluster, you can get the nodes via `Cluster#nodes()` method.\n\n`Cluster#nodes()` accepts a parameter role, which can be \"master\", \"slave\" and \"all\" (default), and returns an array of `Redis` instance. For example:\n\n```javascript\n// Send `FLUSHDB` command to all slaves:\nconst slaves = cluster.nodes(\"slave\");\nPromise.all(slaves.map((node) => node.flushdb()));\n\n// Get keys of all the masters:\nconst masters = cluster.nodes(\"master\");\nPromise.all(\n masters\n .map((node) => node.keys())\n .then((keys) => {\n // keys: [['key1', 'key2'], ['key3', 'key4']]\n })\n);\n```\n\n### NAT Mapping\n\nSometimes the cluster is hosted within a internal network that can only be accessed via a NAT (Network Address Translation) instance. See [Accessing ElastiCache from outside AWS](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/accessing-elasticache.html) as an example.\n\nYou can specify nat mapping rules via `natMap` option:\n\n```javascript\nconst cluster = new Redis.Cluster(\n [\n {\n host: \"203.0.113.73\",\n port: 30001,\n },\n ],\n {\n natMap: {\n \"10.0.1.230:30001\": { host: \"203.0.113.73\", port: 30001 },\n \"10.0.1.231:30001\": { host: \"203.0.113.73\", port: 30002 },\n \"10.0.1.232:30001\": { host: \"203.0.113.73\", port: 30003 },\n },\n }\n);\n```\n\nOr you can specify this parameter through function:\n```javascript\nconst cluster = new Redis.Cluster(\n [\n {\n host: \"203.0.113.73\",\n port: 30001,\n },\n ],\n {\n natMap: (key) => {\n if(key.includes('30001')) {\n return { host: \"203.0.113.73\", port: 30001 };\n }\n\n return null;\n },\n }\n);\n```\n\nThis option is also useful when the cluster is running inside a Docker container.\nAlso it works for Clusters in cloud infrastructure where cluster nodes connected through dedicated subnet.\n\nSpecifying through may be useful if you don't know concrete internal host and know only node port.\n\n### Transaction and Pipeline in Cluster Mode\n\nAlmost all features that are supported by `Redis` are also supported by `Redis.Cluster`, e.g. custom commands, transaction and pipeline.\nHowever there are some differences when using transaction and pipeline in Cluster mode:\n\n0. All keys in a pipeline should belong to slots served by the same node, since ioredis sends all commands in a pipeline to the same node.\n1. You can't use `multi` without pipeline (aka `cluster.multi({ pipeline: false })`). This is because when you call `cluster.multi({ pipeline: false })`, ioredis doesn't know which node the `multi` command should be sent to.\n\nWhen any commands in a pipeline receives a `MOVED` or `ASK` error, ioredis will resend the whole pipeline to the specified node automatically if all of the following conditions are satisfied:\n\n0. All errors received in the pipeline are the same. For example, we won't resend the pipeline if we got two `MOVED` errors pointing to different nodes.\n1. All commands executed successfully are readonly commands. This makes sure that resending the pipeline won't have side effects.\n\n### Pub/Sub\n\nPub/Sub in cluster mode works exactly as the same as in standalone mode. Internally, when a node of the cluster receives a message, it will broadcast the message to the other nodes. ioredis makes sure that each message will only be received once by strictly subscribing one node at the same time.\n\n```javascript\nconst nodes = [\n /* nodes */\n];\nconst pub = new Redis.Cluster(nodes);\nconst sub = new Redis.Cluster(nodes);\nsub.on(\"message\", (channel, message) => {\n console.log(channel, message);\n});\n\nsub.subscribe(\"news\", () => {\n pub.publish(\"news\", \"highlights\");\n});\n```\n\n### Sharded Pub/Sub\n\nFor sharded Pub/Sub, use the `spublish` and `ssubscribe` commands instead of the traditional `publish` and `subscribe`. With the old commands, the Redis cluster handles message propagation behind the scenes, allowing you to publish or subscribe to any node without considering sharding. However, this approach has scalability limitations that are addressed with sharded Pub/Sub. Hereβs what you need to know:\n\n1. Instead of a single subscriber connection, there is now one subscriber connection per shard. Because of the potential overhead, you can enable or disable the use of the cluster subscriber group with the `shardedSubscribers` option. By default, this option is set to `false`, meaning sharded subscriptions are disabled. You should enable this option when establishing your cluster connection before using `ssubscribe`.\n2. All channel names that you pass to a single `ssubscribe` need to map to the same hash slot. You can call `ssubscribe` multiple times on the same cluster client instance to subscribe to channels across slots. The cluster's subscriber group takes care of forwarding the `ssubscribe` command to the shard that is responsible for the channels.\n\nThe following basic example shows you how to use sharded Pub/Sub:\n\n```javascript\nconst cluster: Cluster = new Cluster([{host: host, port: port}], {shardedSubscribers: true});\n\n//Register the callback\ncluster.on(\"smessage\", (channel, message) => {\n console.log(message);\n});\n\n\n//Subscribe to the channels on the same slot\ncluster.ssubscribe(\"channel{my}:1\", \"channel{my}:2\").then( ( count: number ) => {\n console.log(count);\n}).catch( (err) => {\n console.log(err);\n});\n\n//Publish a message\ncluster.spublish(\"channel{my}:1\", \"This is a test message to my first channel.\").then((value: number) => {\n console.log(\"Published a message to channel{my}:1\");\n});\n```\n\n\n### Events\n\n| Event | Description |\n| :----------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| connect | emits when a connection is established to the Redis server. |\n| ready | emits when `CLUSTER INFO` reporting the cluster is able to receive commands (if `enableReadyCheck` is `true`) or immediately after `connect` event (if `enableReadyCheck` is false). |\n| error | emits when an error occurs while connecting with a property of `lastNodeError` representing the last node error received. This event is emitted silently (only emitting if there's at least one listener). |\n| close | emits when an established Redis server connection has closed. |\n| reconnecting | emits after `close` when a reconnection will be made. The argument of the event is the time (in ms) before reconnecting. |\n| end | emits after `close` when no more reconnections will be made. |\n| +node | emits when a new node is connected. |\n| -node | emits when a node is disconnected. |\n| node error | emits when an error occurs when connecting to a node. The second argument indicates the address of the node. |\n\n### Password\n\nSetting the `password` option to access password-protected clusters:\n\n```javascript\nconst Redis = require(\"ioredis\");\nconst cluster = new Redis.Cluster(nodes, {\n redisOptions: {\n password: \"your-cluster-password\",\n },\n});\n```\n\nIf some of nodes in the cluster using a different password, you should specify them in the first parameter:\n\n```javascript\nconst Redis = require(\"ioredis\");\nconst cluster = new Redis.Cluster(\n [\n // Use password \"password-for-30001\" for 30001\n { port: 30001, password: \"password-for-30001\" },\n // Don't use password when accessing 30002\n { port: 30002, password: null },\n // Other nodes will use \"fallback-password\"\n ],\n {\n redisOptions: {\n password: \"fallback-password\",\n },\n }\n);\n```\n\n### Special Note: Aws Elasticache Clusters with TLS\n\nAWS ElastiCache for Redis (Clustered Mode) supports TLS encryption. If you use\nthis, you may encounter errors with invalid certificates. To resolve this\nissue, construct the `Cluster` with the `dnsLookup` option as follows:\n\n```javascript\nconst cluster = new Redis.Cluster(\n [\n {\n host: \"clustercfg.myCluster.abcdefg.xyz.cache.amazonaws.com\",\n port: 6379,\n },\n ],\n {\n dnsLookup: (address, callback) => callback(null, address),\n redisOptions: {\n tls: {},\n },\n }\n);\n```\n\n
\n\n## Autopipelining\n\nIn standard mode, when you issue multiple commands, ioredis sends them to the server one by one. As described in Redis pipeline documentation, this is a suboptimal use of the network link, especially when such link is not very performant.\n\nThe TCP and network overhead negatively affects performance. Commands are stuck in the send queue until the previous ones are correctly delivered to the server. This is a problem known as Head-Of-Line blocking (HOL).\n\nioredis supports a feature called βauto pipeliningβ. It can be enabled by setting the option `enableAutoPipelining` to `true`. No other code change is necessary.\n\nIn auto pipelining mode, all commands issued during an event loop are enqueued in a pipeline automatically managed by ioredis. At the end of the iteration, the pipeline is executed and thus all commands are sent to the server at the same time.\n\nThis feature can dramatically improve throughput and avoids HOL blocking. In our benchmarks, the improvement was between 35% and 50%.\n\nWhile an automatic pipeline is executing, all new commands will be enqueued in a new pipeline which will be executed as soon as the previous finishes.\n\nWhen using Redis Cluster, one pipeline per node is created. Commands are assigned to pipelines according to which node serves the slot.\n\nA pipeline will thus contain commands using different slots but that ultimately are assigned to the same node.\n\nNote that the same slot limitation within a single command still holds, as it is a Redis limitation.\n\n### Example of Automatic Pipeline Enqueuing\n\nThis sample code uses ioredis with automatic pipeline enabled.\n\n```javascript\nconst Redis = require(\"./built\");\nconst http = require(\"http\");\n\nconst db = new Redis({ enableAutoPipelining: true });\n\nconst server = http.createServer((request, response) => {\n const key = new URL(request.url, \"https://localhost:3000/\").searchParams.get(\n \"key\"\n );\n\n db.get(key, (err, value) => {\n response.writeHead(200, { \"Content-Type\": \"text/plain\" });\n response.end(value);\n });\n});\n\nserver.listen(3000);\n```\n\nWhen Node receives requests, it schedules them to be processed in one or more iterations of the events loop.\n\nAll commands issued by requests processing during one iteration of the loop will be wrapped in a pipeline automatically created by ioredis.\n\nIn the example above, the pipeline will have the following contents:\n\n```\nGET key1\nGET key2\nGET key3\n...\nGET keyN\n```\n\nWhen all events in the current loop have been processed, the pipeline is executed and thus all commands are sent to the server at the same time.\n\nWhile waiting for pipeline response from Redis, Node will still be able to process requests. All commands issued by request handler will be enqueued in a new automatically created pipeline. This pipeline will not be sent to the server yet.\n\nAs soon as a previous automatic pipeline has received all responses from the server, the new pipeline is immediately sent without waiting for the events loop iteration to finish.\n\nThis approach increases the utilization of the network link, reduces the TCP overhead and idle times and therefore improves throughput.\n\n### Benchmarks\n\nHere's some of the results of our tests for a single node.\n\nEach iteration of the test runs 1000 random commands on the server.\n\n| | Samples | Result | Tolerance |\n| ------------------------- | ------- | ------------- | --------- |\n| default | 1000 | 174.62 op/sec | Β± 0.45 % |\n| enableAutoPipelining=true | 1500 | 233.33 op/sec | Β± 0.88 % |\n\nAnd here's the same test for a cluster of 3 masters and 3 replicas:\n\n| | Samples | Result | Tolerance |\n| ------------------------- | ------- | ------------- | --------- |\n| default | 1000 | 164.05 op/sec | Β± 0.42 % |\n| enableAutoPipelining=true | 3000 | 235.31 op/sec | Β± 0.94 % |\n\n# Error Handling\n\nAll the errors returned by the Redis server are instances of `ReplyError`, which can be accessed via `Redis`:\n\n```javascript\nconst Redis = require(\"ioredis\");\nconst redis = new Redis();\n// This command causes a reply error since the SET command requires two arguments.\nredis.set(\"foo\", (err) => {\n err instanceof Redis.ReplyError;\n});\n```\n\nThis is the error stack of the `ReplyError`:\n\n```\nReplyError: ERR wrong number of arguments for 'set' command\n at ReplyParser._parseResult (/app/node_modules/ioredis/lib/parsers/javascript.js:60:14)\n at ReplyParser.execute (/app/node_modules/ioredis/lib/parsers/javascript.js:178:20)\n at Socket.
![](\"https://opencollective.com/ioredis/contributors.svg?width=890&showBtn=false\")
\n\n# License\n\nMIT\n\n[](https://app.fossa.io/projects/git%2Bgithub.com%2Fluin%2Fioredis?ref=badge_large)\n"
},
{
"path": "benchmarks/autopipelining-cluster.ts",
"content": "import { cronometro } from \"cronometro\";\nimport { readFileSync } from \"fs\";\nimport { join } from \"path\";\nimport Cluster from \"../lib/cluster\";\n\nconst numNodes = parseInt(process.env.NODES || \"3\", 10);\nconst iterations = parseInt(process.env.ITERATIONS || \"10000\", 10);\nconst batchSize = parseInt(process.env.BATCH_SIZE || \"1000\", 10);\nconst keys = readFileSync(\n join(__dirname, `fixtures/cluster-${numNodes}.txt`),\n \"utf-8\"\n).split(\"\\n\");\nconst configuration = Array.from(Array(numNodes), (_, i) => ({\n host: \"127.0.0.1\",\n port: 30000 + i + 1,\n}));\nlet cluster;\n\nfunction command(): string {\n const choice = Math.random();\n\n if (choice < 0.3) {\n return \"ttl\";\n } else if (choice < 0.6) {\n return \"exists\";\n }\n\n return \"get\";\n}\n\nfunction test() {\n const index = Math.floor(Math.random() * keys.length);\n\n return Promise.all(\n Array.from(Array(batchSize)).map(() => cluster[command()](keys[index]))\n );\n}\n\nfunction after(cb) {\n cluster.quit();\n cb();\n}\n\ncronometro(\n {\n default: {\n test,\n before(cb) {\n cluster = new Cluster(configuration);\n\n cb();\n },\n after,\n },\n \"enableAutoPipelining=true\": {\n test,\n before(cb) {\n cluster = new Cluster(configuration, { enableAutoPipelining: true });\n cb();\n },\n after,\n },\n },\n {\n iterations,\n print: { compare: true },\n }\n);\n"
},
{
"path": "benchmarks/autopipelining-single.ts",
"content": "import { cronometro } from \"cronometro\";\nimport { readFileSync } from \"fs\";\nimport { join } from \"path\";\nimport Redis from \"../lib/Redis\";\n\nconst iterations = parseInt(process.env.ITERATIONS || \"10000\", 10);\nconst batchSize = parseInt(process.env.BATCH_SIZE || \"1000\", 10);\nconst keys = readFileSync(\n join(__dirname, \"fixtures/cluster-3.txt\"),\n \"utf-8\"\n).split(\"\\n\");\nlet redis;\n\nfunction command(): string {\n const choice = Math.random();\n\n if (choice < 0.3) {\n return \"ttl\";\n } else if (choice < 0.6) {\n return \"exists\";\n }\n\n return \"get\";\n}\n\nfunction test() {\n const index = Math.floor(Math.random() * keys.length);\n\n return Promise.all(\n Array.from(Array(batchSize)).map(() => redis[command()](keys[index]))\n );\n}\n\nfunction after(cb) {\n redis.quit();\n cb();\n}\n\ncronometro(\n {\n default: {\n test,\n before(cb) {\n redis = new Redis();\n\n cb();\n },\n after,\n },\n \"enableAutoPipelining=true\": {\n test,\n before(cb) {\n redis = new Redis({ enableAutoPipelining: true });\n cb();\n },\n after,\n },\n },\n {\n iterations,\n print: { compare: true },\n }\n);\n"
},
{
"path": "benchmarks/dropBuffer.ts",
"content": "import { cronometro } from \"cronometro\";\nimport Redis from \"../lib/Redis\";\n\nlet redis;\n\ncronometro(\n {\n default: {\n test() {\n return redis.set(\"foo\", \"bar\");\n },\n before(cb) {\n redis = new Redis();\n cb();\n },\n after(cb) {\n redis.quit();\n cb();\n },\n },\n \"dropBufferSupport=true\": {\n test() {\n return redis.set(\"foo\", \"bar\");\n },\n before(cb) {\n redis = new Redis({ dropBufferSupport: true });\n cb();\n },\n after(cb) {\n redis.quit();\n cb();\n },\n },\n },\n {\n print: { compare: true },\n }\n);\n"
},
{
"path": "benchmarks/errorStack.ts",
"content": "import { cronometro } from \"cronometro\";\nimport Redis from \"../lib/Redis\";\n\nlet redis;\n\ncronometro(\n {\n default: {\n test() {\n return redis.set(\"foo\", \"bar\");\n },\n before(cb) {\n redis = new Redis();\n cb();\n },\n after(cb) {\n redis.quit();\n cb();\n },\n },\n \"showFriendlyErrorStack=true\": {\n test() {\n return redis.set(\"foo\", \"bar\");\n },\n before(cb) {\n redis = new Redis({ showFriendlyErrorStack: true });\n cb();\n },\n after(cb) {\n redis.quit();\n cb();\n },\n },\n },\n {\n print: { compare: true },\n }\n);\n"
},
{
"path": "benchmarks/fixtures/generate.ts",
"content": "\"use strict\";\n\nconst start = process.hrtime.bigint();\n\nimport * as calculateSlot from \"cluster-key-slot\";\nimport { writeFileSync } from \"fs\";\nimport { join } from \"path\";\nimport { v4 as uuid } from \"uuid\";\n\n// Input parameters\nconst numKeys = parseInt(process.env.KEYS || \"1000000\", 10);\nconst numNodes = parseInt(process.env.NODES || \"3\", 10);\n\n// Prepare topology\nconst maxSlot = 16384;\nconst destination = join(__dirname, `cluster-${numNodes}.txt`);\nconst counts = Array.from(Array(numNodes), () => 0);\nconst keys = [];\n\n/*\n This algorithm is taken and adapted from Redis source code\n See: https://github.com/redis/redis/blob/d9f970d8d3f0b694f1e8915cab6d4eab9cfb2ef1/src/redis-cli.c#L5453\n*/\nconst nodes = []; // This only holds starting slot, since the ending slot can be computed out of the next one\nlet first = 0;\nlet cursor = 0;\nconst slotsPerNode = maxSlot / numNodes;\n\nfor (let i = 0; i < numNodes; i++) {\n let last = Math.round(cursor + slotsPerNode - 1);\n\n if (last > maxSlot || i === numNodes - 1) {\n last = maxSlot - 1;\n }\n\n if (last < first) {\n last = first;\n }\n\n nodes.push(first);\n first = last + 1;\n cursor += slotsPerNode;\n}\n\n// Generate keys and also track slot allocations\nfor (let i = 0; i < numKeys; i++) {\n const key = uuid();\n const slot = calculateSlot(key);\n const node = nodes.findIndex(\n (start, i) => i === numNodes - 1 || (slot >= start && slot < nodes[i + 1])\n );\n\n counts[node]++;\n keys.push(key);\n}\n\n// Save keys\nwriteFileSync(destination, keys.join(\"\\n\"));\n\n// Print summary\nconsole.log(\n `Generated ${numKeys} keys in ${(\n Number(process.hrtime.bigint() - start) / 1e6\n ).toFixed(2)} ms `\n);\n\nfor (let i = 0; i < numNodes; i++) {\n const from = nodes[i];\n const to = (i === numNodes - 1 ? maxSlot : nodes[i + 1]) - 1;\n console.log(\n ` - Generated ${\n counts[i]\n } keys for node(s) serving slots ${from}-${to} (${(\n (counts[i] * 100) /\n numKeys\n ).toFixed(2)} %)`\n );\n}\n"
},
{
"path": "benchmarks/fixtures/insert.ts",
"content": "import { readFileSync } from \"fs\";\nimport { join } from \"path\";\nimport Redis from \"../../lib\";\nimport Cluster from \"../../lib/cluster\";\n\nasync function main() {\n const numNodes = parseInt(process.env.NODES || \"3\", 10);\n let redis;\n\n if (process.env.CLUSTER === \"true\") {\n const configuration = Array.from(Array(numNodes), (_, i) => ({\n host: \"127.0.0.1\",\n port: 30000 + i + 1,\n }));\n redis = new Cluster(configuration);\n console.log(\"Inserting fixtures keys in the cluster ...\");\n } else {\n redis = new Redis();\n console.log(\"Inserting fixtures keys in the server ...\");\n }\n\n // Use Redis to set the keys\n const start = process.hrtime.bigint();\n const keys = readFileSync(\n join(__dirname, `cluster-${numNodes}.txt`),\n \"utf-8\"\n ).split(\"\\n\");\n const keysCount = keys.length;\n\n while (keys.length) {\n const promises = [];\n\n for (const key of keys.splice(0, 1000)) {\n promises.push(redis.set(key, key));\n }\n\n await Promise.all(promises);\n }\n\n console.log(\n `Inserted ${keysCount} keys in ${(\n Number(process.hrtime.bigint() - start) / 1e6\n ).toFixed(2)} ms.`\n );\n process.exit(0);\n}\n\nmain().catch(console.error);\n"
},
{
"path": "bin/argumentTypes.js",
"content": "const typeMaps = require(\"./typeMaps\");\n\nmodule.exports = {\n debug: [\n [{ name: \"subcommand\", type: \"string\" }],\n [\n { name: \"subcommand\", type: \"string\" },\n { name: \"args\", type: typeMaps.string(\"args\"), multiple: true },\n ],\n ],\n};\n"
},
{
"path": "bin/index.js",
"content": "const returnTypes = require(\"./returnTypes\");\nconst argumentTypes = require(\"./argumentTypes\");\nconst sortArguments = require(\"./sortArguments\");\nconst typeMaps = require(\"./typeMaps\");\nconst overrides = require(\"./overrides\");\nconst { getCommanderInterface } = require(\"@ioredis/interface-generator\");\n\nconst HEADER = `/**\n * This file is generated by @ioredis/interface-generator.\n * Don't edit it manually. Instead, run \\`npm run generate\\` to update\n * this file.\n */\n\n`;\n\nconst ignoredCommands = [\"monitor\", \"multi\"];\nconst commands = require(\"@ioredis/commands\")\n .list.filter((name) => !ignoredCommands.includes(name))\n .sort();\n\nconst fs = require(\"fs\");\nconst path = require(\"path\");\n\nconst template = fs.readFileSync(path.join(__dirname, \"/template.ts\"), \"utf8\");\n\nasync function main() {\n const interface = await getCommanderInterface({\n commands,\n complexityLimit: 50,\n redisOpts: {\n port: process.env.REDIS_PORT,\n },\n overrides,\n returnTypes,\n argumentTypes,\n sortArguments,\n typeMaps: typeMaps,\n ignoredBufferVariant: [\n \"incrbyfloat\",\n \"type\",\n \"info\",\n \"latency\",\n \"lolwut\",\n \"memory\",\n \"cluster\",\n \"geopos\",\n ],\n });\n\n fs.writeFileSync(\n path.join(__dirname, \"..\", \"lib/utils/RedisCommander.ts\"),\n HEADER + template.replace(\"////\", () => interface)\n );\n}\n\nmain()\n .catch(console.error)\n .then(() => process.exit(0));\n"
},
{
"path": "bin/overrides.js",
"content": "const msetOverrides = {\n overwrite: false,\n defs: [\n \"$1(object: object, callback?: Callback<'OK'>): Result<'OK', Context>\",\n \"$1(map: MapClass Cluster
Hierarchy
- Commander
- EventEmitter
- Transaction
- Cluster
Index
Constructors
Properties
Accessors
Methods
- acl
- acl
Buffer - add
Builtin Command - append
- asking
- auth
- bgrewriteaof
- bgrewriteaof
Buffer - bgsave
- bitcount
- bitfield
- bitfield_
ro - bitop
- bitpos
- blmove
- blmove
Buffer - blmpop
- blmpop
Buffer - blpop
- blpop
Buffer - brpop
- brpop
Buffer - brpoplpush
- brpoplpush
Buffer - bzmpop
- bzpopmax
- bzpopmax
Buffer - bzpopmin
- bzpopmin
Buffer - call
- call
Buffer - client
- client
Buffer - cluster
- command
- config
- connect
- copy
- create
Builtin Command - dbsize
- debug
- decr
- decrby
- define
Command - del
- discard
- disconnect
- dump
- dump
Buffer - duplicate
- echo
- echo
Buffer - eval
- eval_
ro - evalsha
- evalsha_
ro - exec
- exists
- expire
- expireat
- expiretime
- failover
- fcall
- fcall_
ro - flushall
- flushdb
- function
- function
Buffer - geoadd
- geodist
- geodist
Buffer - geohash
- geohash
Buffer - geopos
- georadius
- georadius_
ro - georadiusbymember
- georadiusbymember_
ro - geosearch
- geosearchstore
- get
- get
Buffer - get
Builtin Commands - getbit
- getdel
- getdel
Buffer - getex
- getex
Buffer - getrange
- getrange
Buffer - getset
- getset
Buffer - hdel
- hello
- hexists
- hexpire
- hexpireat
- hexpiretime
- hget
- hget
Buffer - hgetall
- hgetall
Buffer - hgetdel
- hgetdel
Buffer - hgetex
- hgetex
Buffer - hincrby
- hincrbyfloat
- hincrbyfloat
Buffer - hkeys
- hkeys
Buffer - hlen
- hmget
- hmget
Buffer - hmset
- hpersist
- hpexpire
- hpexpireat
- hpexpiretime
- hpttl
- hrandfield
- hrandfield
Buffer - hscan
- hscan
Buffer - hscan
Buffer Stream - hscan
Stream - hset
- hsetex
- hsetnx
- hstrlen
- httl
- hvals
- hvals
Buffer - incr
- incrby
- incrbyfloat
- info
- keys
- keys
Buffer - lastsave
- latency
- lcs
- lindex
- lindex
Buffer - linsert
- llen
- lmove
- lmove
Buffer - lmpop
- lmpop
Buffer - lolwut
- lpop
- lpop
Buffer - lpos
- lpush
- lpushx
- lrange
- lrange
Buffer - lrem
- lset
- ltrim
- memory
- mget
- mget
Buffer - migrate
- module
- move
- mset
- msetnx
- multi
- nodes
- object
- persist
- pexpire
- pexpireat
- pexpiretime
- pfadd
- pfcount
- pfdebug
- pfmerge
- pfselftest
- ping
- ping
Buffer - pipeline
- psetex
- psubscribe
- psync
- pttl
- publish
- pubsub
- punsubscribe
- quit
- randomkey
- randomkey
Buffer - readonly
- readwrite
- rename
- renamenx
- replconf
- replicaof
- reset
- restore
- restore-
asking - role
- rpop
- rpop
Buffer - rpoplpush
- rpoplpush
Buffer - rpush
- rpushx
- sadd
- save
- scan
- scan
Buffer - scard
- script
- sdiff
- sdiff
Buffer - sdiffstore
- select
- set
- set
Buffer - setbit
- setex
- setnx
- setrange
- shutdown
- sinter
- sinter
Buffer - sintercard
- sinterstore
- sismember
- slaveof
- slowlog
- smembers
- smembers
Buffer - smismember
- smove
- sort
- sort_
ro - spop
- spop
Buffer - spublish
- srandmember
- srandmember
Buffer - srem
- sscan
- sscan
Buffer - sscan
Buffer Stream - sscan
Stream - ssubscribe
- strlen
- subscribe
- substr
- sunion
- sunion
Buffer - sunionstore
- sunsubscribe
- swapdb
- sync
- time
- touch
- ttl
- type
- unlink
- unsubscribe
- unwatch
- wait
- watch
- xack
- xadd
- xadd
Buffer - xautoclaim
- xclaim
- xdel
- xdelex
- xgroup
- xinfo
- xlen
- xpending
- xrange
- xrange
Buffer - xread
- xread
Buffer - xreadgroup
- xrevrange
- xrevrange
Buffer - xsetid
- xtrim
- zadd
- zadd
Buffer - zcard
- zcount
- zdiff
- zdiff
Buffer - zdiffstore
- zincrby
- zincrby
Buffer - zinter
- zinter
Buffer - zintercard
- zinterstore
- zlexcount
- zmpop
- zmscore
- zmscore
Buffer - zpopmax
- zpopmax
Buffer - zpopmin
- zpopmin
Buffer - zrandmember
- zrandmember
Buffer - zrange
- zrange
Buffer - zrangebylex
- zrangebylex
Buffer - zrangebyscore
- zrangebyscore
Buffer - zrangestore
- zrank
- zrem
- zremrangebylex
- zremrangebyrank
- zremrangebyscore
- zrevrange
- zrevrange
Buffer - zrevrangebylex
- zrevrangebylex
Buffer - zrevrangebyscore
- zrevrangebyscore
Buffer - zrevrank
- zscan
- zscan
Buffer - zscan
Buffer Stream - zscan
Stream - zscore
- zscore
Buffer - zunion
- zunion
Buffer - zunionstore
Constructors
constructor
- new
Cluster(startupNodes: ClusterNode[], options?: ClusterOptions): Cluster
- \n
Creates an instance of Cluster.
\nParameters
startupNodes: ClusterNode[]
options: ClusterOptions = {}
Returns Cluster
Properties
options
options: ClusterOptions
slots
slots: string[][] = []
status
status: ClusterStatus
Accessors
auto
- get autoPipelineQueueSize(): number
- \n
Get the number of commands queued in automatic pipelines.
\nThis is not available (and returns 0) until the cluster is connected and slots information have been received.
\nReturns number
Methods
acl
- acl(subcommand: "CAT", callback?: Callback<unknown>): Promise<unknown>
- acl(subcommand: "CAT", categoryname: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- acl(...args: [subcommand: "DELUSER", ...usernames: (string | Buffer)[], callback: Callback<number>]): Promise<number>
- acl(...args: [subcommand: "DELUSER", ...usernames: (string | Buffer)[]]): Promise<number>
- acl(subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, callback?: Callback<string>): Promise<string>
- acl(...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- acl(...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[]]): Promise<string>
- acl(subcommand: "GENPASS", callback?: Callback<string>): Promise<string>
- acl(subcommand: "GENPASS", bits: string | number, callback?: Callback<string>): Promise<string>
- acl(subcommand: "GETUSER", username: string | Buffer, callback?: Callback<string[]>): Promise<string[]>
- acl(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- acl(subcommand: "LIST", callback?: Callback<string[]>): Promise<string[]>
- acl(subcommand: "LOAD", callback?: Callback<"OK">): Promise<"OK">
- acl(subcommand: "LOG", callback?: Callback<unknown>): Promise<unknown>
- acl(subcommand: "LOG", count: string | number, callback?: Callback<unknown>): Promise<unknown>
- acl(subcommand: "LOG", reset: "RESET", callback?: Callback<unknown>): Promise<unknown>
- acl(subcommand: "SAVE", callback?: Callback<"OK">): Promise<"OK">
- acl(subcommand: "SETUSER", username: string | Buffer, callback?: Callback<"OK">): Promise<"OK">
- acl(...args: [subcommand: "SETUSER", username: string | Buffer, ...rules: (string | Buffer)[], callback: Callback<"OK">]): Promise<"OK">
- acl(...args: [subcommand: "SETUSER", username: string | Buffer, ...rules: (string | Buffer)[]]): Promise<"OK">
- acl(subcommand: "USERS", callback?: Callback<string[]>): Promise<string[]>
- acl(subcommand: "WHOAMI", callback?: Callback<string>): Promise<string>
- \n
List the ACL categories or the commands inside a category
\n- \n
- group: server \n
- complexity: O(1) since the categories and commands are a fixed set. \n
- since: 6.0.0 \n
Parameters
subcommand: "CAT"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "CAT"
categoryname: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Remove the specified ACL users and the associated rules
\n- \n
- group: server \n
- complexity: O(1) amortized time considering the typical user. \n
- since: 6.0.0 \n
Parameters
Rest ...args: [subcommand: "DELUSER", ...usernames: (string | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [subcommand: "DELUSER", ...usernames: (string | Buffer)[]]
Returns Promise<number>
- \n
Returns whether the user can execute the given command without executing the command.
\n- \n
- group: server \n
- complexity: O(1). \n
- since: 7.0.0 \n
Parameters
subcommand: "DRYRUN"
username: string | Buffer
command: string | Buffer
Optional callback: Callback<string>
Returns Promise<string>
Parameters
Rest ...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[]]
Returns Promise<string>
- \n
Generate a pseudorandom secure password to use for ACL users
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 6.0.0 \n
Parameters
subcommand: "GENPASS"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
subcommand: "GENPASS"
bits: string | number
Optional callback: Callback<string>
Returns Promise<string>
- \n
Get the rules for a specific ACL user
\n- \n
- group: server \n
- complexity: O(N). Where N is the number of password, command and pattern rules that the user has. \n
- since: 6.0.0 \n
Parameters
subcommand: "GETUSER"
username: string | Buffer
Optional callback: Callback<string[]>
Returns Promise<string[]>
- \n
Show helpful text about the different subcommands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 6.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
List the current ACL rules in ACL config file format
\n- \n
- group: server \n
- complexity: O(N). Where N is the number of configured users. \n
- since: 6.0.0 \n
Parameters
subcommand: "LIST"
Optional callback: Callback<string[]>
Returns Promise<string[]>
- \n
Reload the ACLs from the configured ACL file
\n- \n
- group: server \n
- complexity: O(N). Where N is the number of configured users. \n
- since: 6.0.0 \n
Parameters
subcommand: "LOAD"
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
List latest events denied because of ACLs in place
\n- \n
- group: server \n
- complexity: O(N) with N being the number of entries shown. \n
- since: 6.0.0 \n
Parameters
subcommand: "LOG"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "LOG"
count: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "LOG"
reset: "RESET"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Save the current ACL rules in the configured ACL file
\n- \n
- group: server \n
- complexity: O(N). Where N is the number of configured users. \n
- since: 6.0.0 \n
Parameters
subcommand: "SAVE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Modify or create the rules for a specific ACL user
\n- \n
- group: server \n
- complexity: O(N). Where N is the number of rules provided. \n
- since: 6.0.0 \n
Parameters
subcommand: "SETUSER"
username: string | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
Rest ...args: [subcommand: "SETUSER", username: string | Buffer, ...rules: (string | Buffer)[], callback: Callback<"OK">]
Returns Promise<"OK">
Parameters
Rest ...args: [subcommand: "SETUSER", username: string | Buffer, ...rules: (string | Buffer)[]]
Returns Promise<"OK">
- \n
List the username of all the configured ACL rules
\n- \n
- group: server \n
- complexity: O(N). Where N is the number of configured users. \n
- since: 6.0.0 \n
Parameters
subcommand: "USERS"
Optional callback: Callback<string[]>
Returns Promise<string[]>
- \n
Return the name of the user associated to the current connection
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 6.0.0 \n
Parameters
subcommand: "WHOAMI"
Optional callback: Callback<string>
Returns Promise<string>
acl
- acl
Buffer(subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, callback?: Callback<Buffer>): Promise<Buffer> - acl
Buffer(...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - acl
Buffer(...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[]]): Promise<Buffer> - acl
Buffer(subcommand: "GENPASS", callback?: Callback<Buffer>): Promise<Buffer> - acl
Buffer(subcommand: "GENPASS", bits: string | number, callback?: Callback<Buffer>): Promise<Buffer> - acl
Buffer(subcommand: "GETUSER", username: string | Buffer, callback?: Callback<Buffer[]>): Promise<Buffer[]> - acl
Buffer(subcommand: "LIST", callback?: Callback<Buffer[]>): Promise<Buffer[]> - acl
Buffer(subcommand: "USERS", callback?: Callback<Buffer[]>): Promise<Buffer[]> - acl
Buffer(subcommand: "WHOAMI", callback?: Callback<Buffer>): Promise<Buffer>
Parameters
subcommand: "DRYRUN"
username: string | Buffer
command: string | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
Rest ...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
subcommand: "GENPASS"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "GENPASS"
bits: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "GETUSER"
username: string | Buffer
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
subcommand: "LIST"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
subcommand: "USERS"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
subcommand: "WHOAMI"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
add
- add
Builtin Command(commandName: string): void
- \n
Create add builtin command
\nParameters
commandName: string
Returns void
append
- append(key: RedisKey, value: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Append a value to a key
\n- \n
- group: string \n
- complexity: O(1). The amortized time complexity is O(1) assuming the appended value is small and the already present value is of any size, since the dynamic string library used by Redis will double the free space available on every reallocation. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
value: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
asking
- asking(callback?: Callback<"OK">): Promise<"OK">
- \n
Sent by cluster clients after an -ASK redirect
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
auth
- auth(password: string | Buffer, callback?: Callback<"OK">): Promise<"OK">
- auth(username: string | Buffer, password: string | Buffer, callback?: Callback<"OK">): Promise<"OK">
- \n
Authenticate to the server
\n- \n
- group: connection \n
- complexity: O(N) where N is the number of passwords defined for the user \n
- since: 1.0.0 \n
Parameters
password: string | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
username: string | Buffer
password: string | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
bgrewriteaof
- bgrewriteaof(callback?: Callback<string>): Promise<string>
- \n
Asynchronously rewrite the append-only file
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<string>
Returns Promise<string>
bgrewriteaof
- bgrewriteaof
Buffer(callback?: Callback<Buffer>): Promise<Buffer>
Parameters
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
bgsave
- bgsave(callback?: Callback<"OK">): Promise<"OK">
- bgsave(schedule: "SCHEDULE", callback?: Callback<"OK">): Promise<"OK">
- \n
Asynchronously save the dataset to disk
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
schedule: "SCHEDULE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
bitcount
- bitcount(key: RedisKey, callback?: Callback<number>): Promise<number>
- bitcount(key: RedisKey, start: string | number, end: string | number, callback?: Callback<number>): Promise<number>
- bitcount(key: RedisKey, start: string | number, end: string | number, byte: "BYTE", callback?: Callback<number>): Promise<number>
- bitcount(key: RedisKey, start: string | number, end: string | number, bit: "BIT", callback?: Callback<number>): Promise<number>
- \n
Count set bits in a string
\n- \n
- group: bitmap \n
- complexity: O(N) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
start: string | number
end: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
start: string | number
end: string | number
byte: "BYTE"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
start: string | number
end: string | number
bit: "BIT"
Optional callback: Callback<number>
Returns Promise<number>
bitfield
- bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: string | number, callback?: Callback<unknown>): Promise<unknown>
- bitfield(key: RedisKey, encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: string | number, value: string | number, callback?: Callback<unknown>): Promise<unknown>
- bitfield(key: RedisKey, encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: string | number, increment: string | number, callback?: Callback<unknown>): Promise<unknown>
- bitfield(key: RedisKey, overflow: "OVERFLOW", wrap: "WRAP", encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: string | number, value: string | number, callback?: Callback<unknown>): Promise<unknown>
- bitfield(key: RedisKey, overflow: "OVERFLOW", wrap: "WRAP", encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: string | number, increment: string | number, callback?: Callback<unknown>): Promise<unknown>
- bitfield(key: RedisKey, overflow: "OVERFLOW", sat: "SAT", encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: string | number, value: string | number, callback?: Callback<unknown>): Promise<unknown>
- bitfield(key: RedisKey, overflow: "OVERFLOW", sat: "SAT", encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: string | number, increment: string | number, callback?: Callback<unknown>): Promise<unknown>
- bitfield(key: RedisKey, overflow: "OVERFLOW", fail: "FAIL", encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: string | number, value: string | number, callback?: Callback<unknown>): Promise<unknown>
- bitfield(key: RedisKey, overflow: "OVERFLOW", fail: "FAIL", encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: string | number, increment: string | number, callback?: Callback<unknown>): Promise<unknown>
- \n
Perform arbitrary bitfield integer operations on strings
\n- \n
- group: bitmap \n
- complexity: O(1) for each subcommand specified \n
- since: 3.2.0 \n
Parameters
key: RedisKey
encodingOffsetToken: "GET"
encoding: string | Buffer
offset: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
encodingOffsetValueToken: "SET"
encoding: string | Buffer
offset: string | number
value: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
encodingOffsetIncrementToken: "INCRBY"
encoding: string | Buffer
offset: string | number
increment: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
overflow: "OVERFLOW"
wrap: "WRAP"
encodingOffsetValueToken: "SET"
encoding: string | Buffer
offset: string | number
value: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
overflow: "OVERFLOW"
wrap: "WRAP"
encodingOffsetIncrementToken: "INCRBY"
encoding: string | Buffer
offset: string | number
increment: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
overflow: "OVERFLOW"
sat: "SAT"
encodingOffsetValueToken: "SET"
encoding: string | Buffer
offset: string | number
value: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
overflow: "OVERFLOW"
sat: "SAT"
encodingOffsetIncrementToken: "INCRBY"
encoding: string | Buffer
offset: string | number
increment: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
overflow: "OVERFLOW"
fail: "FAIL"
encodingOffsetValueToken: "SET"
encoding: string | Buffer
offset: string | number
value: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
overflow: "OVERFLOW"
fail: "FAIL"
encodingOffsetIncrementToken: "INCRBY"
encoding: string | Buffer
offset: string | number
increment: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
bitfield_
- bitfield_
ro(...args: [key: RedisKey, encodingOffsetToken: "GET", ...encodingOffsets: (string | number | Buffer)[], callback: Callback<unknown[]>]): Promise<unknown[]> - bitfield_
ro(...args: [key: RedisKey, encodingOffsetToken: "GET", ...encodingOffsets: (string | number | Buffer)[]]): Promise<unknown[]>
- \n
Perform arbitrary bitfield integer operations on strings. Read-only variant of BITFIELD
\n- \n
- group: bitmap \n
- complexity: O(1) for each subcommand specified \n
- since: 6.0.0 \n
Parameters
Rest ...args: [key: RedisKey, encodingOffsetToken: "GET", ...encodingOffsets: (string | number | Buffer)[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, encodingOffsetToken: "GET", ...encodingOffsets: (string | number | Buffer)[]]
Returns Promise<unknown[]>
bitop
- bitop(...args: [operation: string | Buffer, destkey: RedisKey, ...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- bitop(...args: [operation: string | Buffer, destkey: RedisKey, keys: RedisKey[], callback: Callback<number>]): Promise<number>
- bitop(...args: [operation: string | Buffer, destkey: RedisKey, ...keys: RedisKey[]]): Promise<number>
- bitop(...args: [operation: string | Buffer, destkey: RedisKey, keys: RedisKey[]]): Promise<number>
- \n
Perform bitwise operations between strings
\n- \n
- group: bitmap \n
- complexity: O(N) \n
- since: 2.6.0 \n
Parameters
Rest ...args: [operation: string | Buffer, destkey: RedisKey, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [operation: string | Buffer, destkey: RedisKey, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
bitpos
- bitpos(key: RedisKey, bit: string | number, callback?: Callback<number>): Promise<number>
- bitpos(key: RedisKey, bit: string | number, start: string | number, callback?: Callback<number>): Promise<number>
- bitpos(key: RedisKey, bit: string | number, start: string | number, end: string | number, callback?: Callback<number>): Promise<number>
- bitpos(key: RedisKey, bit: string | number, start: string | number, end: string | number, byte: "BYTE", callback?: Callback<number>): Promise<number>
- bitpos(key: RedisKey, bit: string | number, start: string | number, end: string | number, bit1: "BIT", callback?: Callback<number>): Promise<number>
- \n
Find first bit set or clear in a string
\n- \n
- group: bitmap \n
- complexity: O(N) \n
- since: 2.8.7 \n
Parameters
key: RedisKey
bit: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
bit: string | number
start: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
bit: string | number
start: string | number
end: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
bit: string | number
start: string | number
end: string | number
byte: "BYTE"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
bit: string | number
start: string | number
end: string | number
bit1: "BIT"
Optional callback: Callback<number>
Returns Promise<number>
blmove
- blmove(source: RedisKey, destination: RedisKey, left: "LEFT", left1: "LEFT", timeout: string | number, callback?: Callback<string>): Promise<string>
- blmove(source: RedisKey, destination: RedisKey, left: "LEFT", right: "RIGHT", timeout: string | number, callback?: Callback<string>): Promise<string>
- blmove(source: RedisKey, destination: RedisKey, right: "RIGHT", left: "LEFT", timeout: string | number, callback?: Callback<string>): Promise<string>
- blmove(source: RedisKey, destination: RedisKey, right: "RIGHT", right1: "RIGHT", timeout: string | number, callback?: Callback<string>): Promise<string>
- \n
Pop an element from a list, push it to another list and return it; or block until one is available
\n- \n
- group: list \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
source: RedisKey
destination: RedisKey
left: "LEFT"
left1: "LEFT"
timeout: string | number
Optional callback: Callback<string>
Returns Promise<string>
Parameters
source: RedisKey
destination: RedisKey
left: "LEFT"
right: "RIGHT"
timeout: string | number
Optional callback: Callback<string>
Returns Promise<string>
Parameters
source: RedisKey
destination: RedisKey
right: "RIGHT"
left: "LEFT"
timeout: string | number
Optional callback: Callback<string>
Returns Promise<string>
Parameters
source: RedisKey
destination: RedisKey
right: "RIGHT"
right1: "RIGHT"
timeout: string | number
Optional callback: Callback<string>
Returns Promise<string>
blmove
- blmove
Buffer(source: RedisKey, destination: RedisKey, left: "LEFT", left1: "LEFT", timeout: string | number, callback?: Callback<Buffer>): Promise<Buffer> - blmove
Buffer(source: RedisKey, destination: RedisKey, left: "LEFT", right: "RIGHT", timeout: string | number, callback?: Callback<Buffer>): Promise<Buffer> - blmove
Buffer(source: RedisKey, destination: RedisKey, right: "RIGHT", left: "LEFT", timeout: string | number, callback?: Callback<Buffer>): Promise<Buffer> - blmove
Buffer(source: RedisKey, destination: RedisKey, right: "RIGHT", right1: "RIGHT", timeout: string | number, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
source: RedisKey
destination: RedisKey
left: "LEFT"
left1: "LEFT"
timeout: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
source: RedisKey
destination: RedisKey
left: "LEFT"
right: "RIGHT"
timeout: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
source: RedisKey
destination: RedisKey
right: "RIGHT"
left: "LEFT"
timeout: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
source: RedisKey
destination: RedisKey
right: "RIGHT"
right1: "RIGHT"
timeout: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
blmpop
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT"]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT"]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): Promise<[key: string, members: string[]]>
- \n
Pop elements from a list, or block until one is available
\n- \n
- group: list \n
- complexity: O(N+M) where N is the number of provided keys and M is the number of elements returned. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns Promise<[key: string, members: string[]]>
blmpop
- blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT"]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT"]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns Promise<[key: Buffer, members: Buffer[]]>
blpop
- blpop(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]): Promise<[string, string]>
- blpop(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]): Promise<[string, string]>
- blpop(...args: [...keys: RedisKey[], timeout: string | number]): Promise<[string, string]>
- blpop(...args: [keys: RedisKey[], timeout: string | number]): Promise<[string, string]>
- \n
Remove and get the first element in a list, or block until one is available
\n- \n
- group: list \n
- complexity: O(N) where N is the number of provided keys. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]
Returns Promise<[string, string]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]
Returns Promise<[string, string]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[string, string]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[string, string]>
blpop
- blpop
Buffer(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]): Promise<[Buffer, Buffer]> - blpop
Buffer(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]): Promise<[Buffer, Buffer]> - blpop
Buffer(...args: [...keys: RedisKey[], timeout: string | number]): Promise<[Buffer, Buffer]> - blpop
Buffer(...args: [keys: RedisKey[], timeout: string | number]): Promise<[Buffer, Buffer]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]
Returns Promise<[Buffer, Buffer]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]
Returns Promise<[Buffer, Buffer]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[Buffer, Buffer]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[Buffer, Buffer]>
brpop
- brpop(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]): Promise<[string, string]>
- brpop(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]): Promise<[string, string]>
- brpop(...args: [...keys: RedisKey[], timeout: string | number]): Promise<[string, string]>
- brpop(...args: [keys: RedisKey[], timeout: string | number]): Promise<[string, string]>
- \n
Remove and get the last element in a list, or block until one is available
\n- \n
- group: list \n
- complexity: O(N) where N is the number of provided keys. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]
Returns Promise<[string, string]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]
Returns Promise<[string, string]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[string, string]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[string, string]>
brpop
- brpop
Buffer(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]): Promise<[Buffer, Buffer]> - brpop
Buffer(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]): Promise<[Buffer, Buffer]> - brpop
Buffer(...args: [...keys: RedisKey[], timeout: string | number]): Promise<[Buffer, Buffer]> - brpop
Buffer(...args: [keys: RedisKey[], timeout: string | number]): Promise<[Buffer, Buffer]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]
Returns Promise<[Buffer, Buffer]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]
Returns Promise<[Buffer, Buffer]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[Buffer, Buffer]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[Buffer, Buffer]>
brpoplpush
brpoplpush
bzmpop
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN", callback: Callback<unknown>]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN", callback: Callback<unknown>]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN"]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN"]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX", callback: Callback<unknown>]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX", callback: Callback<unknown>]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX"]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX"]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]): Promise<unknown>
- \n
Remove and return members with scores in a sorted set or block until one is available
\n- \n
- group: sorted-set \n
- complexity: O(K) + O(N*log(M)) where K is the number of provided keys, N being the number of elements in the sorted set, and M being the number of elements popped. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN"]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN"]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX"]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX"]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]
Returns Promise<unknown>
bzpopmax
- bzpopmax(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]): Promise<[key: string, member: string, score: string]>
- bzpopmax(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]): Promise<[key: string, member: string, score: string]>
- bzpopmax(...args: [...keys: RedisKey[], timeout: string | number]): Promise<[key: string, member: string, score: string]>
- bzpopmax(...args: [keys: RedisKey[], timeout: string | number]): Promise<[key: string, member: string, score: string]>
- \n
Remove and return the member with the highest score from one or more sorted sets, or block until one is available
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) with N being the number of elements in the sorted set. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]
Returns Promise<[key: string, member: string, score: string]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]
Returns Promise<[key: string, member: string, score: string]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[key: string, member: string, score: string]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[key: string, member: string, score: string]>
bzpopmax
- bzpopmax
Buffer(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]): Promise<[key: Buffer, member: Buffer, score: Buffer]> - bzpopmax
Buffer(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]): Promise<[key: Buffer, member: Buffer, score: Buffer]> - bzpopmax
Buffer(...args: [...keys: RedisKey[], timeout: string | number]): Promise<[key: Buffer, member: Buffer, score: Buffer]> - bzpopmax
Buffer(...args: [keys: RedisKey[], timeout: string | number]): Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
bzpopmin
- bzpopmin(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]): Promise<[key: string, member: string, score: string]>
- bzpopmin(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]): Promise<[key: string, member: string, score: string]>
- bzpopmin(...args: [...keys: RedisKey[], timeout: string | number]): Promise<[key: string, member: string, score: string]>
- bzpopmin(...args: [keys: RedisKey[], timeout: string | number]): Promise<[key: string, member: string, score: string]>
- \n
Remove and return the member with the lowest score from one or more sorted sets, or block until one is available
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) with N being the number of elements in the sorted set. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]
Returns Promise<[key: string, member: string, score: string]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]
Returns Promise<[key: string, member: string, score: string]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[key: string, member: string, score: string]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[key: string, member: string, score: string]>
bzpopmin
- bzpopmin
Buffer(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]): Promise<[key: Buffer, member: Buffer, score: Buffer]> - bzpopmin
Buffer(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]): Promise<[key: Buffer, member: Buffer, score: Buffer]> - bzpopmin
Buffer(...args: [...keys: RedisKey[], timeout: string | number]): Promise<[key: Buffer, member: Buffer, score: Buffer]> - bzpopmin
Buffer(...args: [keys: RedisKey[], timeout: string | number]): Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
call
- call(command: string, callback?: Callback<unknown>): Promise<unknown>
- call(command: string, args: (string | number | Buffer)[], callback?: Callback<unknown>): Promise<unknown>
- call(...args: [command: string, ...args: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- call(...args: [command: string, ...args: (string | number | Buffer)[]]): Promise<unknown>
- \n
Call arbitrary commands.
\n
\nredis.call('set', 'foo', 'bar')is the same asredis.set('foo', 'bar'),\nso the only case you need to use this method is when the command is not\nsupported by ioredis.
\nredis.call('set', 'foo', 'bar');
redis.call('get', 'foo', (err, value) => {
// value === 'bar'
});\nParameters
command: string
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
command: string
args: (string | number | Buffer)[]
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [command: string, ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [command: string, ...args: (string | number | Buffer)[]]
Returns Promise<unknown>
call
- call
Buffer(command: string, callback?: Callback<unknown>): Promise<unknown> - call
Buffer(command: string, args: (string | number | Buffer)[], callback?: Callback<unknown>): Promise<unknown> - call
Buffer(...args: [command: string, ...args: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown> - call
Buffer(...args: [command: string, ...args: (string | number | Buffer)[]]): Promise<unknown>
Parameters
command: string
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
command: string
args: (string | number | Buffer)[]
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [command: string, ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [command: string, ...args: (string | number | Buffer)[]]
Returns Promise<unknown>
client
- client(subcommand: "CACHING", yes: "YES", callback?: Callback<"OK">): Promise<"OK">
- client(subcommand: "CACHING", no: "NO", callback?: Callback<"OK">): Promise<"OK">
- client(subcommand: "GETNAME", callback?: Callback<string>): Promise<string>
- client(subcommand: "GETREDIR", callback?: Callback<number>): Promise<number>
- client(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- client(subcommand: "ID", callback?: Callback<number>): Promise<number>
- client(subcommand: "INFO", callback?: Callback<string>): Promise<string>
- client(...args: [subcommand: "KILL", ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown>
- client(...args: [subcommand: "KILL", ...args: RedisValue[]]): Promise<unknown>
- client(subcommand: "LIST", callback?: Callback<unknown>): Promise<unknown>
- client(...args: [subcommand: "LIST", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]): Promise<unknown>
- client(...args: [subcommand: "LIST", idToken: "ID", ...clientIds: (string | number)[]]): Promise<unknown>
- client(subcommand: "LIST", type: "TYPE", normal: "NORMAL", callback?: Callback<unknown>): Promise<unknown>
- client(...args: [subcommand: "LIST", type: "TYPE", normal: "NORMAL", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]): Promise<unknown>
- client(...args: [subcommand: "LIST", type: "TYPE", normal: "NORMAL", idToken: "ID", ...clientIds: (string | number)[]]): Promise<unknown>
- client(subcommand: "LIST", type: "TYPE", master: "MASTER", callback?: Callback<unknown>): Promise<unknown>
- client(...args: [subcommand: "LIST", type: "TYPE", master: "MASTER", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]): Promise<unknown>
- client(...args: [subcommand: "LIST", type: "TYPE", master: "MASTER", idToken: "ID", ...clientIds: (string | number)[]]): Promise<unknown>
- client(subcommand: "LIST", type: "TYPE", replica: "REPLICA", callback?: Callback<unknown>): Promise<unknown>
- client(...args: [subcommand: "LIST", type: "TYPE", replica: "REPLICA", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]): Promise<unknown>
- client(...args: [subcommand: "LIST", type: "TYPE", replica: "REPLICA", idToken: "ID", ...clientIds: (string | number)[]]): Promise<unknown>
- client(subcommand: "LIST", type: "TYPE", pubsub: "PUBSUB", callback?: Callback<unknown>): Promise<unknown>
- client(...args: [subcommand: "LIST", type: "TYPE", pubsub: "PUBSUB", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]): Promise<unknown>
- client(...args: [subcommand: "LIST", type: "TYPE", pubsub: "PUBSUB", idToken: "ID", ...clientIds: (string | number)[]]): Promise<unknown>
- client(subcommand: "NO-EVICT", on: "ON", callback?: Callback<unknown>): Promise<unknown>
- client(subcommand: "NO-EVICT", off: "OFF", callback?: Callback<unknown>): Promise<unknown>
- client(subcommand: "PAUSE", timeout: string | number, callback?: Callback<"OK">): Promise<"OK">
- client(subcommand: "PAUSE", timeout: string | number, write: "WRITE", callback?: Callback<"OK">): Promise<"OK">
- client(subcommand: "PAUSE", timeout: string | number, all: "ALL", callback?: Callback<"OK">): Promise<"OK">
- client(subcommand: "REPLY", on: "ON", callback?: Callback<unknown>): Promise<unknown>
- client(subcommand: "REPLY", off: "OFF", callback?: Callback<unknown>): Promise<unknown>
- client(subcommand: "REPLY", skip: "SKIP", callback?: Callback<unknown>): Promise<unknown>
- client(subcommand: "SETNAME", connectionName: string | Buffer, callback?: Callback<"OK">): Promise<"OK">
- client(...args: [subcommand: "TRACKING", ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown>
- client(...args: [subcommand: "TRACKING", ...args: RedisValue[]]): Promise<unknown>
- client(subcommand: "TRACKINGINFO", callback?: Callback<string>): Promise<string>
- client(subcommand: "UNBLOCK", clientId: string | number, callback?: Callback<unknown>): Promise<unknown>
- client(subcommand: "UNBLOCK", clientId: string | number, timeout: "TIMEOUT", callback?: Callback<unknown>): Promise<unknown>
- client(subcommand: "UNBLOCK", clientId: string | number, error: "ERROR", callback?: Callback<unknown>): Promise<unknown>
- client(subcommand: "UNPAUSE", callback?: Callback<"OK">): Promise<"OK">
- \n
Instruct the server about tracking or not keys in the next request
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 6.0.0 \n
Parameters
subcommand: "CACHING"
yes: "YES"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "CACHING"
no: "NO"
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Get the current connection name
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 2.6.9 \n
Parameters
subcommand: "GETNAME"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Get tracking notifications redirection client ID if any
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 6.0.0 \n
Parameters
subcommand: "GETREDIR"
Optional callback: Callback<number>
Returns Promise<number>
- \n
Show helpful text about the different subcommands
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Returns the client ID for the current connection
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "ID"
Optional callback: Callback<number>
Returns Promise<number>
- \n
Returns information about the current client connection.
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
subcommand: "INFO"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Kill the connection of a client
\n- \n
- group: connection \n
- complexity: O(N) where N is the number of client connections \n
- since: 2.4.0 \n
Parameters
Rest ...args: [subcommand: "KILL", ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "KILL", ...args: RedisValue[]]
Returns Promise<unknown>
- \n
Get the list of client connections
\n- \n
- group: connection \n
- complexity: O(N) where N is the number of client connections \n
- since: 2.4.0 \n
Parameters
subcommand: "LIST"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", idToken: "ID", ...clientIds: (string | number)[]]
Returns Promise<unknown>
Parameters
subcommand: "LIST"
type: "TYPE"
normal: "NORMAL"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", normal: "NORMAL", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", normal: "NORMAL", idToken: "ID", ...clientIds: (string | number)[]]
Returns Promise<unknown>
Parameters
subcommand: "LIST"
type: "TYPE"
master: "MASTER"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", master: "MASTER", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", master: "MASTER", idToken: "ID", ...clientIds: (string | number)[]]
Returns Promise<unknown>
Parameters
subcommand: "LIST"
type: "TYPE"
replica: "REPLICA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", replica: "REPLICA", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", replica: "REPLICA", idToken: "ID", ...clientIds: (string | number)[]]
Returns Promise<unknown>
Parameters
subcommand: "LIST"
type: "TYPE"
pubsub: "PUBSUB"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", pubsub: "PUBSUB", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", pubsub: "PUBSUB", idToken: "ID", ...clientIds: (string | number)[]]
Returns Promise<unknown>
- \n
Set client eviction mode for the current connection
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
subcommand: "NO-EVICT"
on: "ON"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "NO-EVICT"
off: "OFF"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Stop processing commands from clients for some time
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 2.9.50 \n
Parameters
subcommand: "PAUSE"
timeout: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "PAUSE"
timeout: string | number
write: "WRITE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "PAUSE"
timeout: string | number
all: "ALL"
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Instruct the server whether to reply to commands
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 3.2.0 \n
Parameters
subcommand: "REPLY"
on: "ON"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "REPLY"
off: "OFF"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "REPLY"
skip: "SKIP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Set the current connection name
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 2.6.9 \n
Parameters
subcommand: "SETNAME"
connectionName: string | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Enable or disable server assisted client side caching support
\n- \n
- group: connection \n
- complexity: O(1). Some options may introduce additional complexity. \n
- since: 6.0.0 \n
Parameters
Rest ...args: [subcommand: "TRACKING", ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "TRACKING", ...args: RedisValue[]]
Returns Promise<unknown>
- \n
Return information about server assisted client side caching for the current connection
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
subcommand: "TRACKINGINFO"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Unblock a client blocked in a blocking command from a different connection
\n- \n
- group: connection \n
- complexity: O(log N) where N is the number of client connections \n
- since: 5.0.0 \n
Parameters
subcommand: "UNBLOCK"
clientId: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "UNBLOCK"
clientId: string | number
timeout: "TIMEOUT"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "UNBLOCK"
clientId: string | number
error: "ERROR"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Resume processing of clients that were paused
\n- \n
- group: connection \n
- complexity: O(N) Where N is the number of paused clients \n
- since: 6.2.0 \n
Parameters
subcommand: "UNPAUSE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
client
- client
Buffer(subcommand: "GETNAME", callback?: Callback<Buffer>): Promise<Buffer> - client
Buffer(subcommand: "INFO", callback?: Callback<Buffer>): Promise<Buffer> - client
Buffer(subcommand: "TRACKINGINFO", callback?: Callback<Buffer>): Promise<Buffer>
Parameters
subcommand: "GETNAME"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "INFO"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "TRACKINGINFO"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
cluster
- cluster(...args: [subcommand: "ADDSLOTS", ...slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "ADDSLOTS", slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "ADDSLOTS", ...slots: (string | number)[]]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "ADDSLOTS", slots: (string | number)[]]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "ADDSLOTSRANGE", ...startSlotEndSlots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "ADDSLOTSRANGE", ...startSlotEndSlots: (string | number)[]]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(subcommand: "BUMPEPOCH", callback?: Callback<"BUMPED" | "STILL">): Promise<"BUMPED" | "STILL">
- cluster(subcommand: "COUNT-FAILURE-REPORTS", nodeId: string | number | Buffer, callback?: Callback<number>): Promise<number>
- cluster(subcommand: "COUNTKEYSINSLOT", slot: string | number, callback?: Callback<number>): Promise<number>
- cluster(...args: [subcommand: "DELSLOTS", ...slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "DELSLOTS", slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "DELSLOTS", ...slots: (string | number)[]]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "DELSLOTS", slots: (string | number)[]]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "DELSLOTSRANGE", ...startSlotEndSlots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "DELSLOTSRANGE", ...startSlotEndSlots: (string | number)[]]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(subcommand: "FAILOVER", callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "FAILOVER", force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "FAILOVER", takeover: "TAKEOVER", callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "FLUSHSLOTS", callback?: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(subcommand: "FORGET", nodeId: string | number | Buffer, callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "GETKEYSINSLOT", slot: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- cluster(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- cluster(subcommand: "INFO", callback?: Callback<string>): Promise<string>
- cluster(subcommand: "KEYSLOT", key: string | Buffer, callback?: Callback<number>): Promise<number>
- cluster(subcommand: "LINKS", callback?: Callback<unknown[]>): Promise<unknown[]>
- cluster(subcommand: "MEET", ip: string | Buffer, port: string | number, callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "MYID", callback?: Callback<string>): Promise<string>
- cluster(subcommand: "NODES", callback?: Callback<unknown>): Promise<unknown>
- cluster(subcommand: "REPLICAS", nodeId: string | number | Buffer, callback?: Callback<unknown>): Promise<unknown>
- cluster(subcommand: "REPLICATE", nodeId: string | number | Buffer, callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "RESET", callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "RESET", hard: "HARD", callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "RESET", soft: "SOFT", callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "SAVECONFIG", callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "SET-CONFIG-EPOCH", configEpoch: string | number, callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "SETSLOT", slot: string | number, nodeIdToken: "IMPORTING", nodeId: string | number | Buffer, callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "SETSLOT", slot: string | number, nodeIdToken: "MIGRATING", nodeId: string | number | Buffer, callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "SETSLOT", slot: string | number, nodeIdToken: "NODE", nodeId: string | number | Buffer, callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "SETSLOT", slot: string | number, stable: "STABLE", callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "SHARDS", callback?: Callback<unknown>): Promise<unknown>
- cluster(subcommand: "SLAVES", nodeId: string | number | Buffer, callback?: Callback<unknown>): Promise<unknown>
- cluster(subcommand: "SLOTS", callback?: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- \n
Assign new hash slots to receiving node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of hash slot arguments \n
- since: 3.0.0 \n
Parameters
Rest ...args: [subcommand: "ADDSLOTS", ...slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Parameters
Rest ...args: [subcommand: "ADDSLOTS", slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Parameters
Rest ...args: [subcommand: "ADDSLOTS", ...slots: (string | number)[]]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Parameters
Rest ...args: [subcommand: "ADDSLOTS", slots: (string | number)[]]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- \n
Assign new hash slots to receiving node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of the slots between the start slot and end slot arguments. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [subcommand: "ADDSLOTSRANGE", ...startSlotEndSlots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Parameters
Rest ...args: [subcommand: "ADDSLOTSRANGE", ...startSlotEndSlots: (string | number)[]]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- \n
Advance the cluster config epoch
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "BUMPEPOCH"
Optional callback: Callback<"BUMPED" | "STILL">
Returns Promise<"BUMPED" | "STILL">
- \n
Return the number of failure reports active for a given node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the number of failure reports \n
- since: 3.0.0 \n
Parameters
subcommand: "COUNT-FAILURE-REPORTS"
nodeId: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
- \n
Return the number of local keys in the specified hash slot
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "COUNTKEYSINSLOT"
slot: string | number
Optional callback: Callback<number>
Returns Promise<number>
- \n
Set hash slots as unbound in receiving node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of hash slot arguments \n
- since: 3.0.0 \n
Parameters
Rest ...args: [subcommand: "DELSLOTS", ...slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Parameters
Rest ...args: [subcommand: "DELSLOTS", slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Parameters
Rest ...args: [subcommand: "DELSLOTS", ...slots: (string | number)[]]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Parameters
Rest ...args: [subcommand: "DELSLOTS", slots: (string | number)[]]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- \n
Set hash slots as unbound in receiving node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of the slots between the start slot and end slot arguments. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [subcommand: "DELSLOTSRANGE", ...startSlotEndSlots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Parameters
Rest ...args: [subcommand: "DELSLOTSRANGE", ...startSlotEndSlots: (string | number)[]]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- \n
Forces a replica to perform a manual failover of its master.
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "FAILOVER"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "FAILOVER"
force: "FORCE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "FAILOVER"
takeover: "TAKEOVER"
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Delete a node's own slots information
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "FLUSHSLOTS"
Optional callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- \n
Remove a node from the nodes table
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "FORGET"
nodeId: string | number | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Return local key names in the specified hash slot
\n- \n
- group: cluster \n
- complexity: O(log(N)) where N is the number of requested keys \n
- since: 3.0.0 \n
Parameters
subcommand: "GETKEYSINSLOT"
slot: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
- \n
Show helpful text about the different subcommands
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Provides info about Redis Cluster node state
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "INFO"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Returns the hash slot of the specified key
\n- \n
- group: cluster \n
- complexity: O(N) where N is the number of bytes in the key \n
- since: 3.0.0 \n
Parameters
subcommand: "KEYSLOT"
key: string | Buffer
Optional callback: Callback<number>
Returns Promise<number>
- \n
Returns a list of all TCP links to and from peer nodes in cluster
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of Cluster nodes \n
- since: 7.0.0 \n
Parameters
subcommand: "LINKS"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Force a node cluster to handshake with another node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "MEET"
ip: string | Buffer
port: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Return the node id
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "MYID"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Get Cluster config for the node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of Cluster nodes \n
- since: 3.0.0 \n
Parameters
subcommand: "NODES"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
List replica nodes of the specified master node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "REPLICAS"
nodeId: string | number | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Reconfigure a node as a replica of the specified master node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "REPLICATE"
nodeId: string | number | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Reset a Redis Cluster node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the number of known nodes. The command may execute a FLUSHALL as a side effect. \n
- since: 3.0.0 \n
Parameters
subcommand: "RESET"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "RESET"
hard: "HARD"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "RESET"
soft: "SOFT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Forces the node to save cluster state on disk
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "SAVECONFIG"
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Set the configuration epoch in a new node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "SET-CONFIG-EPOCH"
configEpoch: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Bind a hash slot to a specific node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "SETSLOT"
slot: string | number
nodeIdToken: "IMPORTING"
nodeId: string | number | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "SETSLOT"
slot: string | number
nodeIdToken: "MIGRATING"
nodeId: string | number | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "SETSLOT"
slot: string | number
nodeIdToken: "NODE"
nodeId: string | number | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "SETSLOT"
slot: string | number
stable: "STABLE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Get array of cluster slots to node mappings
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of cluster nodes \n
- since: 7.0.0 \n
Parameters
subcommand: "SHARDS"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
List replica nodes of the specified master node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "SLAVES"
nodeId: string | number | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Get array of Cluster slot to node mappings
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of Cluster nodes \n
- since: 3.0.0 \n
Parameters
subcommand: "SLOTS"
Optional callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
command
- command(subcommand: "COUNT", callback?: Callback<unknown[]>): Promise<unknown[]>
- command(subcommand: "DOCS", callback?: Callback<unknown[]>): Promise<unknown[]>
- command(...args: [subcommand: "DOCS", ...commandNames: (string | Buffer)[], callback: Callback<unknown[]>]): Promise<unknown[]>
- command(...args: [subcommand: "DOCS", ...commandNames: (string | Buffer)[]]): Promise<unknown[]>
- command(subcommand: "GETKEYS", callback?: Callback<unknown[]>): Promise<unknown[]>
- command(subcommand: "GETKEYSANDFLAGS", callback?: Callback<unknown[]>): Promise<unknown[]>
- command(subcommand: "HELP", callback?: Callback<unknown[]>): Promise<unknown[]>
- command(subcommand: "INFO", callback?: Callback<unknown[]>): Promise<unknown[]>
- command(...args: [subcommand: "INFO", ...commandNames: (string | Buffer)[], callback: Callback<unknown[]>]): Promise<unknown[]>
- command(...args: [subcommand: "INFO", ...commandNames: (string | Buffer)[]]): Promise<unknown[]>
- command(subcommand: "LIST", callback?: Callback<unknown[]>): Promise<unknown[]>
- command(subcommand: "LIST", filterby: "FILTERBY", moduleNameToken: "MODULE", moduleName: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- command(subcommand: "LIST", filterby: "FILTERBY", categoryToken: "ACLCAT", category: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- command(subcommand: "LIST", filterby: "FILTERBY", patternToken: "PATTERN", pattern: string, callback?: Callback<unknown[]>): Promise<unknown[]>
- \n
Get total number of Redis commands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "COUNT"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Get array of specific Redis command documentation
\n- \n
- group: server \n
- complexity: O(N) where N is the number of commands to look up \n
- since: 7.0.0 \n
Parameters
subcommand: "DOCS"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
Rest ...args: [subcommand: "DOCS", ...commandNames: (string | Buffer)[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [subcommand: "DOCS", ...commandNames: (string | Buffer)[]]
Returns Promise<unknown[]>
- \n
Extract keys given a full Redis command
\n- \n
- group: server \n
- complexity: O(N) where N is the number of arguments to the command \n
- since: 2.8.13 \n
Parameters
subcommand: "GETKEYS"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Extract keys and access flags given a full Redis command
\n- \n
- group: server \n
- complexity: O(N) where N is the number of arguments to the command \n
- since: 7.0.0 \n
Parameters
subcommand: "GETKEYSANDFLAGS"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Show helpful text about the different subcommands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Get array of specific Redis command details, or all when no argument is given.
\n- \n
- group: server \n
- complexity: O(N) where N is the number of commands to look up \n
- since: 2.8.13 \n
Parameters
subcommand: "INFO"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
Rest ...args: [subcommand: "INFO", ...commandNames: (string | Buffer)[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [subcommand: "INFO", ...commandNames: (string | Buffer)[]]
Returns Promise<unknown[]>
- \n
Get an array of Redis command names
\n- \n
- group: server \n
- complexity: O(N) where N is the total number of Redis commands \n
- since: 7.0.0 \n
Parameters
subcommand: "LIST"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
subcommand: "LIST"
filterby: "FILTERBY"
moduleNameToken: "MODULE"
moduleName: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
subcommand: "LIST"
filterby: "FILTERBY"
categoryToken: "ACLCAT"
category: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
subcommand: "LIST"
filterby: "FILTERBY"
patternToken: "PATTERN"
pattern: string
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
config
- config(...args: [subcommand: "GET", ...parameters: (string | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- config(...args: [subcommand: "GET", ...parameters: (string | Buffer)[]]): Promise<unknown>
- config(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- config(subcommand: "RESETSTAT", callback?: Callback<unknown>): Promise<unknown>
- config(subcommand: "REWRITE", callback?: Callback<unknown>): Promise<unknown>
- config(...args: [subcommand: "SET", ...parameterValues: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- config(...args: [subcommand: "SET", ...parameterValues: (string | number | Buffer)[]]): Promise<unknown>
- \n
Get the values of configuration parameters
\n- \n
- group: server \n
- complexity: O(N) when N is the number of configuration parameters provided \n
- since: 2.0.0 \n
Parameters
Rest ...args: [subcommand: "GET", ...parameters: (string | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "GET", ...parameters: (string | Buffer)[]]
Returns Promise<unknown>
- \n
Show helpful text about the different subcommands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Reset the stats returned by INFO
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
subcommand: "RESETSTAT"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Rewrite the configuration file with the in memory configuration
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.0 \n
Parameters
subcommand: "REWRITE"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Set configuration parameters to the given values
\n- \n
- group: server \n
- complexity: O(N) when N is the number of configuration parameters provided \n
- since: 2.0.0 \n
Parameters
Rest ...args: [subcommand: "SET", ...parameterValues: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "SET", ...parameterValues: (string | number | Buffer)[]]
Returns Promise<unknown>
connect
- connect(): Promise<void>
- \n
Connect to a cluster
\nReturns Promise<void>
copy
- copy(source: RedisKey, destination: RedisKey, callback?: Callback<number>): Promise<number>
- copy(source: RedisKey, destination: RedisKey, replace: "REPLACE", callback?: Callback<number>): Promise<number>
- copy(source: RedisKey, destination: RedisKey, destinationDbToken: "DB", destinationDb: string | number, callback?: Callback<number>): Promise<number>
- copy(source: RedisKey, destination: RedisKey, destinationDbToken: "DB", destinationDb: string | number, replace: "REPLACE", callback?: Callback<number>): Promise<number>
- \n
Copy a key
\n- \n
- group: generic \n
- complexity: O(N) worst case for collections, where N is the number of nested items. O(1) for string values. \n
- since: 6.2.0 \n
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
source: RedisKey
destination: RedisKey
destinationDbToken: "DB"
destinationDb: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
source: RedisKey
destination: RedisKey
destinationDbToken: "DB"
destinationDb: string | number
replace: "REPLACE"
Optional callback: Callback<number>
Returns Promise<number>
create
- create
Builtin Command(commandName: string): { buffer: any; string: any }
- \n
Create a builtin command
\nParameters
commandName: string
Returns { buffer: any; string: any }
buffer: any
string: any
dbsize
- dbsize(callback?: Callback<number>): Promise<number>
- \n
Return the number of keys in the selected database
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<number>
Returns Promise<number>
debug
- debug(subcommand: string, callback?: Callback<unknown>): Promise<unknown>
- debug(...args: [subcommand: string, ...args: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- debug(...args: [subcommand: string, ...args: (string | number | Buffer)[]]): Promise<unknown>
- \n
A container for debugging commands
\n- \n
- group: server \n
- complexity: Depends on subcommand. \n
- since: 1.0.0 \n
Parameters
subcommand: string
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: string, ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: string, ...args: (string | number | Buffer)[]]
Returns Promise<unknown>
decr
- decr(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Decrement the integer value of a key by one
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
decrby
- decrby(key: RedisKey, decrement: string | number, callback?: Callback<number>): Promise<number>
- \n
Decrement the integer value of a key by the given number
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
decrement: string | number
Optional callback: Callback<number>
Returns Promise<number>
define
- define
Command(name: string, definition: { lua: string; numberOfKeys?: number; readOnly?: boolean }): void
- \n
Define a custom command using lua script
\nParameters
name: string
definition: { lua: string; numberOfKeys?: number; readOnly?: boolean }
lua: string
Optional number
Of Keys?: number Optional read
Only?: boolean
Returns void
del
- del(...args: [...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- del(...args: [keys: RedisKey[], callback: Callback<number>]): Promise<number>
- del(...args: RedisKey[]): Promise<number>
- del(...args: [keys: RedisKey[]]): Promise<number>
- \n
Delete a key
\n- \n
- group: generic \n
- complexity: O(N) where N is the number of keys that will be removed. When a key to remove holds a value other than a string, the individual complexity for this key is O(M) where M is the number of elements in the list, set, sorted set or hash. Removing a single key that holds a string value is O(1). \n
- since: 1.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: RedisKey[]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<number>
discard
- discard(callback?: Callback<"OK">): Promise<"OK">
- \n
Discard all commands issued after MULTI
\n- \n
- group: transactions \n
- complexity: O(N), when N is the number of queued commands \n
- since: 2.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
disconnect
- disconnect(reconnect?: boolean): void
- \n
Disconnect from every node in the cluster.
\nParameters
reconnect: boolean = false
Returns void
dump
- dump(key: RedisKey, callback?: Callback<string>): Promise<string>
- \n
Return a serialized version of the value stored at the specified key.
\n- \n
- group: generic \n
- complexity: O(1) to access the key and additional O(NM) to serialize it, where N is the number of Redis objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1M) where M is small, so simply O(1). \n
- since: 2.6.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
dump
- dump
Buffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
duplicate
- duplicate(overrideStartupNodes?: any[], overrideOptions?: {}): Cluster
- \n
Create a new instance with the same startup nodes and options as the current one.
\nParameters
overrideStartupNodes: any[] = []
overrideOptions: {} = {}
Returns Cluster
echo
- echo(message: string | Buffer, callback?: Callback<string>): Promise<string>
- \n
Echo the given string
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
message: string | Buffer
Optional callback: Callback<string>
Returns Promise<string>
echo
- echo
Buffer(message: string | Buffer, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
message: string | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
eval
- eval(script: string | Buffer, numkeys: string | number, callback?: Callback<unknown>): Promise<unknown>
- eval(...args: [script: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- eval(...args: [script: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[]]): Promise<unknown>
- eval(...args: [script: string | Buffer, numkeys: string | number, ...keys: RedisKey[], callback: Callback<unknown>]): Promise<unknown>
- eval(...args: [script: string | Buffer, numkeys: string | number, keys: RedisKey[], callback: Callback<unknown>]): Promise<unknown>
- eval(...args: [script: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]): Promise<unknown>
- eval(...args: [script: string | Buffer, numkeys: string | number, keys: RedisKey[]]): Promise<unknown>
- eval(...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown>
- eval(...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[]]): Promise<unknown>
- \n
Execute a Lua script server side
\n- \n
- group: scripting \n
- complexity: Depends on the script that is executed. \n
- since: 2.6.0 \n
Parameters
script: string | Buffer
numkeys: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[]]
Returns Promise<unknown>
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...keys: RedisKey[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, keys: RedisKey[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<unknown>
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, keys: RedisKey[]]
Returns Promise<unknown>
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
eval_
- eval_
ro(...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown> - eval_
ro(...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[]]): Promise<unknown>
- \n
Execute a read-only Lua script server side
\n- \n
- group: scripting \n
- complexity: Depends on the script that is executed. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
evalsha
- evalsha(sha1: string | Buffer, numkeys: string | number, callback?: Callback<unknown>): Promise<unknown>
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[]]): Promise<unknown>
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, ...keys: RedisKey[], callback: Callback<unknown>]): Promise<unknown>
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, keys: RedisKey[], callback: Callback<unknown>]): Promise<unknown>
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]): Promise<unknown>
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, keys: RedisKey[]]): Promise<unknown>
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown>
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[]]): Promise<unknown>
- \n
Execute a Lua script server side
\n- \n
- group: scripting \n
- complexity: Depends on the script that is executed. \n
- since: 2.6.0 \n
Parameters
sha1: string | Buffer
numkeys: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[]]
Returns Promise<unknown>
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...keys: RedisKey[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, keys: RedisKey[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<unknown>
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, keys: RedisKey[]]
Returns Promise<unknown>
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
evalsha_
- evalsha_
ro(...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown> - evalsha_
ro(...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[]]): Promise<unknown>
- \n
Execute a read-only Lua script server side
\n- \n
- group: scripting \n
- complexity: Depends on the script that is executed. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
exec
- exec(callback?: Callback<[error: Error, result: unknown][]>): Promise<[error: Error, result: unknown][]>
- \n
Execute all commands issued after MULTI
\n- \n
- group: transactions \n
- complexity: Depends on commands in the transaction \n
- since: 1.2.0 \n
Parameters
Optional callback: Callback<[error: Error, result: unknown][]>
Returns Promise<[error: Error, result: unknown][]>
exists
- exists(...args: [...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- exists(...args: [keys: RedisKey[], callback: Callback<number>]): Promise<number>
- exists(...args: RedisKey[]): Promise<number>
- exists(...args: [keys: RedisKey[]]): Promise<number>
- \n
Determine if a key exists
\n- \n
- group: generic \n
- complexity: O(N) where N is the number of keys to check. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: RedisKey[]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<number>
expire
- expire(key: RedisKey, seconds: string | number, callback?: Callback<number>): Promise<number>
- expire(key: RedisKey, seconds: string | number, nx: "NX", callback?: Callback<number>): Promise<number>
- expire(key: RedisKey, seconds: string | number, xx: "XX", callback?: Callback<number>): Promise<number>
- expire(key: RedisKey, seconds: string | number, gt: "GT", callback?: Callback<number>): Promise<number>
- expire(key: RedisKey, seconds: string | number, lt: "LT", callback?: Callback<number>): Promise<number>
- \n
Set a key's time to live in seconds
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
seconds: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
seconds: string | number
nx: "NX"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
seconds: string | number
xx: "XX"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
seconds: string | number
gt: "GT"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
seconds: string | number
lt: "LT"
Optional callback: Callback<number>
Returns Promise<number>
expireat
- expireat(key: RedisKey, unixTimeSeconds: string | number, callback?: Callback<number>): Promise<number>
- expireat(key: RedisKey, unixTimeSeconds: string | number, nx: "NX", callback?: Callback<number>): Promise<number>
- expireat(key: RedisKey, unixTimeSeconds: string | number, xx: "XX", callback?: Callback<number>): Promise<number>
- expireat(key: RedisKey, unixTimeSeconds: string | number, gt: "GT", callback?: Callback<number>): Promise<number>
- expireat(key: RedisKey, unixTimeSeconds: string | number, lt: "LT", callback?: Callback<number>): Promise<number>
- \n
Set the expiration for a key as a UNIX timestamp
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.2.0 \n
Parameters
key: RedisKey
unixTimeSeconds: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
unixTimeSeconds: string | number
nx: "NX"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
unixTimeSeconds: string | number
xx: "XX"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
unixTimeSeconds: string | number
gt: "GT"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
unixTimeSeconds: string | number
lt: "LT"
Optional callback: Callback<number>
Returns Promise<number>
expiretime
- expiretime(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Get the expiration Unix timestamp for a key
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
failover
- failover(callback?: Callback<"OK">): Promise<"OK">
- failover(millisecondsToken: "TIMEOUT", milliseconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- failover(abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- failover(abort: "ABORT", millisecondsToken: "TIMEOUT", milliseconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- failover(targetToken: "TO", host: string | Buffer, port: string | number, callback?: Callback<"OK">): Promise<"OK">
- failover(targetToken: "TO", host: string | Buffer, port: string | number, millisecondsToken: "TIMEOUT", milliseconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- failover(targetToken: "TO", host: string | Buffer, port: string | number, abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- failover(targetToken: "TO", host: string | Buffer, port: string | number, abort: "ABORT", millisecondsToken: "TIMEOUT", milliseconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- failover(targetToken: "TO", host: string | Buffer, port: string | number, force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
- failover(targetToken: "TO", host: string | Buffer, port: string | number, force: "FORCE", millisecondsToken: "TIMEOUT", milliseconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- failover(targetToken: "TO", host: string | Buffer, port: string | number, force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- failover(targetToken: "TO", host: string | Buffer, port: string | number, force: "FORCE", abort: "ABORT", millisecondsToken: "TIMEOUT", milliseconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- \n
Start a coordinated failover between this server and one of its replicas.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
millisecondsToken: "TIMEOUT"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
abort: "ABORT"
millisecondsToken: "TIMEOUT"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
millisecondsToken: "TIMEOUT"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
abort: "ABORT"
millisecondsToken: "TIMEOUT"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
force: "FORCE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
force: "FORCE"
millisecondsToken: "TIMEOUT"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
force: "FORCE"
abort: "ABORT"
millisecondsToken: "TIMEOUT"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
fcall
- fcall(...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown>
- fcall(...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[]]): Promise<unknown>
- \n
Invoke a function
\n- \n
- group: scripting \n
- complexity: Depends on the function that is executed. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
fcall_
- fcall_
ro(...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown> - fcall_
ro(...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[]]): Promise<unknown>
- \n
Invoke a read-only function
\n- \n
- group: scripting \n
- complexity: Depends on the function that is executed. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
flushall
- flushall(callback?: Callback<"OK">): Promise<"OK">
- flushall(async: "ASYNC", callback?: Callback<"OK">): Promise<"OK">
- flushall(sync: "SYNC", callback?: Callback<"OK">): Promise<"OK">
- \n
Remove all keys from all databases
\n- \n
- group: server \n
- complexity: O(N) where N is the total number of keys in all databases \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
async: "ASYNC"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
sync: "SYNC"
Optional callback: Callback<"OK">
Returns Promise<"OK">
flushdb
- flushdb(callback?: Callback<"OK">): Promise<"OK">
- flushdb(async: "ASYNC", callback?: Callback<"OK">): Promise<"OK">
- flushdb(sync: "SYNC", callback?: Callback<"OK">): Promise<"OK">
- \n
Remove all keys from the current database
\n- \n
- group: server \n
- complexity: O(N) where N is the number of keys in the selected database \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
async: "ASYNC"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
sync: "SYNC"
Optional callback: Callback<"OK">
Returns Promise<"OK">
function
- function(subcommand: "DELETE", libraryName: string | Buffer, callback?: Callback<string>): Promise<string>
- function(subcommand: "DUMP", callback?: Callback<string>): Promise<string>
- function(subcommand: "FLUSH", callback?: Callback<string>): Promise<string>
- function(subcommand: "FLUSH", async: "ASYNC", callback?: Callback<string>): Promise<string>
- function(subcommand: "FLUSH", sync: "SYNC", callback?: Callback<string>): Promise<string>
- function(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- function(subcommand: "KILL", callback?: Callback<string>): Promise<string>
- function(subcommand: "LIST", callback?: Callback<unknown[]>): Promise<unknown[]>
- function(subcommand: "LIST", withcode: "WITHCODE", callback?: Callback<unknown[]>): Promise<unknown[]>
- function(subcommand: "LIST", libraryNamePatternToken: "LIBRARYNAME", libraryNamePattern: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- function(subcommand: "LIST", libraryNamePatternToken: "LIBRARYNAME", libraryNamePattern: string | Buffer, withcode: "WITHCODE", callback?: Callback<unknown[]>): Promise<unknown[]>
- function(subcommand: "LOAD", functionCode: string | Buffer, callback?: Callback<string>): Promise<string>
- function(subcommand: "LOAD", replace: "REPLACE", functionCode: string | Buffer, callback?: Callback<string>): Promise<string>
- function(subcommand: "RESTORE", serializedValue: string | number | Buffer, callback?: Callback<string>): Promise<string>
- function(subcommand: "RESTORE", serializedValue: string | number | Buffer, flush: "FLUSH", callback?: Callback<string>): Promise<string>
- function(subcommand: "RESTORE", serializedValue: string | number | Buffer, append: "APPEND", callback?: Callback<string>): Promise<string>
- function(subcommand: "RESTORE", serializedValue: string | number | Buffer, replace: "REPLACE", callback?: Callback<string>): Promise<string>
- function(subcommand: "STATS", callback?: Callback<unknown>): Promise<unknown>
- \n
Delete a function by name
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
subcommand: "DELETE"
libraryName: string | Buffer
Optional callback: Callback<string>
Returns Promise<string>
- \n
Dump all functions into a serialized binary payload
\n- \n
- group: scripting \n
- complexity: O(N) where N is the number of functions \n
- since: 7.0.0 \n
Parameters
subcommand: "DUMP"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Deleting all functions
\n- \n
- group: scripting \n
- complexity: O(N) where N is the number of functions deleted \n
- since: 7.0.0 \n
Parameters
subcommand: "FLUSH"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
subcommand: "FLUSH"
async: "ASYNC"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
subcommand: "FLUSH"
sync: "SYNC"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Show helpful text about the different subcommands
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Kill the function currently in execution.
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
subcommand: "KILL"
Optional callback: Callback<string>
Returns Promise<string>
- \n
List information about all the functions
\n- \n
- group: scripting \n
- complexity: O(N) where N is the number of functions \n
- since: 7.0.0 \n
Parameters
subcommand: "LIST"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
subcommand: "LIST"
withcode: "WITHCODE"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
subcommand: "LIST"
libraryNamePatternToken: "LIBRARYNAME"
libraryNamePattern: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
subcommand: "LIST"
libraryNamePatternToken: "LIBRARYNAME"
libraryNamePattern: string | Buffer
withcode: "WITHCODE"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Create a function with the given arguments (name, code, description)
\n- \n
- group: scripting \n
- complexity: O(1) (considering compilation time is redundant) \n
- since: 7.0.0 \n
Parameters
subcommand: "LOAD"
functionCode: string | Buffer
Optional callback: Callback<string>
Returns Promise<string>
Parameters
subcommand: "LOAD"
replace: "REPLACE"
functionCode: string | Buffer
Optional callback: Callback<string>
Returns Promise<string>
- \n
Restore all the functions on the given payload
\n- \n
- group: scripting \n
- complexity: O(N) where N is the number of functions on the payload \n
- since: 7.0.0 \n
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
Optional callback: Callback<string>
Returns Promise<string>
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
flush: "FLUSH"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
append: "APPEND"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
replace: "REPLACE"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Return information about the function currently running (name, description, duration)
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
subcommand: "STATS"
Optional callback: Callback<unknown>
Returns Promise<unknown>
function
- function
Buffer(subcommand: "DELETE", libraryName: string | Buffer, callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "DUMP", callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "FLUSH", callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "FLUSH", async: "ASYNC", callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "FLUSH", sync: "SYNC", callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "KILL", callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "LOAD", functionCode: string | Buffer, callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "LOAD", replace: "REPLACE", functionCode: string | Buffer, callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "RESTORE", serializedValue: string | number | Buffer, callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "RESTORE", serializedValue: string | number | Buffer, flush: "FLUSH", callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "RESTORE", serializedValue: string | number | Buffer, append: "APPEND", callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "RESTORE", serializedValue: string | number | Buffer, replace: "REPLACE", callback?: Callback<Buffer>): Promise<Buffer>
Parameters
subcommand: "DELETE"
libraryName: string | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "DUMP"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "FLUSH"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "FLUSH"
async: "ASYNC"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "FLUSH"
sync: "SYNC"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "KILL"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "LOAD"
functionCode: string | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "LOAD"
replace: "REPLACE"
functionCode: string | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
flush: "FLUSH"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
append: "APPEND"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
replace: "REPLACE"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
geoadd
- geoadd(...args: [key: RedisKey, ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- geoadd(...args: [key: RedisKey, ...longitudeLatitudeMembers: (string | number | Buffer)[]]): Promise<number>
- geoadd(...args: [key: RedisKey, ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- geoadd(...args: [key: RedisKey, ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[]]): Promise<number>
- geoadd(...args: [key: RedisKey, nx: "NX", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- geoadd(...args: [key: RedisKey, nx: "NX", ...longitudeLatitudeMembers: (string | number | Buffer)[]]): Promise<number>
- geoadd(...args: [key: RedisKey, nx: "NX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- geoadd(...args: [key: RedisKey, nx: "NX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[]]): Promise<number>
- geoadd(...args: [key: RedisKey, xx: "XX", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- geoadd(...args: [key: RedisKey, xx: "XX", ...longitudeLatitudeMembers: (string | number | Buffer)[]]): Promise<number>
- geoadd(...args: [key: RedisKey, xx: "XX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- geoadd(...args: [key: RedisKey, xx: "XX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[]]): Promise<number>
- \n
Add one or more geospatial items in the geospatial index represented using a sorted set
\n- \n
- group: geo \n
- complexity: O(log(N)) for each item added, where N is the number of elements in the sorted set. \n
- since: 3.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...longitudeLatitudeMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ...longitudeLatitudeMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ...longitudeLatitudeMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[]]
Returns Promise<number>
geodist
- geodist(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, callback?: Callback<string>): Promise<string>
- geodist(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, m: "M", callback?: Callback<string>): Promise<string>
- geodist(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, km: "KM", callback?: Callback<string>): Promise<string>
- geodist(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, ft: "FT", callback?: Callback<string>): Promise<string>
- geodist(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, mi: "MI", callback?: Callback<string>): Promise<string>
- \n
Returns the distance between two members of a geospatial index
\n- \n
- group: geo \n
- complexity: O(log(N)) \n
- since: 3.2.0 \n
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
m: "M"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
km: "KM"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
ft: "FT"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
mi: "MI"
Optional callback: Callback<string>
Returns Promise<string>
geodist
- geodist
Buffer(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, callback?: Callback<Buffer>): Promise<Buffer> - geodist
Buffer(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, m: "M", callback?: Callback<Buffer>): Promise<Buffer> - geodist
Buffer(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, km: "KM", callback?: Callback<Buffer>): Promise<Buffer> - geodist
Buffer(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, ft: "FT", callback?: Callback<Buffer>): Promise<Buffer> - geodist
Buffer(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, mi: "MI", callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
m: "M"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
km: "KM"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
ft: "FT"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
mi: "MI"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
geohash
- geohash(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- geohash(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- geohash(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): Promise<string[]>
- geohash(...args: [key: RedisKey, members: (string | number | Buffer)[]]): Promise<string[]>
- \n
Returns members of a geospatial index as standard geohash strings
\n- \n
- group: geo \n
- complexity: O(log(N)) for each member requested, where N is the number of elements in the sorted set. \n
- since: 3.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<string[]>
geohash
- geohash
Buffer(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - geohash
Buffer(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - geohash
Buffer(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): Promise<Buffer[]> - geohash
Buffer(...args: [key: RedisKey, members: (string | number | Buffer)[]]): Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<Buffer[]>
geopos
- geopos(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<[longitude: string, latitude: string][]>]): Promise<[longitude: string, latitude: string][]>
- geopos(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<[longitude: string, latitude: string][]>]): Promise<[longitude: string, latitude: string][]>
- geopos(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): Promise<[longitude: string, latitude: string][]>
- geopos(...args: [key: RedisKey, members: (string | number | Buffer)[]]): Promise<[longitude: string, latitude: string][]>
- \n
Returns longitude and latitude of members of a geospatial index
\n- \n
- group: geo \n
- complexity: O(N) where N is the number of members requested. \n
- since: 3.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<[longitude: string, latitude: string][]>]
Returns Promise<[longitude: string, latitude: string][]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<[longitude: string, latitude: string][]>]
Returns Promise<[longitude: string, latitude: string][]>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<[longitude: string, latitude: string][]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<[longitude: string, latitude: string][]>
georadius
- georadius(...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- georadius(...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[]]): Promise<unknown[]>
- \n
Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point
\n- \n
- group: geo \n
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index. \n
- since: 3.2.0 \n
Parameters
Rest ...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[]]
Returns Promise<unknown[]>
georadius_
- georadius_
ro(...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown> - georadius_
ro(...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[]]): Promise<unknown>
- \n
A read-only variant for GEORADIUS
\n- \n
- group: geo \n
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index. \n
- since: 3.2.10 \n
Parameters
Rest ...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
georadiusbymember
- georadiusbymember(...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown>
- georadiusbymember(...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[]]): Promise<unknown>
- \n
Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a member
\n- \n
- group: geo \n
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index. \n
- since: 3.2.0 \n
Parameters
Rest ...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
georadiusbymember_
- georadiusbymember_
ro(...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown> - georadiusbymember_
ro(...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[]]): Promise<unknown>
- \n
A read-only variant for GEORADIUSBYMEMBER
\n- \n
- group: geo \n
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index. \n
- since: 3.2.10 \n
Parameters
Rest ...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
geosearch
- geosearch(...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- geosearch(...args: [key: RedisKey, ...args: RedisValue[]]): Promise<unknown[]>
- \n
Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle.
\n- \n
- group: geo \n
- complexity: O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape \n
- since: 6.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[]]
Returns Promise<unknown[]>
geosearchstore
- geosearchstore(...args: [destination: RedisKey, source: RedisKey, ...args: RedisValue[], callback: Callback<number>]): Promise<number>
- geosearchstore(...args: [destination: RedisKey, source: RedisKey, ...args: RedisValue[]]): Promise<number>
- \n
Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle, and store the result in another key.
\n- \n
- group: geo \n
- complexity: O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape \n
- since: 6.2.0 \n
Parameters
Rest ...args: [destination: RedisKey, source: RedisKey, ...args: RedisValue[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, source: RedisKey, ...args: RedisValue[]]
Returns Promise<number>
get
- get(key: RedisKey, callback?: Callback<string>): Promise<string>
- \n
Get the value of a key
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
get
- get
Buffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
get
- get
Builtin Commands(): string[]
- \n
Return supported builtin commands
\nReturns string[]
getbit
- getbit(key: RedisKey, offset: string | number, callback?: Callback<number>): Promise<number>
- \n
Returns the bit value at offset in the string value stored at key
\n- \n
- group: bitmap \n
- complexity: O(1) \n
- since: 2.2.0 \n
Parameters
key: RedisKey
offset: string | number
Optional callback: Callback<number>
Returns Promise<number>
getdel
- getdel(key: RedisKey, callback?: Callback<string>): Promise<string>
- \n
Get the value of a key and delete the key
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
getdel
- getdel
Buffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
getex
- getex(key: RedisKey, callback?: Callback<string>): Promise<string>
- getex(key: RedisKey, secondsToken: "EX", seconds: string | number, callback?: Callback<string>): Promise<string>
- getex(key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, callback?: Callback<string>): Promise<string>
- getex(key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, callback?: Callback<string>): Promise<string>
- getex(key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, callback?: Callback<string>): Promise<string>
- getex(key: RedisKey, persist: "PERSIST", callback?: Callback<string>): Promise<string>
- \n
Get the value of a key and optionally set its expiration
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
secondsToken: "EX"
seconds: string | number
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
millisecondsToken: "PX"
milliseconds: string | number
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
persist: "PERSIST"
Optional callback: Callback<string>
Returns Promise<string>
getex
- getex
Buffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer> - getex
Buffer(key: RedisKey, secondsToken: "EX", seconds: string | number, callback?: Callback<Buffer>): Promise<Buffer> - getex
Buffer(key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, callback?: Callback<Buffer>): Promise<Buffer> - getex
Buffer(key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, callback?: Callback<Buffer>): Promise<Buffer> - getex
Buffer(key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, callback?: Callback<Buffer>): Promise<Buffer> - getex
Buffer(key: RedisKey, persist: "PERSIST", callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
secondsToken: "EX"
seconds: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
millisecondsToken: "PX"
milliseconds: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
persist: "PERSIST"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
getrange
- getrange(key: RedisKey, start: string | number, end: string | number, callback?: Callback<string>): Promise<string>
- \n
Get a substring of the string stored at a key
\n- \n
- group: string \n
- complexity: O(N) where N is the length of the returned string. The complexity is ultimately determined by the returned length, but because creating a substring from an existing string is very cheap, it can be considered O(1) for small strings. \n
- since: 2.4.0 \n
Parameters
key: RedisKey
start: string | number
end: string | number
Optional callback: Callback<string>
Returns Promise<string>
getrange
- getrange
Buffer(key: RedisKey, start: string | number, end: string | number, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
start: string | number
end: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
getset
- getset(key: RedisKey, value: string | number | Buffer, callback?: Callback<string>): Promise<string>
- \n
Set the string value of a key and return its old value
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
value: string | number | Buffer
Optional callback: Callback<string>
Returns Promise<string>
getset
- getset
Buffer(key: RedisKey, value: string | number | Buffer, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
hdel
- hdel(...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<number>]): Promise<number>
- hdel(...args: [key: RedisKey, ...fields: (string | Buffer)[]]): Promise<number>
- \n
Delete one or more hash fields
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of fields to be removed. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...fields: (string | Buffer)[]]
Returns Promise<number>
hello
- hello(callback?: Callback<unknown[]>): Promise<unknown[]>
- hello(protover: string | number, callback?: Callback<unknown[]>): Promise<unknown[]>
- hello(protover: string | number, clientnameToken: "SETNAME", clientname: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- hello(protover: string | number, usernamePasswordToken: "AUTH", username: string | Buffer, password: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- hello(protover: string | number, usernamePasswordToken: "AUTH", username: string | Buffer, password: string | Buffer, clientnameToken: "SETNAME", clientname: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- \n
Handshake with Redis
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 6.0.0 \n
Parameters
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
protover: string | number
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
protover: string | number
clientnameToken: "SETNAME"
clientname: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
protover: string | number
usernamePasswordToken: "AUTH"
username: string | Buffer
password: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
protover: string | number
usernamePasswordToken: "AUTH"
username: string | Buffer
password: string | Buffer
clientnameToken: "SETNAME"
clientname: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
hexists
- hexists(key: RedisKey, field: string | Buffer, callback?: Callback<number>): Promise<number>
- \n
Determine if a hash field exists
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
field: string | Buffer
Optional callback: Callback<number>
Returns Promise<number>
hexpire
- hexpire(...args: [key: RedisKey, seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpire(...args: [key: RedisKey, seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hexpire(...args: [key: RedisKey, seconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpire(...args: [key: RedisKey, seconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hexpire(...args: [key: RedisKey, seconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpire(...args: [key: RedisKey, seconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hexpire(...args: [key: RedisKey, seconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpire(...args: [key: RedisKey, seconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hexpire(...args: [key: RedisKey, seconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpire(...args: [key: RedisKey, seconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- \n
Set expiry for hash field using relative time to expire (seconds)
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
hexpireat
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- \n
Set expiry for hash field using an absolute Unix timestamp (seconds)
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
hexpiretime
- hexpiretime(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpiretime(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- \n
Returns the expiration time of a hash field as a Unix timestamp, in seconds.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
hget
- hget(key: RedisKey, field: string | Buffer, callback?: Callback<string>): Promise<string>
- \n
Get the value of a hash field
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
field: string | Buffer
Optional callback: Callback<string>
Returns Promise<string>
hget
- hget
Buffer(key: RedisKey, field: string | Buffer, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
field: string | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
hgetall
- hgetall(key: RedisKey, callback?: Callback<Record<string, string>>): Promise<Record<string, string>>
- \n
Get all the fields and values in a hash
\n- \n
- group: hash \n
- complexity: O(N) where N is the size of the hash. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<Record<string, string>>
Returns Promise<Record<string, string>>
hgetall
- hgetall
Buffer(key: RedisKey, callback?: Callback<Record<string, Buffer>>): Promise<Record<string, Buffer>>
Parameters
key: RedisKey
Optional callback: Callback<Record<string, Buffer>>
Returns Promise<Record<string, Buffer>>
hgetdel
- hgetdel(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- hgetdel(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<string[]>
- \n
Returns the value of a field and deletes it from the hash.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 8.0.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<string[]>
hgetdel
- hgetdel
Buffer(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - hgetdel
Buffer(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<Buffer[]>
hgetex
- hgetex(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- hgetex(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<string[]>
- hgetex(...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- hgetex(...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<string[]>
- hgetex(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- hgetex(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<string[]>
- hgetex(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- hgetex(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<string[]>
- hgetex(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- hgetex(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<string[]>
- hgetex(...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- hgetex(...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<string[]>
- \n
Get the value of one or more fields of a given hash key, and optionally set their expiration.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 8.0.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<string[]>
hgetex
- hgetex
Buffer(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<Buffer[]>
hincrby
- hincrby(key: RedisKey, field: string | Buffer, increment: string | number, callback?: Callback<number>): Promise<number>
- \n
Increment the integer value of a hash field by the given number
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
field: string | Buffer
increment: string | number
Optional callback: Callback<number>
Returns Promise<number>
hincrbyfloat
- hincrbyfloat(key: RedisKey, field: string | Buffer, increment: string | number, callback?: Callback<string>): Promise<string>
- \n
Increment the float value of a hash field by the given amount
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
field: string | Buffer
increment: string | number
Optional callback: Callback<string>
Returns Promise<string>
hincrbyfloat
- hincrbyfloat
Buffer(key: RedisKey, field: string | Buffer, increment: string | number, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
field: string | Buffer
increment: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
hkeys
- hkeys(key: RedisKey, callback?: Callback<string[]>): Promise<string[]>
- \n
Get all the fields in a hash
\n- \n
- group: hash \n
- complexity: O(N) where N is the size of the hash. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string[]>
Returns Promise<string[]>
hkeys
- hkeys
Buffer(key: RedisKey, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
hlen
- hlen(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Get the number of fields in a hash
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
hmget
- hmget(...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- hmget(...args: [key: RedisKey, ...fields: (string | Buffer)[]]): Promise<string[]>
- \n
Get the values of all the given hash fields
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of fields being requested. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, ...fields: (string | Buffer)[]]
Returns Promise<string[]>
hmget
hmset
- hmset(key: RedisKey, object: object, callback?: Callback<"OK">): Promise<"OK">
- hmset(key: RedisKey, map: Map<string | number | Buffer, string | number | Buffer>, callback?: Callback<"OK">): Promise<"OK">
- hmset(...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[], callback: Callback<"OK">]): Promise<"OK">
- hmset(...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[]]): Promise<"OK">
- \n
Set multiple hash fields to multiple values
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of fields being set. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
object: object
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
map: Map<string | number | Buffer, string | number | Buffer>
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
Rest ...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[], callback: Callback<"OK">]
Returns Promise<"OK">
Parameters
Rest ...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[]]
Returns Promise<"OK">
hpersist
- hpersist(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpersist(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- \n
Removes the expiration time for each specified field
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
hpexpire
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- \n
Set expiry for hash field using relative time to expire (milliseconds)
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
hpexpireat
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- \n
Set expiry for hash field using an absolute Unix timestamp (milliseconds)
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
hpexpiretime
- hpexpiretime(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpiretime(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- \n
Returns the expiration time of a hash field as a Unix timestamp, in msec.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
hpttl
- hpttl(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpttl(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- \n
Returns the TTL in milliseconds of a hash field.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
hrandfield
- hrandfield(key: RedisKey, callback?: Callback<string | unknown[]>): Promise<string | unknown[]>
- hrandfield(key: RedisKey, count: string | number, callback?: Callback<string | unknown[]>): Promise<string | unknown[]>
- hrandfield(key: RedisKey, count: string | number, withvalues: "WITHVALUES", callback?: Callback<string | unknown[]>): Promise<string | unknown[]>
- \n
Get one or multiple random fields from a hash
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of fields returned \n
- since: 6.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string | unknown[]>
Returns Promise<string | unknown[]>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string | unknown[]>
Returns Promise<string | unknown[]>
Parameters
key: RedisKey
count: string | number
withvalues: "WITHVALUES"
Optional callback: Callback<string | unknown[]>
Returns Promise<string | unknown[]>
hrandfield
- hrandfield
Buffer(key: RedisKey, callback?: Callback<unknown[] | Buffer>): Promise<unknown[] | Buffer> - hrandfield
Buffer(key: RedisKey, count: string | number, callback?: Callback<unknown[] | Buffer>): Promise<unknown[] | Buffer> - hrandfield
Buffer(key: RedisKey, count: string | number, withvalues: "WITHVALUES", callback?: Callback<unknown[] | Buffer>): Promise<unknown[] | Buffer>
Parameters
key: RedisKey
Optional callback: Callback<unknown[] | Buffer>
Returns Promise<unknown[] | Buffer>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<unknown[] | Buffer>
Returns Promise<unknown[] | Buffer>
Parameters
key: RedisKey
count: string | number
withvalues: "WITHVALUES"
Optional callback: Callback<unknown[] | Buffer>
Returns Promise<unknown[] | Buffer>
hscan
- hscan(key: RedisKey, cursor: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- hscan(key: RedisKey, cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- hscan(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- hscan(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- \n
Incrementally iterate hash fields and associated values
\n- \n
- group: hash \n
- complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.. \n
- since: 2.8.0 \n
Parameters
key: RedisKey
cursor: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
key: RedisKey
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
hscan
- hscan
Buffer(key: RedisKey, cursor: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - hscan
Buffer(key: RedisKey, cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - hscan
Buffer(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - hscan
Buffer(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
hscan
- hscan
Buffer Stream(key: string, options?: ScanStreamOptions): default
Parameters
key: string
Optional options: ScanStreamOptions
Returns default
hscan
- hscan
Stream(key: string, options?: ScanStreamOptions): default
Parameters
key: string
Optional options: ScanStreamOptions
Returns default
hset
- hset(key: RedisKey, object: object, callback?: Callback<number>): Promise<number>
- hset(key: RedisKey, map: Map<string | number | Buffer, string | number | Buffer>, callback?: Callback<number>): Promise<number>
- hset(...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hset(...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[]]): Promise<number>
- \n
Set the string value of a hash field
\n- \n
- group: hash \n
- complexity: O(1) for each field/value pair added, so O(N) to add N field/value pairs when the command is called with multiple field/value pairs. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
object: object
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
map: Map<string | number | Buffer, string | number | Buffer>
Optional callback: Callback<number>
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[]]
Returns Promise<number>
hsetex
- hsetex(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- \n
Set the value of one or more fields of a given hash key, and optionally set their expiration.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of fields being set. \n
- since: 8.0.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
hsetnx
- hsetnx(key: RedisKey, field: string | Buffer, value: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Set the value of a hash field, only if the field does not exist
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
field: string | Buffer
value: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
hstrlen
- hstrlen(key: RedisKey, field: string | Buffer, callback?: Callback<number>): Promise<number>
- \n
Get the length of the value of a hash field
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 3.2.0 \n
Parameters
key: RedisKey
field: string | Buffer
Optional callback: Callback<number>
Returns Promise<number>
httl
- httl(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- httl(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- \n
Returns the TTL in seconds of a hash field.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
hvals
- hvals(key: RedisKey, callback?: Callback<string[]>): Promise<string[]>
- \n
Get all the values in a hash
\n- \n
- group: hash \n
- complexity: O(N) where N is the size of the hash. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string[]>
Returns Promise<string[]>
hvals
- hvals
Buffer(key: RedisKey, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
incr
- incr(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Increment the integer value of a key by one
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
incrby
- incrby(key: RedisKey, increment: string | number, callback?: Callback<number>): Promise<number>
- \n
Increment the integer value of a key by the given amount
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
increment: string | number
Optional callback: Callback<number>
Returns Promise<number>
incrbyfloat
- incrbyfloat(key: RedisKey, increment: string | number, callback?: Callback<string>): Promise<string>
- \n
Increment the float value of a key by the given amount
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
increment: string | number
Optional callback: Callback<string>
Returns Promise<string>
info
- info(callback?: Callback<string>): Promise<string>
- info(...args: [...sections: (string | Buffer)[], callback: Callback<string>]): Promise<string>
- info(...args: (string | Buffer)[]): Promise<string>
- \n
Get information and statistics about the server
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<string>
Returns Promise<string>
Parameters
Rest ...args: [...sections: (string | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: (string | Buffer)[]
Returns Promise<string>
keys
- keys(pattern: string, callback?: Callback<string[]>): Promise<string[]>
- \n
Find all keys matching the given pattern
\n- \n
- group: generic \n
- complexity: O(N) with N being the number of keys in the database, under the assumption that the key names in the database and the given pattern have limited length. \n
- since: 1.0.0 \n
Parameters
pattern: string
Optional callback: Callback<string[]>
Returns Promise<string[]>
keys
- keys
Buffer(pattern: string, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
pattern: string
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
lastsave
- lastsave(callback?: Callback<number>): Promise<number>
- \n
Get the UNIX time stamp of the last successful save to disk
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<number>
Returns Promise<number>
latency
- latency(subcommand: "DOCTOR", callback?: Callback<string>): Promise<string>
- latency(subcommand: "GRAPH", event: string | Buffer, callback?: Callback<string>): Promise<string>
- latency(subcommand: "HELP", callback?: Callback<unknown[]>): Promise<unknown[]>
- latency(subcommand: "HISTOGRAM", callback?: Callback<unknown>): Promise<unknown>
- latency(...args: [subcommand: "HISTOGRAM", ...commands: (string | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- latency(...args: [subcommand: "HISTOGRAM", ...commands: (string | Buffer)[]]): Promise<unknown>
- latency(subcommand: "HISTORY", event: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- latency(subcommand: "LATEST", callback?: Callback<unknown[]>): Promise<unknown[]>
- latency(subcommand: "RESET", callback?: Callback<number>): Promise<number>
- latency(...args: [subcommand: "RESET", ...events: (string | Buffer)[], callback: Callback<number>]): Promise<number>
- latency(...args: [subcommand: "RESET", ...events: (string | Buffer)[]]): Promise<number>
- \n
Return a human readable latency analysis report.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "DOCTOR"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Return a latency graph for the event.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "GRAPH"
event: string | Buffer
Optional callback: Callback<string>
Returns Promise<string>
- \n
Show helpful text about the different subcommands.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Return the cumulative distribution of latencies of a subset of commands or all.
\n- \n
- group: server \n
- complexity: O(N) where N is the number of commands with latency information being retrieved. \n
- since: 7.0.0 \n
Parameters
subcommand: "HISTOGRAM"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "HISTOGRAM", ...commands: (string | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "HISTOGRAM", ...commands: (string | Buffer)[]]
Returns Promise<unknown>
- \n
Return timestamp-latency samples for the event.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "HISTORY"
event: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Return the latest latency samples for all events.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "LATEST"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Reset latency data for one or more events.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "RESET"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
Rest ...args: [subcommand: "RESET", ...events: (string | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [subcommand: "RESET", ...events: (string | Buffer)[]]
Returns Promise<number>
lcs
- lcs(key1: RedisKey, key2: RedisKey, callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, lenToken: "MINMATCHLEN", len: string | number, callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, lenToken: "MINMATCHLEN", len: string | number, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, idx: "IDX", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, idx: "IDX", withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, idx: "IDX", lenToken: "MINMATCHLEN", len: string | number, callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, idx: "IDX", lenToken: "MINMATCHLEN", len: string | number, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", lenToken: "MINMATCHLEN", len1: string | number, callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", lenToken: "MINMATCHLEN", len1: string | number, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", idx: "IDX", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", idx: "IDX", withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", idx: "IDX", lenToken: "MINMATCHLEN", len1: string | number, callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", idx: "IDX", lenToken: "MINMATCHLEN", len1: string | number, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Promise<unknown>
- \n
Find longest common substring
\n- \n
- group: string \n
- complexity: O(N*M) where N and M are the lengths of s1 and s2, respectively \n
- since: 7.0.0 \n
Parameters
Returns Promise<unknown>
Parameters
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
lenToken: "MINMATCHLEN"
len: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
lenToken: "MINMATCHLEN"
len: string | number
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
idx: "IDX"
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
idx: "IDX"
lenToken: "MINMATCHLEN"
len: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
idx: "IDX"
lenToken: "MINMATCHLEN"
len: string | number
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
len: "LEN"
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
len: "LEN"
lenToken: "MINMATCHLEN"
len1: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
len: "LEN"
lenToken: "MINMATCHLEN"
len1: string | number
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
len: "LEN"
idx: "IDX"
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
len: "LEN"
idx: "IDX"
lenToken: "MINMATCHLEN"
len1: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
len: "LEN"
idx: "IDX"
lenToken: "MINMATCHLEN"
len1: string | number
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns Promise<unknown>
lindex
- lindex(key: RedisKey, index: string | number, callback?: Callback<string>): Promise<string>
- \n
Get an element from a list by its index
\n- \n
- group: list \n
- complexity: O(N) where N is the number of elements to traverse to get to the element at index. This makes asking for the first or the last element of the list O(1). \n
- since: 1.0.0 \n
Parameters
key: RedisKey
index: string | number
Optional callback: Callback<string>
Returns Promise<string>
lindex
- lindex
Buffer(key: RedisKey, index: string | number, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
index: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
linsert
- linsert(key: RedisKey, before: "BEFORE", pivot: string | number | Buffer, element: string | number | Buffer, callback?: Callback<number>): Promise<number>
- linsert(key: RedisKey, after: "AFTER", pivot: string | number | Buffer, element: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Insert an element before or after another element in a list
\n- \n
- group: list \n
- complexity: O(N) where N is the number of elements to traverse before seeing the value pivot. This means that inserting somewhere on the left end on the list (head) can be considered O(1) and inserting somewhere on the right end (tail) is O(N). \n
- since: 2.2.0 \n
Parameters
key: RedisKey
before: "BEFORE"
pivot: string | number | Buffer
element: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
after: "AFTER"
pivot: string | number | Buffer
element: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
llen
- llen(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Get the length of a list
\n- \n
- group: list \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
lmove
- lmove(source: RedisKey, destination: RedisKey, left: "LEFT", left1: "LEFT", callback?: Callback<string>): Promise<string>
- lmove(source: RedisKey, destination: RedisKey, left: "LEFT", right: "RIGHT", callback?: Callback<string>): Promise<string>
- lmove(source: RedisKey, destination: RedisKey, right: "RIGHT", left: "LEFT", callback?: Callback<string>): Promise<string>
- lmove(source: RedisKey, destination: RedisKey, right: "RIGHT", right1: "RIGHT", callback?: Callback<string>): Promise<string>
- \n
Pop an element from a list, push it to another list and return it
\n- \n
- group: list \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
Returns Promise<string>
Parameters
Returns Promise<string>
Parameters
Returns Promise<string>
Parameters
source: RedisKey
destination: RedisKey
right: "RIGHT"
right1: "RIGHT"
Optional callback: Callback<string>
Returns Promise<string>
lmove
- lmove
Buffer(source: RedisKey, destination: RedisKey, left: "LEFT", left1: "LEFT", callback?: Callback<Buffer>): Promise<Buffer> - lmove
Buffer(source: RedisKey, destination: RedisKey, left: "LEFT", right: "RIGHT", callback?: Callback<Buffer>): Promise<Buffer> - lmove
Buffer(source: RedisKey, destination: RedisKey, right: "RIGHT", left: "LEFT", callback?: Callback<Buffer>): Promise<Buffer> - lmove
Buffer(source: RedisKey, destination: RedisKey, right: "RIGHT", right1: "RIGHT", callback?: Callback<Buffer>): Promise<Buffer>
lmpop
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT"]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT"]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): Promise<[key: string, members: string[]]>
- \n
Pop elements from a list
\n- \n
- group: list \n
- complexity: O(N+M) where N is the number of provided keys and M is the number of elements returned. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns Promise<[key: string, members: string[]]>
lmpop
- lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT"]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT"]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns Promise<[key: Buffer, members: Buffer[]]>
lolwut
- lolwut(callback?: Callback<string>): Promise<string>
- lolwut(versionToken: "VERSION", version: string | number, callback?: Callback<string>): Promise<string>
- \n
Display some computer art and the Redis version
\n- \n
- group: server \n
- complexity: undefined \n
- since: 5.0.0 \n
Parameters
Optional callback: Callback<string>
Returns Promise<string>
Parameters
versionToken: "VERSION"
version: string | number
Optional callback: Callback<string>
Returns Promise<string>
lpop
- lpop(key: RedisKey, callback?: Callback<string>): Promise<string>
- lpop(key: RedisKey, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Remove and get the first elements in a list
\n- \n
- group: list \n
- complexity: O(N) where N is the number of elements returned \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
lpop
lpos
- lpos(key: RedisKey, element: string | number | Buffer, callback?: Callback<number>): Promise<number>
- lpos(key: RedisKey, element: string | number | Buffer, lenToken: "MAXLEN", len: string | number, callback?: Callback<number>): Promise<number>
- lpos(key: RedisKey, element: string | number | Buffer, numMatchesToken: "COUNT", numMatches: string | number, callback?: Callback<number[]>): Promise<number[]>
- lpos(key: RedisKey, element: string | number | Buffer, numMatchesToken: "COUNT", numMatches: string | number, lenToken: "MAXLEN", len: string | number, callback?: Callback<number[]>): Promise<number[]>
- lpos(key: RedisKey, element: string | number | Buffer, rankToken: "RANK", rank: string | number, callback?: Callback<number>): Promise<number>
- lpos(key: RedisKey, element: string | number | Buffer, rankToken: "RANK", rank: string | number, lenToken: "MAXLEN", len: string | number, callback?: Callback<number>): Promise<number>
- lpos(key: RedisKey, element: string | number | Buffer, rankToken: "RANK", rank: string | number, numMatchesToken: "COUNT", numMatches: string | number, callback?: Callback<number[]>): Promise<number[]>
- lpos(key: RedisKey, element: string | number | Buffer, rankToken: "RANK", rank: string | number, numMatchesToken: "COUNT", numMatches: string | number, lenToken: "MAXLEN", len: string | number, callback?: Callback<number[]>): Promise<number[]>
- \n
Return the index of matching elements on a list
\n- \n
- group: list \n
- complexity: O(N) where N is the number of elements in the list, for the average case. When searching for elements near the head or the tail of the list, or when the MAXLEN option is provided, the command may run in constant time. \n
- since: 6.0.6 \n
Parameters
key: RedisKey
element: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
element: string | number | Buffer
lenToken: "MAXLEN"
len: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
element: string | number | Buffer
numMatchesToken: "COUNT"
numMatches: string | number
Optional callback: Callback<number[]>
Returns Promise<number[]>
Parameters
key: RedisKey
element: string | number | Buffer
numMatchesToken: "COUNT"
numMatches: string | number
lenToken: "MAXLEN"
len: string | number
Optional callback: Callback<number[]>
Returns Promise<number[]>
Parameters
key: RedisKey
element: string | number | Buffer
rankToken: "RANK"
rank: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
element: string | number | Buffer
rankToken: "RANK"
rank: string | number
lenToken: "MAXLEN"
len: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
element: string | number | Buffer
rankToken: "RANK"
rank: string | number
numMatchesToken: "COUNT"
numMatches: string | number
Optional callback: Callback<number[]>
Returns Promise<number[]>
Parameters
key: RedisKey
element: string | number | Buffer
rankToken: "RANK"
rank: string | number
numMatchesToken: "COUNT"
numMatches: string | number
lenToken: "MAXLEN"
len: string | number
Optional callback: Callback<number[]>
Returns Promise<number[]>
lpush
- lpush(...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- lpush(...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]): Promise<number>
- \n
Prepend one or multiple elements to a list
\n- \n
- group: list \n
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns Promise<number>
lpushx
- lpushx(...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- lpushx(...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]): Promise<number>
- \n
Prepend an element to a list, only if the list exists
\n- \n
- group: list \n
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments. \n
- since: 2.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns Promise<number>
lrange
- lrange(key: RedisKey, start: string | number, stop: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Get a range of elements from a list
\n- \n
- group: list \n
- complexity: O(S+N) where S is the distance of start offset from HEAD for small lists, from nearest end (HEAD or TAIL) for large lists; and N is the number of elements in the specified range. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
start: string | number
stop: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
lrange
- lrange
Buffer(key: RedisKey, start: string | number, stop: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
start: string | number
stop: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
lrem
- lrem(key: RedisKey, count: string | number, element: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Remove elements from a list
\n- \n
- group: list \n
- complexity: O(N+M) where N is the length of the list and M is the number of elements removed. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
count: string | number
element: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
lset
- lset(key: RedisKey, index: string | number, element: string | number | Buffer, callback?: Callback<"OK">): Promise<"OK">
- \n
Set the value of an element in a list by its index
\n- \n
- group: list \n
- complexity: O(N) where N is the length of the list. Setting either the first or the last element of the list is O(1). \n
- since: 1.0.0 \n
Parameters
key: RedisKey
index: string | number
element: string | number | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
ltrim
- ltrim(key: RedisKey, start: string | number, stop: string | number, callback?: Callback<"OK">): Promise<"OK">
- \n
Trim a list to the specified range
\n- \n
- group: list \n
- complexity: O(N) where N is the number of elements to be removed by the operation. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
start: string | number
stop: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
memory
- memory(subcommand: "DOCTOR", callback?: Callback<string>): Promise<string>
- memory(subcommand: "HELP", callback?: Callback<unknown[]>): Promise<unknown[]>
- memory(subcommand: "MALLOC-STATS", callback?: Callback<string>): Promise<string>
- memory(subcommand: "PURGE", callback?: Callback<"OK">): Promise<"OK">
- memory(subcommand: "STATS", callback?: Callback<unknown[]>): Promise<unknown[]>
- memory(subcommand: "USAGE", key: RedisKey, callback?: Callback<number>): Promise<number>
- memory(subcommand: "USAGE", key: RedisKey, countToken: "SAMPLES", count: string | number, callback?: Callback<number>): Promise<number>
- \n
Outputs memory problems report
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 4.0.0 \n
Parameters
subcommand: "DOCTOR"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Show helpful text about the different subcommands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 4.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Show allocator internal stats
\n- \n
- group: server \n
- complexity: Depends on how much memory is allocated, could be slow \n
- since: 4.0.0 \n
Parameters
subcommand: "MALLOC-STATS"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Ask the allocator to release memory
\n- \n
- group: server \n
- complexity: Depends on how much memory is allocated, could be slow \n
- since: 4.0.0 \n
Parameters
subcommand: "PURGE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Show memory usage details
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 4.0.0 \n
Parameters
subcommand: "STATS"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Estimate the memory usage of a key
\n- \n
- group: server \n
- complexity: O(N) where N is the number of samples. \n
- since: 4.0.0 \n
Parameters
subcommand: "USAGE"
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
Parameters
subcommand: "USAGE"
key: RedisKey
countToken: "SAMPLES"
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
mget
- mget(...args: [...keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- mget(...args: [keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- mget(...args: RedisKey[]): Promise<string[]>
- mget(...args: [keys: RedisKey[]]): Promise<string[]>
- \n
Get the values of all the given keys
\n- \n
- group: string \n
- complexity: O(N) where N is the number of keys to retrieve. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: RedisKey[]
Returns Promise<string[]>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<string[]>
mget
- mget
Buffer(...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - mget
Buffer(...args: [keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - mget
Buffer(...args: RedisKey[]): Promise<Buffer[]> - mget
Buffer(...args: [keys: RedisKey[]]): Promise<Buffer[]>
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: RedisKey[]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<Buffer[]>
migrate
- migrate(...args: [host: string | Buffer, port: string | number, ...args: RedisValue[], callback: Callback<"OK">]): Promise<"OK">
- migrate(...args: [host: string | Buffer, port: string | number, ...args: RedisValue[]]): Promise<"OK">
- \n
Atomically transfer a key from a Redis instance to another one.
\n- \n
- group: generic \n
- complexity: This command actually executes a DUMP+DEL in the source instance, and a RESTORE in the target instance. See the pages of these commands for time complexity. Also an O(N) data transfer between the two instances is performed. \n
- since: 2.6.0 \n
Parameters
Rest ...args: [host: string | Buffer, port: string | number, ...args: RedisValue[], callback: Callback<"OK">]
Returns Promise<"OK">
Parameters
Rest ...args: [host: string | Buffer, port: string | number, ...args: RedisValue[]]
Returns Promise<"OK">
module
- module(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- module(subcommand: "LIST", callback?: Callback<unknown>): Promise<unknown>
- module(subcommand: "LOAD", path: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- module(...args: [subcommand: "LOAD", path: string | Buffer, ...args: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- module(...args: [subcommand: "LOAD", path: string | Buffer, ...args: (string | number | Buffer)[]]): Promise<unknown>
- module(subcommand: "LOADEX", path: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- module(...args: [subcommand: "LOADEX", path: string | Buffer, argsToken: "ARGS", ...args: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- module(...args: [subcommand: "LOADEX", path: string | Buffer, argsToken: "ARGS", ...args: (string | number | Buffer)[]]): Promise<unknown>
- module(...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...configs: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- module(...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...configs: (string | number | Buffer)[]]): Promise<unknown>
- module(...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown>
- module(...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...args: RedisValue[]]): Promise<unknown>
- module(subcommand: "UNLOAD", name: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- \n
Show helpful text about the different subcommands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
List all modules loaded by the server
\n- \n
- group: server \n
- complexity: O(N) where N is the number of loaded modules. \n
- since: 4.0.0 \n
Parameters
subcommand: "LIST"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Load a module
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 4.0.0 \n
Parameters
subcommand: "LOAD"
path: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LOAD", path: string | Buffer, ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LOAD", path: string | Buffer, ...args: (string | number | Buffer)[]]
Returns Promise<unknown>
- \n
Load a module with extended parameters
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
subcommand: "LOADEX"
path: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LOADEX", path: string | Buffer, argsToken: "ARGS", ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LOADEX", path: string | Buffer, argsToken: "ARGS", ...args: (string | number | Buffer)[]]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...configs: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...configs: (string | number | Buffer)[]]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...args: RedisValue[]]
Returns Promise<unknown>
- \n
Unload a module
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 4.0.0 \n
Parameters
subcommand: "UNLOAD"
name: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
move
- move(key: RedisKey, db: string | number, callback?: Callback<number>): Promise<number>
- \n
Move a key to another database
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
db: string | number
Optional callback: Callback<number>
Returns Promise<number>
mset
- mset(object: object, callback?: Callback<"OK">): Promise<"OK">
- mset(map: Map<string | number | Buffer, string | number | Buffer>, callback?: Callback<"OK">): Promise<"OK">
- mset(...args: [...keyValues: (number | RedisKey)[], callback: Callback<"OK">]): Promise<"OK">
- mset(...args: (number | RedisKey)[]): Promise<"OK">
- \n
Set multiple keys to multiple values
\n- \n
- group: string \n
- complexity: O(N) where N is the number of keys to set. \n
- since: 1.0.1 \n
Parameters
object: object
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
map: Map<string | number | Buffer, string | number | Buffer>
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
Rest ...args: [...keyValues: (number | RedisKey)[], callback: Callback<"OK">]
Returns Promise<"OK">
Parameters
Rest ...args: (number | RedisKey)[]
Returns Promise<"OK">
msetnx
- msetnx(object: object, callback?: Callback<"OK">): Promise<"OK">
- msetnx(map: Map<string | number | Buffer, string | number | Buffer>, callback?: Callback<"OK">): Promise<"OK">
- msetnx(...args: [...keyValues: (number | RedisKey)[], callback: Callback<number>]): Promise<number>
- msetnx(...args: (number | RedisKey)[]): Promise<number>
- \n
Set multiple keys to multiple values, only if none of the keys exist
\n- \n
- group: string \n
- complexity: O(N) where N is the number of keys to set. \n
- since: 1.0.1 \n
Parameters
object: object
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
map: Map<string | number | Buffer, string | number | Buffer>
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
Rest ...args: [...keyValues: (number | RedisKey)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: (number | RedisKey)[]
Returns Promise<number>
multi
- multi(options: { pipeline: false }): Promise<"OK">
- multi(): ChainableCommander
- multi(options: { pipeline: true }): ChainableCommander
- multi(commands?: unknown[][]): ChainableCommander
Parameters
options: { pipeline: false }
pipeline: false
Returns Promise<"OK">
Returns ChainableCommander
Parameters
options: { pipeline: true }
pipeline: true
Returns ChainableCommander
Parameters
Optional commands: unknown[][]
Returns ChainableCommander
nodes
object
- object(subcommand: "ENCODING", key: RedisKey, callback?: Callback<unknown>): Promise<unknown>
- object(subcommand: "FREQ", key: RedisKey, callback?: Callback<unknown>): Promise<unknown>
- object(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- object(subcommand: "IDLETIME", key: RedisKey, callback?: Callback<unknown>): Promise<unknown>
- object(subcommand: "REFCOUNT", key: RedisKey, callback?: Callback<unknown>): Promise<unknown>
- \n
Inspect the internal encoding of a Redis object
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.2.3 \n
Parameters
subcommand: "ENCODING"
key: RedisKey
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Get the logarithmic access frequency counter of a Redis object
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 4.0.0 \n
Parameters
subcommand: "FREQ"
key: RedisKey
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Show helpful text about the different subcommands
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Get the time since a Redis object was last accessed
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.2.3 \n
Parameters
subcommand: "IDLETIME"
key: RedisKey
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Get the number of references to the value of the key
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.2.3 \n
Parameters
subcommand: "REFCOUNT"
key: RedisKey
Optional callback: Callback<unknown>
Returns Promise<unknown>
persist
- persist(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Remove the expiration from a key
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
pexpire
- pexpire(key: RedisKey, milliseconds: string | number, callback?: Callback<number>): Promise<number>
- pexpire(key: RedisKey, milliseconds: string | number, nx: "NX", callback?: Callback<number>): Promise<number>
- pexpire(key: RedisKey, milliseconds: string | number, xx: "XX", callback?: Callback<number>): Promise<number>
- pexpire(key: RedisKey, milliseconds: string | number, gt: "GT", callback?: Callback<number>): Promise<number>
- pexpire(key: RedisKey, milliseconds: string | number, lt: "LT", callback?: Callback<number>): Promise<number>
- \n
Set a key's time to live in milliseconds
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
milliseconds: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
milliseconds: string | number
nx: "NX"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
milliseconds: string | number
xx: "XX"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
milliseconds: string | number
gt: "GT"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
milliseconds: string | number
lt: "LT"
Optional callback: Callback<number>
Returns Promise<number>
pexpireat
- pexpireat(key: RedisKey, unixTimeMilliseconds: string | number, callback?: Callback<number>): Promise<number>
- pexpireat(key: RedisKey, unixTimeMilliseconds: string | number, nx: "NX", callback?: Callback<number>): Promise<number>
- pexpireat(key: RedisKey, unixTimeMilliseconds: string | number, xx: "XX", callback?: Callback<number>): Promise<number>
- pexpireat(key: RedisKey, unixTimeMilliseconds: string | number, gt: "GT", callback?: Callback<number>): Promise<number>
- pexpireat(key: RedisKey, unixTimeMilliseconds: string | number, lt: "LT", callback?: Callback<number>): Promise<number>
- \n
Set the expiration for a key as a UNIX timestamp specified in milliseconds
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
unixTimeMilliseconds: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
unixTimeMilliseconds: string | number
nx: "NX"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
unixTimeMilliseconds: string | number
xx: "XX"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
unixTimeMilliseconds: string | number
gt: "GT"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
unixTimeMilliseconds: string | number
lt: "LT"
Optional callback: Callback<number>
Returns Promise<number>
pexpiretime
- pexpiretime(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Get the expiration Unix timestamp for a key in milliseconds
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
pfadd
- pfadd(key: RedisKey, callback?: Callback<number>): Promise<number>
- pfadd(...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- pfadd(...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]): Promise<number>
- \n
Adds the specified elements to the specified HyperLogLog.
\n- \n
- group: hyperloglog \n
- complexity: O(1) to add every element. \n
- since: 2.8.9 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns Promise<number>
pfcount
- pfcount(...args: [...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- pfcount(...args: [keys: RedisKey[], callback: Callback<number>]): Promise<number>
- pfcount(...args: RedisKey[]): Promise<number>
- pfcount(...args: [keys: RedisKey[]]): Promise<number>
- \n
Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s).
\n- \n
- group: hyperloglog \n
- complexity: O(1) with a very small average constant time when called with a single key. O(N) with N being the number of keys, and much bigger constant times, when called with multiple keys. \n
- since: 2.8.9 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: RedisKey[]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<number>
pfdebug
- pfdebug(subcommand: string | Buffer, key: RedisKey, callback?: Callback<unknown>): Promise<unknown>
- \n
Internal commands for debugging HyperLogLog values
\n- \n
- group: hyperloglog \n
- complexity: N/A \n
- since: 2.8.9 \n
Parameters
subcommand: string | Buffer
key: RedisKey
Optional callback: Callback<unknown>
Returns Promise<unknown>
pfmerge
- pfmerge(...args: [destkey: RedisKey, ...sourcekeys: RedisKey[], callback: Callback<"OK">]): Promise<"OK">
- pfmerge(...args: [destkey: RedisKey, sourcekeys: RedisKey[], callback: Callback<"OK">]): Promise<"OK">
- pfmerge(...args: [destkey: RedisKey, ...sourcekeys: RedisKey[]]): Promise<"OK">
- pfmerge(...args: [destkey: RedisKey, sourcekeys: RedisKey[]]): Promise<"OK">
- \n
Merge N different HyperLogLogs into a single one.
\n- \n
- group: hyperloglog \n
- complexity: O(N) to merge N HyperLogLogs, but with high constant times. \n
- since: 2.8.9 \n
Parameters
Returns Promise<"OK">
Parameters
Returns Promise<"OK">
Parameters
Returns Promise<"OK">
Parameters
Returns Promise<"OK">
pfselftest
- pfselftest(callback?: Callback<unknown>): Promise<unknown>
- \n
An internal command for testing HyperLogLog values
\n- \n
- group: hyperloglog \n
- complexity: N/A \n
- since: 2.8.9 \n
Parameters
Optional callback: Callback<unknown>
Returns Promise<unknown>
ping
- ping(callback?: Callback<"PONG">): Promise<"PONG">
- ping(message: string | Buffer, callback?: Callback<string>): Promise<string>
- \n
Ping the server
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"PONG">
Returns Promise<"PONG">
Parameters
message: string | Buffer
Optional callback: Callback<string>
Returns Promise<string>
ping
- ping
Buffer(message: string | Buffer, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
message: string | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
pipeline
- pipeline(commands?: unknown[][]): ChainableCommander
Parameters
Optional commands: unknown[][]
Returns ChainableCommander
psetex
- psetex(key: RedisKey, milliseconds: string | number, value: string | number | Buffer, callback?: Callback<unknown>): Promise<unknown>
- \n
Set the value and expiration in milliseconds of a key
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
milliseconds: string | number
value: string | number | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
psubscribe
- psubscribe(...args: [...patterns: string[], callback: Callback<unknown>]): Promise<unknown>
- psubscribe(...args: string[]): Promise<unknown>
- \n
Listen for messages published to channels matching the given patterns
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of patterns the client is already subscribed to. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [...patterns: string[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: string[]
Returns Promise<unknown>
psync
- psync(replicationid: string | number | Buffer, offset: string | number, callback?: Callback<unknown>): Promise<unknown>
- \n
Internal command used for replication
\n- \n
- group: server \n
- complexity: undefined \n
- since: 2.8.0 \n
Parameters
replicationid: string | number | Buffer
offset: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
pttl
- pttl(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Get the time to live for a key in milliseconds
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
publish
- publish(channel: string | Buffer, message: string | Buffer, callback?: Callback<number>): Promise<number>
- \n
Post a message to a channel
\n- \n
- group: pubsub \n
- complexity: O(N+M) where N is the number of clients subscribed to the receiving channel and M is the total number of subscribed patterns (by any client). \n
- since: 2.0.0 \n
Parameters
channel: string | Buffer
message: string | Buffer
Optional callback: Callback<number>
Returns Promise<number>
pubsub
- pubsub(subcommand: "CHANNELS", callback?: Callback<unknown[]>): Promise<unknown[]>
- pubsub(subcommand: "CHANNELS", pattern: string, callback?: Callback<unknown[]>): Promise<unknown[]>
- pubsub(subcommand: "HELP", callback?: Callback<unknown[]>): Promise<unknown[]>
- pubsub(subcommand: "NUMPAT", callback?: Callback<unknown[]>): Promise<unknown[]>
- pubsub(subcommand: "NUMSUB", callback?: Callback<unknown[]>): Promise<unknown[]>
- pubsub(...args: [subcommand: "NUMSUB", ...channels: (string | Buffer)[], callback: Callback<unknown[]>]): Promise<unknown[]>
- pubsub(...args: [subcommand: "NUMSUB", ...channels: (string | Buffer)[]]): Promise<unknown[]>
- pubsub(subcommand: "SHARDCHANNELS", callback?: Callback<unknown[]>): Promise<unknown[]>
- pubsub(subcommand: "SHARDCHANNELS", pattern: string, callback?: Callback<unknown[]>): Promise<unknown[]>
- pubsub(subcommand: "SHARDNUMSUB", callback?: Callback<unknown[]>): Promise<unknown[]>
- pubsub(...args: [subcommand: "SHARDNUMSUB", ...shardchannels: (string | Buffer)[], callback: Callback<unknown[]>]): Promise<unknown[]>
- pubsub(...args: [subcommand: "SHARDNUMSUB", ...shardchannels: (string | Buffer)[]]): Promise<unknown[]>
- \n
List active channels
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of active channels, and assuming constant time pattern matching (relatively short channels and patterns) \n
- since: 2.8.0 \n
Parameters
subcommand: "CHANNELS"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
subcommand: "CHANNELS"
pattern: string
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Show helpful text about the different subcommands
\n- \n
- group: pubsub \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Get the count of unique patterns pattern subscriptions
\n- \n
- group: pubsub \n
- complexity: O(1) \n
- since: 2.8.0 \n
Parameters
subcommand: "NUMPAT"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Get the count of subscribers for channels
\n- \n
- group: pubsub \n
- complexity: O(N) for the NUMSUB subcommand, where N is the number of requested channels \n
- since: 2.8.0 \n
Parameters
subcommand: "NUMSUB"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
Rest ...args: [subcommand: "NUMSUB", ...channels: (string | Buffer)[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [subcommand: "NUMSUB", ...channels: (string | Buffer)[]]
Returns Promise<unknown[]>
- \n
List active shard channels
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of active shard channels, and assuming constant time pattern matching (relatively short shard channels). \n
- since: 7.0.0 \n
Parameters
subcommand: "SHARDCHANNELS"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
subcommand: "SHARDCHANNELS"
pattern: string
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Get the count of subscribers for shard channels
\n- \n
- group: pubsub \n
- complexity: O(N) for the SHARDNUMSUB subcommand, where N is the number of requested shard channels \n
- since: 7.0.0 \n
Parameters
subcommand: "SHARDNUMSUB"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
Rest ...args: [subcommand: "SHARDNUMSUB", ...shardchannels: (string | Buffer)[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [subcommand: "SHARDNUMSUB", ...shardchannels: (string | Buffer)[]]
Returns Promise<unknown[]>
punsubscribe
- punsubscribe(callback?: Callback<unknown>): Promise<unknown>
- punsubscribe(...args: [...patterns: string[], callback: Callback<unknown>]): Promise<unknown>
- punsubscribe(...args: string[]): Promise<unknown>
- \n
Stop listening for messages posted to channels matching the given patterns
\n- \n
- group: pubsub \n
- complexity: O(N+M) where N is the number of patterns the client is already subscribed and M is the number of total patterns subscribed in the system (by any client). \n
- since: 2.0.0 \n
Parameters
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [...patterns: string[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: string[]
Returns Promise<unknown>
quit
- quit(callback?: Callback<"OK">): Promise<"OK">
- \n
Quit the cluster gracefully.
\nParameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
randomkey
- randomkey(callback?: Callback<string>): Promise<string>
- \n
Return a random key from the keyspace
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<string>
Returns Promise<string>
randomkey
- randomkey
Buffer(callback?: Callback<Buffer>): Promise<Buffer>
Parameters
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
readonly
- readonly(callback?: Callback<"OK">): Promise<"OK">
- \n
Enables read queries for a connection to a cluster replica node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
readwrite
- readwrite(callback?: Callback<"OK">): Promise<"OK">
- \n
Disables read queries for a connection to a cluster replica node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
rename
renamenx
replconf
- replconf(callback?: Callback<unknown>): Promise<unknown>
- \n
An internal command for configuring the replication stream
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
Optional callback: Callback<unknown>
Returns Promise<unknown>
replicaof
- replicaof(host: string | Buffer, port: string | number, callback?: Callback<"OK">): Promise<"OK">
- \n
Make the server a replica of another instance, or promote it as master.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
host: string | Buffer
port: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
reset
- reset(callback?: Callback<"OK">): Promise<"OK">
- \n
Reset the connection
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
restore
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): Promise<"OK">
- \n
Create a key using the provided serialized value, previously obtained using DUMP.
\n- \n
- group: generic \n
- complexity: O(1) to create the new key and additional O(NM) to reconstruct the serialized value, where N is the number of Redis objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1M) where M is small, so simply O(1). However for sorted set values the complexity is O(NMlog(N)) because inserting values into sorted sets is O(log(N)). \n
- since: 2.6.0 \n
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
restore-
- restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): Promise<unknown>
- \n
An internal command for migrating keys in a cluster
\n- \n
- group: server \n
- complexity: O(1) to create the new key and additional O(NM) to reconstruct the serialized value, where N is the number of Redis objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1M) where M is small, so simply O(1). However for sorted set values the complexity is O(NMlog(N)) because inserting values into sorted sets is O(log(N)). \n
- since: 3.0.0 \n
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
role
- role(callback?: Callback<unknown[]>): Promise<unknown[]>
- \n
Return the role of the instance in the context of replication
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.12 \n
Parameters
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
rpop
- rpop(key: RedisKey, callback?: Callback<string>): Promise<string>
- rpop(key: RedisKey, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Remove and get the last elements in a list
\n- \n
- group: list \n
- complexity: O(N) where N is the number of elements returned \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
rpop
rpoplpush
rpoplpush
rpush
- rpush(...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- rpush(...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]): Promise<number>
- \n
Append one or multiple elements to a list
\n- \n
- group: list \n
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns Promise<number>
rpushx
- rpushx(...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- rpushx(...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]): Promise<number>
- \n
Append an element to a list, only if the list exists
\n- \n
- group: list \n
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments. \n
- since: 2.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns Promise<number>
sadd
- sadd(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- sadd(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- sadd(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): Promise<number>
- sadd(...args: [key: RedisKey, members: (string | number | Buffer)[]]): Promise<number>
- \n
Add one or more members to a set
\n- \n
- group: set \n
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<number>
save
- save(callback?: Callback<"OK">): Promise<"OK">
- \n
Synchronously save the dataset to disk
\n- \n
- group: server \n
- complexity: O(N) where N is the total number of keys in all databases \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
scan
- scan(cursor: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- scan(cursor: string | number, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- scan(cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- scan(cursor: string | number, countToken: "COUNT", count: string | number, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- scan(cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- scan(cursor: string | number, patternToken: "MATCH", pattern: string, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- scan(cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- scan(cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- \n
Incrementally iterate the keys space
\n- \n
- group: generic \n
- complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection. \n
- since: 2.8.0 \n
Parameters
cursor: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
cursor: string | number
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
cursor: string | number
countToken: "COUNT"
count: string | number
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
scan
- scan
Buffer(cursor: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - scan
Buffer(cursor: string | number, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - scan
Buffer(cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - scan
Buffer(cursor: string | number, countToken: "COUNT", count: string | number, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - scan
Buffer(cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - scan
Buffer(cursor: string | number, patternToken: "MATCH", pattern: string, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - scan
Buffer(cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - scan
Buffer(cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
cursor: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
cursor: string | number
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
cursor: string | number
countToken: "COUNT"
count: string | number
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
scard
- scard(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Get the number of members in a set
\n- \n
- group: set \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
script
- script(subcommand: "DEBUG", yes: "YES", callback?: Callback<unknown>): Promise<unknown>
- script(subcommand: "DEBUG", sync: "SYNC", callback?: Callback<unknown>): Promise<unknown>
- script(subcommand: "DEBUG", no: "NO", callback?: Callback<unknown>): Promise<unknown>
- script(...args: [subcommand: "EXISTS", ...sha1s: (string | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- script(...args: [subcommand: "EXISTS", ...sha1s: (string | Buffer)[]]): Promise<unknown>
- script(subcommand: "FLUSH", callback?: Callback<unknown>): Promise<unknown>
- script(subcommand: "FLUSH", async: "ASYNC", callback?: Callback<unknown>): Promise<unknown>
- script(subcommand: "FLUSH", sync: "SYNC", callback?: Callback<unknown>): Promise<unknown>
- script(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- script(subcommand: "KILL", callback?: Callback<unknown>): Promise<unknown>
- script(subcommand: "LOAD", script: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- \n
Set the debug mode for executed scripts.
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 3.2.0 \n
Parameters
subcommand: "DEBUG"
yes: "YES"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "DEBUG"
sync: "SYNC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "DEBUG"
no: "NO"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Check existence of scripts in the script cache.
\n- \n
- group: scripting \n
- complexity: O(N) with N being the number of scripts to check (so checking a single script is an O(1) operation). \n
- since: 2.6.0 \n
Parameters
Rest ...args: [subcommand: "EXISTS", ...sha1s: (string | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "EXISTS", ...sha1s: (string | Buffer)[]]
Returns Promise<unknown>
- \n
Remove all the scripts from the script cache.
\n- \n
- group: scripting \n
- complexity: O(N) with N being the number of scripts in cache \n
- since: 2.6.0 \n
Parameters
subcommand: "FLUSH"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "FLUSH"
async: "ASYNC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "FLUSH"
sync: "SYNC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Show helpful text about the different subcommands
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Kill the script currently in execution.
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
subcommand: "KILL"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Load the specified Lua script into the script cache.
\n- \n
- group: scripting \n
- complexity: O(N) with N being the length in bytes of the script body. \n
- since: 2.6.0 \n
Parameters
subcommand: "LOAD"
script: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
sdiff
- sdiff(...args: [...keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- sdiff(...args: [keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- sdiff(...args: RedisKey[]): Promise<string[]>
- sdiff(...args: [keys: RedisKey[]]): Promise<string[]>
- \n
Subtract multiple sets
\n- \n
- group: set \n
- complexity: O(N) where N is the total number of elements in all given sets. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: RedisKey[]
Returns Promise<string[]>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<string[]>
sdiff
- sdiff
Buffer(...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - sdiff
Buffer(...args: [keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - sdiff
Buffer(...args: RedisKey[]): Promise<Buffer[]> - sdiff
Buffer(...args: [keys: RedisKey[]]): Promise<Buffer[]>
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: RedisKey[]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<Buffer[]>
sdiffstore
- sdiffstore(...args: [destination: RedisKey, ...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- sdiffstore(...args: [destination: RedisKey, keys: RedisKey[], callback: Callback<number>]): Promise<number>
- sdiffstore(...args: [destination: RedisKey, ...keys: RedisKey[]]): Promise<number>
- sdiffstore(...args: [destination: RedisKey, keys: RedisKey[]]): Promise<number>
- \n
Subtract multiple sets and store the resulting set in a key
\n- \n
- group: set \n
- complexity: O(N) where N is the total number of elements in all given sets. \n
- since: 1.0.0 \n
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
select
- select(index: string | number, callback?: Callback<"OK">): Promise<"OK">
- \n
Change the selected database for the current connection
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
index: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
set
- set(key: RedisKey, value: string | number | Buffer, callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, nx: "NX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, nx: "NX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, xx: "XX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, xx: "XX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, nx: "NX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, nx: "NX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, xx: "XX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, xx: "XX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, nx: "NX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, nx: "NX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, xx: "XX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, xx: "XX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, nx: "NX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, nx: "NX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, xx: "XX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, xx: "XX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, nx: "NX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, nx: "NX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, xx: "XX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, xx: "XX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", nx: "NX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", nx: "NX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", xx: "XX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", xx: "XX", get: "GET", callback?: Callback<string>): Promise<string>
- \n
Set the string value of a key
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
value: string | number | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
nx: "NX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
nx: "NX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
xx: "XX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
xx: "XX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
nx: "NX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
xx: "XX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
nx: "NX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
xx: "XX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
nx: "NX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
xx: "XX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
nx: "NX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
xx: "XX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
nx: "NX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
nx: "NX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
xx: "XX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
xx: "XX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
set
- set
Buffer(key: RedisKey, value: string | number | Buffer, get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, nx: "NX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, xx: "XX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, nx: "NX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, xx: "XX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, nx: "NX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, xx: "XX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, nx: "NX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, xx: "XX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, nx: "NX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, xx: "XX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", nx: "NX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", xx: "XX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
nx: "NX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
xx: "XX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
nx: "NX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
xx: "XX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
setbit
- setbit(key: RedisKey, offset: string | number, value: string | number, callback?: Callback<number>): Promise<number>
- \n
Sets or clears the bit at offset in the string value stored at key
\n- \n
- group: bitmap \n
- complexity: O(1) \n
- since: 2.2.0 \n
Parameters
key: RedisKey
offset: string | number
value: string | number
Optional callback: Callback<number>
Returns Promise<number>
setex
- setex(key: RedisKey, seconds: string | number, value: string | number | Buffer, callback?: Callback<"OK">): Promise<"OK">
- \n
Set the value and expiration of a key
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
seconds: string | number
value: string | number | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
setnx
- setnx(key: RedisKey, value: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Set the value of a key, only if the key does not exist
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
value: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
setrange
- setrange(key: RedisKey, offset: string | number, value: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Overwrite part of a string at key starting at the specified offset
\n- \n
- group: string \n
- complexity: O(1), not counting the time taken to copy the new string in place. Usually, this string is very small so the amortized complexity is O(1). Otherwise, complexity is O(M) with M being the length of the value argument. \n
- since: 2.2.0 \n
Parameters
key: RedisKey
offset: string | number
value: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
shutdown
- shutdown(callback?: Callback<"OK">): Promise<"OK">
- shutdown(abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
- shutdown(force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(now: "NOW", callback?: Callback<"OK">): Promise<"OK">
- shutdown(now: "NOW", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(now: "NOW", force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
- shutdown(now: "NOW", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(nosave: "NOSAVE", callback?: Callback<"OK">): Promise<"OK">
- shutdown(nosave: "NOSAVE", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(nosave: "NOSAVE", force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
- shutdown(nosave: "NOSAVE", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(nosave: "NOSAVE", now: "NOW", callback?: Callback<"OK">): Promise<"OK">
- shutdown(nosave: "NOSAVE", now: "NOW", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(nosave: "NOSAVE", now: "NOW", force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
- shutdown(nosave: "NOSAVE", now: "NOW", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(save: "SAVE", callback?: Callback<"OK">): Promise<"OK">
- shutdown(save: "SAVE", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(save: "SAVE", force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
- shutdown(save: "SAVE", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(save: "SAVE", now: "NOW", callback?: Callback<"OK">): Promise<"OK">
- shutdown(save: "SAVE", now: "NOW", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(save: "SAVE", now: "NOW", force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
- shutdown(save: "SAVE", now: "NOW", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- \n
Synchronously save the dataset to disk and then shut down the server
\n- \n
- group: server \n
- complexity: O(N) when saving, where N is the total number of keys in all databases when saving data, otherwise O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
force: "FORCE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
now: "NOW"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
now: "NOW"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
now: "NOW"
force: "FORCE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
now: "NOW"
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
nosave: "NOSAVE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
nosave: "NOSAVE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
nosave: "NOSAVE"
force: "FORCE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
nosave: "NOSAVE"
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
nosave: "NOSAVE"
now: "NOW"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
nosave: "NOSAVE"
now: "NOW"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
nosave: "NOSAVE"
now: "NOW"
force: "FORCE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
nosave: "NOSAVE"
now: "NOW"
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
save: "SAVE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
save: "SAVE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
save: "SAVE"
force: "FORCE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
save: "SAVE"
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
save: "SAVE"
now: "NOW"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
save: "SAVE"
now: "NOW"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
save: "SAVE"
now: "NOW"
force: "FORCE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
save: "SAVE"
now: "NOW"
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
sinter
- sinter(...args: [...keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- sinter(...args: [keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- sinter(...args: RedisKey[]): Promise<string[]>
- sinter(...args: [keys: RedisKey[]]): Promise<string[]>
- \n
Intersect multiple sets
\n- \n
- group: set \n
- complexity: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: RedisKey[]
Returns Promise<string[]>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<string[]>
sinter
- sinter
Buffer(...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - sinter
Buffer(...args: [keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - sinter
Buffer(...args: RedisKey[]): Promise<Buffer[]> - sinter
Buffer(...args: [keys: RedisKey[]]): Promise<Buffer[]>
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: RedisKey[]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<Buffer[]>
sintercard
- sintercard(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- sintercard(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<number>]): Promise<number>
- sintercard(...args: [numkeys: string | number, ...keys: RedisKey[]]): Promise<number>
- sintercard(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<number>
- sintercard(...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]): Promise<number>
- sintercard(...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]): Promise<number>
- sintercard(...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number]): Promise<number>
- sintercard(...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number]): Promise<number>
- \n
Intersect multiple sets and return the cardinality of the result
\n- \n
- group: set \n
- complexity: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number]
Returns Promise<number>
sinterstore
- sinterstore(...args: [destination: RedisKey, ...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- sinterstore(...args: [destination: RedisKey, keys: RedisKey[], callback: Callback<number>]): Promise<number>
- sinterstore(...args: [destination: RedisKey, ...keys: RedisKey[]]): Promise<number>
- sinterstore(...args: [destination: RedisKey, keys: RedisKey[]]): Promise<number>
- \n
Intersect multiple sets and store the resulting set in a key
\n- \n
- group: set \n
- complexity: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets. \n
- since: 1.0.0 \n
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
sismember
- sismember(key: RedisKey, member: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Determine if a given value is a member of a set
\n- \n
- group: set \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
member: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
slaveof
- slaveof(host: string | Buffer, port: string | number, callback?: Callback<"OK">): Promise<"OK">
- \n
Make the server a replica of another instance, or promote it as master.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
host: string | Buffer
port: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
slowlog
- slowlog(subcommand: "GET", callback?: Callback<unknown>): Promise<unknown>
- slowlog(subcommand: "GET", count: string | number, callback?: Callback<unknown>): Promise<unknown>
- slowlog(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- slowlog(subcommand: "LEN", callback?: Callback<unknown>): Promise<unknown>
- slowlog(subcommand: "RESET", callback?: Callback<unknown>): Promise<unknown>
- \n
Get the slow log's entries
\n- \n
- group: server \n
- complexity: O(N) where N is the number of entries returned \n
- since: 2.2.12 \n
Parameters
subcommand: "GET"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "GET"
count: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Show helpful text about the different subcommands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Get the slow log's length
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.2.12 \n
Parameters
subcommand: "LEN"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Clear all entries from the slow log
\n- \n
- group: server \n
- complexity: O(N) where N is the number of entries in the slowlog \n
- since: 2.2.12 \n
Parameters
subcommand: "RESET"
Optional callback: Callback<unknown>
Returns Promise<unknown>
smembers
- smembers(key: RedisKey, callback?: Callback<string[]>): Promise<string[]>
- \n
Get all the members in a set
\n- \n
- group: set \n
- complexity: O(N) where N is the set cardinality. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string[]>
Returns Promise<string[]>
smembers
- smembers
Buffer(key: RedisKey, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
smismember
- smismember(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- smismember(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- smismember(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): Promise<number[]>
- smismember(...args: [key: RedisKey, members: (string | number | Buffer)[]]): Promise<number[]>
- \n
Returns the membership associated with the given elements for a set
\n- \n
- group: set \n
- complexity: O(N) where N is the number of elements being checked for membership \n
- since: 6.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<number[]>
smove
sort
- sort(...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown>
- sort(...args: [key: RedisKey, ...args: RedisValue[]]): Promise<unknown>
- \n
Sort the elements in a list, set or sorted set
\n- \n
- group: generic \n
- complexity: O(N+M*log(M)) where N is the number of elements in the list or set to sort, and M the number of returned elements. When the elements are not sorted, complexity is O(N). \n
- since: 1.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[]]
Returns Promise<unknown>
sort_
- sort_
ro(key: RedisKey, callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, asc: "ASC", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, asc: "ASC", alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, desc: "DESC", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, desc: "DESC", alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[]]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], alpha: "ALPHA"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA"]): Promise<unknown> - sort_
ro(key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, asc: "ASC", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, asc: "ASC", alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, desc: "DESC", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, desc: "DESC", alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[]]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], alpha: "ALPHA"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA"]): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, asc: "ASC", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, asc: "ASC", alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, desc: "DESC", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, desc: "DESC", alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[]]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA"]): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, asc: "ASC", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, asc: "ASC", alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, desc: "DESC", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, desc: "DESC", alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[]]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA"]): Promise<unknown>
- \n
Sort the elements in a list, set or sorted set. Read-only variant of SORT.
\n- \n
- group: generic \n
- complexity: O(N+M*log(M)) where N is the number of elements in the list or set to sort, and M the number of returned elements. When the elements are not sorted, complexity is O(N). \n
- since: 7.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
asc: "ASC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
asc: "ASC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
desc: "DESC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
desc: "DESC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[]]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
key: RedisKey
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
asc: "ASC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
asc: "ASC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
desc: "DESC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
desc: "DESC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[]]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
asc: "ASC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
asc: "ASC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
desc: "DESC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
desc: "DESC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[]]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
asc: "ASC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
asc: "ASC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
desc: "DESC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
desc: "DESC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[]]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA"]
Returns Promise<unknown>
spop
- spop(key: RedisKey, callback?: Callback<string>): Promise<string>
- spop(key: RedisKey, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Remove and return one or multiple random members from a set
\n- \n
- group: set \n
- complexity: Without the count argument O(1), otherwise O(N) where N is the value of the passed count. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
spop
spublish
- spublish(shardchannel: string | Buffer, message: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- \n
Post a message to a shard channel
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of clients subscribed to the receiving shard channel. \n
- since: 7.0.0 \n
Parameters
shardchannel: string | Buffer
message: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
srandmember
- srandmember(key: RedisKey, callback?: Callback<string>): Promise<string>
- srandmember(key: RedisKey, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Get one or multiple random members from a set
\n- \n
- group: set \n
- complexity: Without the count argument O(1), otherwise O(N) where N is the absolute value of the passed count. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
srandmember
srem
- srem(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- srem(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- srem(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): Promise<number>
- srem(...args: [key: RedisKey, members: (string | number | Buffer)[]]): Promise<number>
- \n
Remove one or more members from a set
\n- \n
- group: set \n
- complexity: O(N) where N is the number of members to be removed. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<number>
sscan
- sscan(key: RedisKey, cursor: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- sscan(key: RedisKey, cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- sscan(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- sscan(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- \n
Incrementally iterate Set elements
\n- \n
- group: set \n
- complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.. \n
- since: 2.8.0 \n
Parameters
key: RedisKey
cursor: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
key: RedisKey
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
sscan
- sscan
Buffer(key: RedisKey, cursor: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - sscan
Buffer(key: RedisKey, cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - sscan
Buffer(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - sscan
Buffer(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
sscan
- sscan
Buffer Stream(key: string, options?: ScanStreamOptions): default
Parameters
key: string
Optional options: ScanStreamOptions
Returns default
sscan
- sscan
Stream(key: string, options?: ScanStreamOptions): default
Parameters
key: string
Optional options: ScanStreamOptions
Returns default
ssubscribe
- ssubscribe(...args: [...shardchannels: (string | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- ssubscribe(...args: (string | Buffer)[]): Promise<unknown>
- \n
Listen for messages published to the given shard channels
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of shard channels to subscribe to. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [...shardchannels: (string | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: (string | Buffer)[]
Returns Promise<unknown>
strlen
- strlen(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Get the length of the value stored in a key
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 2.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
subscribe
- subscribe(...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- subscribe(...args: (string | Buffer)[]): Promise<unknown>
- \n
Listen for messages published to the given channels
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of channels to subscribe to. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: (string | Buffer)[]
Returns Promise<unknown>
substr
- substr(key: RedisKey, start: string | number, end: string | number, callback?: Callback<unknown>): Promise<unknown>
- \n
Get a substring of the string stored at a key
\n- \n
- group: string \n
- complexity: O(N) where N is the length of the returned string. The complexity is ultimately determined by the returned length, but because creating a substring from an existing string is very cheap, it can be considered O(1) for small strings. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
start: string | number
end: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
sunion
- sunion(...args: [...keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- sunion(...args: [keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- sunion(...args: RedisKey[]): Promise<string[]>
- sunion(...args: [keys: RedisKey[]]): Promise<string[]>
- \n
Add multiple sets
\n- \n
- group: set \n
- complexity: O(N) where N is the total number of elements in all given sets. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: RedisKey[]
Returns Promise<string[]>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<string[]>
sunion
- sunion
Buffer(...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - sunion
Buffer(...args: [keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - sunion
Buffer(...args: RedisKey[]): Promise<Buffer[]> - sunion
Buffer(...args: [keys: RedisKey[]]): Promise<Buffer[]>
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: RedisKey[]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<Buffer[]>
sunionstore
- sunionstore(...args: [destination: RedisKey, ...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- sunionstore(...args: [destination: RedisKey, keys: RedisKey[], callback: Callback<number>]): Promise<number>
- sunionstore(...args: [destination: RedisKey, ...keys: RedisKey[]]): Promise<number>
- sunionstore(...args: [destination: RedisKey, keys: RedisKey[]]): Promise<number>
- \n
Add multiple sets and store the resulting set in a key
\n- \n
- group: set \n
- complexity: O(N) where N is the total number of elements in all given sets. \n
- since: 1.0.0 \n
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
sunsubscribe
- sunsubscribe(callback?: Callback<unknown>): Promise<unknown>
- sunsubscribe(...args: [...shardchannels: (string | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- sunsubscribe(...args: (string | Buffer)[]): Promise<unknown>
- \n
Stop listening for messages posted to the given shard channels
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of clients already subscribed to a shard channel. \n
- since: 7.0.0 \n
Parameters
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [...shardchannels: (string | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: (string | Buffer)[]
Returns Promise<unknown>
swapdb
- swapdb(index1: string | number, index2: string | number, callback?: Callback<"OK">): Promise<"OK">
- \n
Swaps two Redis databases
\n- \n
- group: server \n
- complexity: O(N) where N is the count of clients watching or blocking on keys from both databases. \n
- since: 4.0.0 \n
Parameters
index1: string | number
index2: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
sync
- sync(callback?: Callback<unknown>): Promise<unknown>
- \n
Internal command used for replication
\n- \n
- group: server \n
- complexity: undefined \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<unknown>
Returns Promise<unknown>
time
- time(callback?: Callback<number[]>): Promise<number[]>
- \n
Return the current server time
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
Optional callback: Callback<number[]>
Returns Promise<number[]>
touch
- touch(...args: [...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- touch(...args: [keys: RedisKey[], callback: Callback<number>]): Promise<number>
- touch(...args: RedisKey[]): Promise<number>
- touch(...args: [keys: RedisKey[]]): Promise<number>
- \n
Alters the last access time of a key(s). Returns the number of existing keys specified.
\n- \n
- group: generic \n
- complexity: O(N) where N is the number of keys that will be touched. \n
- since: 3.2.1 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: RedisKey[]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<number>
ttl
- ttl(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Get the time to live for a key in seconds
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
type
- type(key: RedisKey, callback?: Callback<string>): Promise<string>
- \n
Determine the type stored at key
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
unlink
- unlink(...args: [...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- unlink(...args: [keys: RedisKey[], callback: Callback<number>]): Promise<number>
- unlink(...args: RedisKey[]): Promise<number>
- unlink(...args: [keys: RedisKey[]]): Promise<number>
- \n
Delete a key asynchronously in another thread. Otherwise it is just as DEL, but non blocking.
\n- \n
- group: generic \n
- complexity: O(1) for each key removed regardless of its size. Then the command does O(N) work in a different thread in order to reclaim memory, where N is the number of allocations the deleted objects where composed of. \n
- since: 4.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: RedisKey[]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<number>
unsubscribe
- unsubscribe(callback?: Callback<unknown>): Promise<unknown>
- unsubscribe(...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- unsubscribe(...args: (string | Buffer)[]): Promise<unknown>
- \n
Stop listening for messages posted to the given channels
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of clients already subscribed to a channel. \n
- since: 2.0.0 \n
Parameters
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: (string | Buffer)[]
Returns Promise<unknown>
unwatch
- unwatch(callback?: Callback<"OK">): Promise<"OK">
- \n
Forget about all watched keys
\n- \n
- group: transactions \n
- complexity: O(1) \n
- since: 2.2.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
wait
- wait(numreplicas: string | number, timeout: string | number, callback?: Callback<number>): Promise<number>
- \n
Wait for the synchronous replication of all the write commands sent in the context of the current connection
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
numreplicas: string | number
timeout: string | number
Optional callback: Callback<number>
Returns Promise<number>
watch
- watch(...args: [...keys: RedisKey[], callback: Callback<"OK">]): Promise<"OK">
- watch(...args: [keys: RedisKey[], callback: Callback<"OK">]): Promise<"OK">
- watch(...args: RedisKey[]): Promise<"OK">
- watch(...args: [keys: RedisKey[]]): Promise<"OK">
- \n
Watch the given keys to determine execution of the MULTI/EXEC block
\n- \n
- group: transactions \n
- complexity: O(1) for every key. \n
- since: 2.2.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<"OK">]
Returns Promise<"OK">
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<"OK">]
Returns Promise<"OK">
Parameters
Rest ...args: RedisKey[]
Returns Promise<"OK">
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<"OK">
xack
- xack(...args: [key: RedisKey, group: string | Buffer, ...ids: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- xack(...args: [key: RedisKey, group: string | Buffer, ...ids: (string | number | Buffer)[]]): Promise<number>
- \n
Marks a pending message as correctly processed, effectively removing it from the pending entries list of the consumer group. Return value of the command is the number of messages successfully acknowledged, that is, the IDs we were actually able to resolve in the PEL.
\n- \n
- group: stream \n
- complexity: O(1) for each message ID processed. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, ...ids: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, ...ids: (string | number | Buffer)[]]
Returns Promise<number>
xadd
- xadd(...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<string>]): Promise<string>
- xadd(...args: [key: RedisKey, ...args: RedisValue[]]): Promise<string>
- \n
Appends a new entry to a stream
\n- \n
- group: stream \n
- complexity: O(1) when adding a new entry, O(N) when trimming where N being the number of entries evicted. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[]]
Returns Promise<string>
xadd
- xadd
Buffer(...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<Buffer>]): Promise<Buffer> - xadd
Buffer(...args: [key: RedisKey, ...args: RedisValue[]]): Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[]]
Returns Promise<Buffer>
xautoclaim
- xautoclaim(key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, start: string | number | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- xautoclaim(key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, start: string | number | Buffer, justid: "JUSTID", callback?: Callback<unknown[]>): Promise<unknown[]>
- xautoclaim(key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, start: string | number | Buffer, countToken: "COUNT", count: string | number, callback?: Callback<unknown[]>): Promise<unknown[]>
- xautoclaim(key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, start: string | number | Buffer, countToken: "COUNT", count: string | number, justid: "JUSTID", callback?: Callback<unknown[]>): Promise<unknown[]>
- \n
Changes (or acquires) ownership of messages in a consumer group, as if the messages were delivered to the specified consumer.
\n- \n
- group: stream \n
- complexity: O(1) if COUNT is small. \n
- since: 6.2.0 \n
Parameters
key: RedisKey
group: string | Buffer
consumer: string | Buffer
minIdleTime: string | number | Buffer
start: string | number | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
key: RedisKey
group: string | Buffer
consumer: string | Buffer
minIdleTime: string | number | Buffer
start: string | number | Buffer
justid: "JUSTID"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
key: RedisKey
group: string | Buffer
consumer: string | Buffer
minIdleTime: string | number | Buffer
start: string | number | Buffer
countToken: "COUNT"
count: string | number
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
key: RedisKey
group: string | Buffer
consumer: string | Buffer
minIdleTime: string | number | Buffer
start: string | number | Buffer
countToken: "COUNT"
count: string | number
justid: "JUSTID"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
xclaim
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[]]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE", justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE", justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- \n
Changes (or acquires) ownership of a message in a consumer group, as if the message was delivered to the specified consumer.
\n- \n
- group: stream \n
- complexity: O(log N) with N being the number of messages in the PEL of the consumer group. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[]]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE", justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE", justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
xdel
- xdel(...args: [key: RedisKey, ...ids: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- xdel(...args: [key: RedisKey, ...ids: (string | number | Buffer)[]]): Promise<number>
- \n
Removes the specified entries from the stream. Returns the number of items actually deleted, that may be different from the number of IDs passed in case certain IDs do not exist.
\n- \n
- group: stream \n
- complexity: O(1) for each single item to delete in the stream, regardless of the stream size. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...ids: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...ids: (string | number | Buffer)[]]
Returns Promise<number>
xdelex
- xdelex(...args: [key: RedisKey, idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- xdelex(...args: [key: RedisKey, idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]): Promise<unknown>
- xdelex(...args: [key: RedisKey, keepref: "KEEPREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- xdelex(...args: [key: RedisKey, keepref: "KEEPREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]): Promise<unknown>
- xdelex(...args: [key: RedisKey, delref: "DELREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- xdelex(...args: [key: RedisKey, delref: "DELREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]): Promise<unknown>
- xdelex(...args: [key: RedisKey, acked: "ACKED", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- xdelex(...args: [key: RedisKey, acked: "ACKED", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]): Promise<unknown>
- \n
Deletes one or multiple entries from the stream.
\n- \n
- group: stream \n
- complexity: O(1) for each single item to delete in the stream, regardless of the stream size. \n
- since: 8.2.0 \n
Parameters
Rest ...args: [key: RedisKey, idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, keepref: "KEEPREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, keepref: "KEEPREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, delref: "DELREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, delref: "DELREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, acked: "ACKED", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, acked: "ACKED", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]
Returns Promise<unknown>
xgroup
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, id: string | number | Buffer, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, id: string | number | Buffer, entriesReadToken: "ENTRIESREAD", entriesRead: string | number, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, id: string | number | Buffer, mkstream: "MKSTREAM", callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, id: string | number | Buffer, mkstream: "MKSTREAM", entriesReadToken: "ENTRIESREAD", entriesRead: string | number, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, newId: "$", callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, newId: "$", entriesReadToken: "ENTRIESREAD", entriesRead: string | number, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, newId: "$", mkstream: "MKSTREAM", callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, newId: "$", mkstream: "MKSTREAM", entriesReadToken: "ENTRIESREAD", entriesRead: string | number, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "CREATECONSUMER", key: RedisKey, groupname: string | Buffer, consumername: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "DELCONSUMER", key: RedisKey, groupname: string | Buffer, consumername: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "DESTROY", key: RedisKey, groupname: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "SETID", key: RedisKey, groupname: string | Buffer, id: string | number | Buffer, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "SETID", key: RedisKey, groupname: string | Buffer, id: string | number | Buffer, entriesReadToken: "ENTRIESREAD", entriesRead: string | number, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "SETID", key: RedisKey, groupname: string | Buffer, newId: "$", callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "SETID", key: RedisKey, groupname: string | Buffer, newId: "$", entriesReadToken: "ENTRIESREAD", entriesRead: string | number, callback?: Callback<unknown>): Promise<unknown>
- \n
Create a consumer group.
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
id: string | number | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
id: string | number | Buffer
entriesReadToken: "ENTRIESREAD"
entriesRead: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
id: string | number | Buffer
mkstream: "MKSTREAM"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
id: string | number | Buffer
mkstream: "MKSTREAM"
entriesReadToken: "ENTRIESREAD"
entriesRead: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
newId: "$"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
newId: "$"
entriesReadToken: "ENTRIESREAD"
entriesRead: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
newId: "$"
mkstream: "MKSTREAM"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
newId: "$"
mkstream: "MKSTREAM"
entriesReadToken: "ENTRIESREAD"
entriesRead: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Create a consumer in a consumer group.
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
subcommand: "CREATECONSUMER"
key: RedisKey
groupname: string | Buffer
consumername: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Delete a consumer from a consumer group.
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "DELCONSUMER"
key: RedisKey
groupname: string | Buffer
consumername: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Destroy a consumer group.
\n- \n
- group: stream \n
- complexity: O(N) where N is the number of entries in the group's pending entries list (PEL). \n
- since: 5.0.0 \n
Parameters
subcommand: "DESTROY"
key: RedisKey
groupname: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Show helpful text about the different subcommands
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Set a consumer group to an arbitrary last delivered ID value.
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "SETID"
key: RedisKey
groupname: string | Buffer
id: string | number | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "SETID"
key: RedisKey
groupname: string | Buffer
id: string | number | Buffer
entriesReadToken: "ENTRIESREAD"
entriesRead: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "SETID"
key: RedisKey
groupname: string | Buffer
newId: "$"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "SETID"
key: RedisKey
groupname: string | Buffer
newId: "$"
entriesReadToken: "ENTRIESREAD"
entriesRead: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
xinfo
- xinfo(subcommand: "CONSUMERS", key: RedisKey, groupname: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- xinfo(subcommand: "GROUPS", key: RedisKey, callback?: Callback<unknown>): Promise<unknown>
- xinfo(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- xinfo(subcommand: "STREAM", key: RedisKey, callback?: Callback<unknown>): Promise<unknown>
- xinfo(subcommand: "STREAM", key: RedisKey, fullToken: "FULL", callback?: Callback<unknown>): Promise<unknown>
- xinfo(subcommand: "STREAM", key: RedisKey, fullToken: "FULL", countToken: "COUNT", count: string | number, callback?: Callback<unknown>): Promise<unknown>
- \n
List the consumers in a consumer group
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "CONSUMERS"
key: RedisKey
groupname: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
List the consumer groups of a stream
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "GROUPS"
key: RedisKey
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Show helpful text about the different subcommands
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Get information about a stream
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "STREAM"
key: RedisKey
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "STREAM"
key: RedisKey
fullToken: "FULL"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "STREAM"
key: RedisKey
fullToken: "FULL"
countToken: "COUNT"
count: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
xlen
- xlen(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Return the number of entries in a stream
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
xpending
- xpending(key: RedisKey, group: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- xpending(key: RedisKey, group: string | Buffer, start: string | number | Buffer, end: string | number | Buffer, count: string | number, callback?: Callback<unknown[]>): Promise<unknown[]>
- xpending(key: RedisKey, group: string | Buffer, start: string | number | Buffer, end: string | number | Buffer, count: string | number, consumer: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- xpending(key: RedisKey, group: string | Buffer, minIdleTimeToken: "IDLE", minIdleTime: string | number, start: string | number | Buffer, end: string | number | Buffer, count: string | number, callback?: Callback<unknown[]>): Promise<unknown[]>
- xpending(key: RedisKey, group: string | Buffer, minIdleTimeToken: "IDLE", minIdleTime: string | number, start: string | number | Buffer, end: string | number | Buffer, count: string | number, consumer: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- \n
Return information and entries from a stream consumer group pending entries list, that are messages fetched but never acknowledged.
\n- \n
- group: stream \n
- complexity: O(N) with N being the number of elements returned, so asking for a small fixed number of entries per call is O(1). O(M), where M is the total number of entries scanned when used with the IDLE filter. When the command returns just the summary and the list of consumers is small, it runs in O(1) time; otherwise, an additional O(N) time for iterating every consumer. \n
- since: 5.0.0 \n
Parameters
key: RedisKey
group: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
key: RedisKey
group: string | Buffer
start: string | number | Buffer
end: string | number | Buffer
count: string | number
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
key: RedisKey
group: string | Buffer
start: string | number | Buffer
end: string | number | Buffer
count: string | number
consumer: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
key: RedisKey
group: string | Buffer
minIdleTimeToken: "IDLE"
minIdleTime: string | number
start: string | number | Buffer
end: string | number | Buffer
count: string | number
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
key: RedisKey
group: string | Buffer
minIdleTimeToken: "IDLE"
minIdleTime: string | number
start: string | number | Buffer
end: string | number | Buffer
count: string | number
consumer: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
xrange
- xrange(key: RedisKey, start: string | number | Buffer, end: string | number | Buffer, callback?: Callback<[id: string, fields: string[]][]>): Promise<[id: string, fields: string[]][]>
- xrange(key: RedisKey, start: string | number | Buffer, end: string | number | Buffer, countToken: "COUNT", count: string | number, callback?: Callback<[id: string, fields: string[]][]>): Promise<[id: string, fields: string[]][]>
- \n
Return a range of elements in a stream, with IDs matching the specified IDs interval
\n- \n
- group: stream \n
- complexity: O(N) with N being the number of elements being returned. If N is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1). \n
- since: 5.0.0 \n
Parameters
key: RedisKey
start: string | number | Buffer
end: string | number | Buffer
Optional callback: Callback<[id: string, fields: string[]][]>
Returns Promise<[id: string, fields: string[]][]>
Parameters
key: RedisKey
start: string | number | Buffer
end: string | number | Buffer
countToken: "COUNT"
count: string | number
Optional callback: Callback<[id: string, fields: string[]][]>
Returns Promise<[id: string, fields: string[]][]>
xrange
- xrange
Buffer(key: RedisKey, start: string | number | Buffer, end: string | number | Buffer, callback?: Callback<[id: Buffer, fields: Buffer[]][]>): Promise<[id: Buffer, fields: Buffer[]][]> - xrange
Buffer(key: RedisKey, start: string | number | Buffer, end: string | number | Buffer, countToken: "COUNT", count: string | number, callback?: Callback<[id: Buffer, fields: Buffer[]][]>): Promise<[id: Buffer, fields: Buffer[]][]>
Parameters
key: RedisKey
start: string | number | Buffer
end: string | number | Buffer
Optional callback: Callback<[id: Buffer, fields: Buffer[]][]>
Returns Promise<[id: Buffer, fields: Buffer[]][]>
Parameters
key: RedisKey
start: string | number | Buffer
end: string | number | Buffer
countToken: "COUNT"
count: string | number
Optional callback: Callback<[id: Buffer, fields: Buffer[]][]>
Returns Promise<[id: Buffer, fields: Buffer[]][]>
xread
- xread(...args: [streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]): Promise<[key: string, items: [id: string, fields: string[]][]][]>
- xread(...args: [streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<[key: string, items: [id: string, fields: string[]][]][]>
- xread(...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]): Promise<[key: string, items: [id: string, fields: string[]][]][]>
- xread(...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<[key: string, items: [id: string, fields: string[]][]][]>
- xread(...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]): Promise<[key: string, items: [id: string, fields: string[]][]][]>
- xread(...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<[key: string, items: [id: string, fields: string[]][]][]>
- xread(...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]): Promise<[key: string, items: [id: string, fields: string[]][]][]>
- xread(...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<[key: string, items: [id: string, fields: string[]][]][]>
- \n
Return never seen elements in multiple streams, with IDs greater than the ones reported by the caller for each stream. Can block.
\n- \n
- group: stream \n
- complexity: For each stream mentioned: O(N) with N being the number of elements being returned, it means that XREAD-ing with a fixed COUNT is O(1). Note that when the BLOCK option is used, XADD will pay O(M) time in order to serve the M clients blocked on the stream getting new data. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
Rest ...args: [streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
Rest ...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
Rest ...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
xread
- xread
Buffer(...args: [streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]> - xread
Buffer(...args: [streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]> - xread
Buffer(...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]> - xread
Buffer(...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]> - xread
Buffer(...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]> - xread
Buffer(...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]> - xread
Buffer(...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]> - xread
Buffer(...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
Rest ...args: [streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
Rest ...args: [streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
Rest ...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
Rest ...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
xreadgroup
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<unknown[]>
- \n
Return new entries from a stream using a consumer group, or access the history of the pending entries for a given consumer. Can block.
\n- \n
- group: stream \n
- complexity: For each stream mentioned: O(M) with M being the number of elements returned. If M is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1). On the other side when XREADGROUP blocks, XADD will pay the O(N) time in order to serve the N clients blocked on the stream getting new data. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<unknown[]>
xrevrange
- xrevrange(key: RedisKey, end: string | number | Buffer, start: string | number | Buffer, callback?: Callback<[id: string, fields: string[]][]>): Promise<[id: string, fields: string[]][]>
- xrevrange(key: RedisKey, end: string | number | Buffer, start: string | number | Buffer, countToken: "COUNT", count: string | number, callback?: Callback<[id: string, fields: string[]][]>): Promise<[id: string, fields: string[]][]>
- \n
Return a range of elements in a stream, with IDs matching the specified IDs interval, in reverse order (from greater to smaller IDs) compared to XRANGE
\n- \n
- group: stream \n
- complexity: O(N) with N being the number of elements returned. If N is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1). \n
- since: 5.0.0 \n
Parameters
key: RedisKey
end: string | number | Buffer
start: string | number | Buffer
Optional callback: Callback<[id: string, fields: string[]][]>
Returns Promise<[id: string, fields: string[]][]>
Parameters
key: RedisKey
end: string | number | Buffer
start: string | number | Buffer
countToken: "COUNT"
count: string | number
Optional callback: Callback<[id: string, fields: string[]][]>
Returns Promise<[id: string, fields: string[]][]>
xrevrange
- xrevrange
Buffer(key: RedisKey, end: string | number | Buffer, start: string | number | Buffer, callback?: Callback<[id: Buffer, fields: Buffer[]][]>): Promise<[id: Buffer, fields: Buffer[]][]> - xrevrange
Buffer(key: RedisKey, end: string | number | Buffer, start: string | number | Buffer, countToken: "COUNT", count: string | number, callback?: Callback<[id: Buffer, fields: Buffer[]][]>): Promise<[id: Buffer, fields: Buffer[]][]>
Parameters
key: RedisKey
end: string | number | Buffer
start: string | number | Buffer
Optional callback: Callback<[id: Buffer, fields: Buffer[]][]>
Returns Promise<[id: Buffer, fields: Buffer[]][]>
Parameters
key: RedisKey
end: string | number | Buffer
start: string | number | Buffer
countToken: "COUNT"
count: string | number
Optional callback: Callback<[id: Buffer, fields: Buffer[]][]>
Returns Promise<[id: Buffer, fields: Buffer[]][]>
xsetid
- xsetid(key: RedisKey, lastId: string | number | Buffer, callback?: Callback<unknown>): Promise<unknown>
- xsetid(key: RedisKey, lastId: string | number | Buffer, maxDeletedEntryIdToken: "MAXDELETEDID", maxDeletedEntryId: string | number | Buffer, callback?: Callback<unknown>): Promise<unknown>
- xsetid(key: RedisKey, lastId: string | number | Buffer, entriesAddedToken: "ENTRIESADDED", entriesAdded: string | number, callback?: Callback<unknown>): Promise<unknown>
- xsetid(key: RedisKey, lastId: string | number | Buffer, entriesAddedToken: "ENTRIESADDED", entriesAdded: string | number, maxDeletedEntryIdToken: "MAXDELETEDID", maxDeletedEntryId: string | number | Buffer, callback?: Callback<unknown>): Promise<unknown>
- \n
An internal command for replicating stream values
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
key: RedisKey
lastId: string | number | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
lastId: string | number | Buffer
maxDeletedEntryIdToken: "MAXDELETEDID"
maxDeletedEntryId: string | number | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
lastId: string | number | Buffer
entriesAddedToken: "ENTRIESADDED"
entriesAdded: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
lastId: string | number | Buffer
entriesAddedToken: "ENTRIESADDED"
entriesAdded: string | number
maxDeletedEntryIdToken: "MAXDELETEDID"
maxDeletedEntryId: string | number | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
xtrim
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, acked: "ACKED", callback?: Callback<number>): Promise<number>
- \n
Deletes messages from the beginning of a stream.
\n- \n
- group: stream \n
- complexity: O(N), with N being the number of evicted entries. Constant times are very small however, since entries are organized in macro nodes containing multiple entries that can be released with a single deallocation. \n
- since: 5.0.0 \n
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
zadd
- zadd(...args: [key: RedisKey, ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, gt: "GT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, gt: "GT", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, lt: "LT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, lt: "LT", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- \n
Add one or more members to a sorted set, or update its score if it already exists
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) for each item added, where N is the number of elements in the sorted set. \n
- since: 1.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
zadd
- zadd
Buffer(...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
zcard
- zcard(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Get the number of members in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(1) \n
- since: 1.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
zcount
- zcount(key: RedisKey, min: string | number, max: string | number, callback?: Callback<number>): Promise<number>
- \n
Count the members in a sorted set with scores within the given values
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) with N being the number of elements in the sorted set. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
min: string | number
max: string | number
Optional callback: Callback<number>
Returns Promise<number>
zdiff
- zdiff(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- zdiff(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- zdiff(...args: [numkeys: string | number, ...keys: RedisKey[]]): Promise<string[]>
- zdiff(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<string[]>
- zdiff(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zdiff(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zdiff(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]): Promise<string[]>
- zdiff(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]): Promise<string[]>
- \n
Subtract multiple sorted sets
\n- \n
- group: sorted-set \n
- complexity: O(L + (N-K)log(N)) worst case where L is the total number of elements in all the sets, N is the size of the first set, and K is the size of the result set. \n
- since: 6.2.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<string[]>
zdiff
- zdiff
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zdiff
Buffer(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zdiff
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[]]): Promise<Buffer[]> - zdiff
Buffer(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<Buffer[]> - zdiff
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zdiff
Buffer(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zdiff
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]): Promise<Buffer[]> - zdiff
Buffer(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]): Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
zdiffstore
- zdiffstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- zdiffstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], callback: Callback<number>]): Promise<number>
- zdiffstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[]]): Promise<number>
- zdiffstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[]]): Promise<number>
- \n
Subtract multiple sorted sets and store the resulting sorted set in a new key
\n- \n
- group: sorted-set \n
- complexity: O(L + (N-K)log(N)) worst case where L is the total number of elements in all the sets, N is the size of the first set, and K is the size of the result set. \n
- since: 6.2.0 \n
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
zincrby
- zincrby(key: RedisKey, increment: string | number, member: string | number | Buffer, callback?: Callback<string>): Promise<string>
- \n
Increment the score of a member in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) where N is the number of elements in the sorted set. \n
- since: 1.2.0 \n
Parameters
key: RedisKey
increment: string | number
member: string | number | Buffer
Optional callback: Callback<string>
Returns Promise<string>
zincrby
- zincrby
Buffer(key: RedisKey, increment: string | number, member: string | number | Buffer, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
increment: string | number
member: string | number | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
zinter
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[]]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[]]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<string[]>
- \n
Intersect multiple sorted sets
\n- \n
- group: sorted-set \n
- complexity: O(NK)+O(Mlog(M)) worst case with N being the smallest input sorted set, K being the number of input sorted sets and M being the number of elements in the resulting sorted set. \n
- since: 6.2.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[]]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<string[]>
zinter
- zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[]]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[]]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
zintercard
- zintercard(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- zintercard(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<number>]): Promise<number>
- zintercard(...args: [numkeys: string | number, ...keys: RedisKey[]]): Promise<number>
- zintercard(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<number>
- zintercard(...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]): Promise<number>
- zintercard(...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]): Promise<number>
- zintercard(...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number]): Promise<number>
- zintercard(...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number]): Promise<number>
- \n
Intersect multiple sorted sets and return the cardinality of the result
\n- \n
- group: sorted-set \n
- complexity: O(N*K) worst case with N being the smallest input sorted set, K being the number of input sorted sets. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number]
Returns Promise<number>
zinterstore
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[]]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[]]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[]]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]): Promise<number>
- \n
Intersect multiple sorted sets and store the resulting sorted set in a new key
\n- \n
- group: sorted-set \n
- complexity: O(NK)+O(Mlog(M)) worst case with N being the smallest input sorted set, K being the number of input sorted sets and M being the number of elements in the resulting sorted set. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<number>
zlexcount
- zlexcount(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Count the number of members in a sorted set between a given lexicographical range
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) with N being the number of elements in the sorted set. \n
- since: 2.8.9 \n
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
zmpop
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN", callback: Callback<unknown>]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], min: "MIN", callback: Callback<unknown>]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN"]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], min: "MIN"]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX", callback: Callback<unknown>]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], max: "MAX", callback: Callback<unknown>]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX"]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], max: "MAX"]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]): Promise<unknown>
- \n
Remove and return members with scores in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(K) + O(N*log(M)) where K is the number of provided keys, N being the number of elements in the sorted set, and M being the number of elements popped. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], min: "MIN", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN"]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], min: "MIN"]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], max: "MAX", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX"]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], max: "MAX"]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]
Returns Promise<unknown>
zmscore
- zmscore(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- zmscore(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- zmscore(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): Promise<string[]>
- zmscore(...args: [key: RedisKey, members: (string | number | Buffer)[]]): Promise<string[]>
- \n
Get the score associated with the given members in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(N) where N is the number of members being requested. \n
- since: 6.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<string[]>
zmscore
- zmscore
Buffer(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zmscore
Buffer(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zmscore
Buffer(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): Promise<Buffer[]> - zmscore
Buffer(...args: [key: RedisKey, members: (string | number | Buffer)[]]): Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<Buffer[]>
zpopmax
- zpopmax(key: RedisKey, callback?: Callback<string[]>): Promise<string[]>
- zpopmax(key: RedisKey, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Remove and return members with the highest scores in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(log(N)*M) with N being the number of elements in the sorted set, and M being the number of elements popped. \n
- since: 5.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
zpopmax
zpopmin
- zpopmin(key: RedisKey, callback?: Callback<string[]>): Promise<string[]>
- zpopmin(key: RedisKey, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Remove and return members with the lowest scores in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(log(N)*M) with N being the number of elements in the sorted set, and M being the number of elements popped. \n
- since: 5.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
zpopmin
zrandmember
- zrandmember(key: RedisKey, callback?: Callback<string>): Promise<string>
- zrandmember(key: RedisKey, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrandmember(key: RedisKey, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- \n
Get one or multiple random elements from a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(N) where N is the number of elements returned \n
- since: 6.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
zrandmember
- zrandmember
Buffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer> - zrandmember
Buffer(key: RedisKey, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrandmember
Buffer(key: RedisKey, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
zrange
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- \n
Return a range of members in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements returned. \n
- since: 1.2.0 \n
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
zrange
- zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
zrangebylex
- zrangebylex(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<string[]>): Promise<string[]>
- zrangebylex(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Return a range of members in a sorted set, by lexicographical range
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)). \n
- since: 2.8.9 \n
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
zrangebylex
- zrangebylex
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrangebylex
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
zrangebyscore
- zrangebyscore(key: RedisKey, min: string | number, max: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrangebyscore(key: RedisKey, min: string | number, max: string | number, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrangebyscore(key: RedisKey, min: string | number, max: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrangebyscore(key: RedisKey, min: string | number, max: string | number, withscores: "WITHSCORES", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Return a range of members in a sorted set, by score
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)). \n
- since: 1.0.5 \n
Parameters
key: RedisKey
min: string | number
max: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number
max: string | number
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number
max: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number
max: string | number
withscores: "WITHSCORES"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
zrangebyscore
- zrangebyscore
Buffer(key: RedisKey, min: string | number, max: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrangebyscore
Buffer(key: RedisKey, min: string | number, max: string | number, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrangebyscore
Buffer(key: RedisKey, min: string | number, max: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrangebyscore
Buffer(key: RedisKey, min: string | number, max: string | number, withscores: "WITHSCORES", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number
max: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number
max: string | number
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number
max: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number
max: string | number
withscores: "WITHSCORES"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
zrangestore
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<number>): Promise<number>
- \n
Store a range of members from sorted set into another key
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements stored into the destination key. \n
- since: 6.2.0 \n
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
zrank
- zrank(key: RedisKey, member: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Determine the index of a member in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
member: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
zrem
- zrem(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zrem(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zrem(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): Promise<number>
- zrem(...args: [key: RedisKey, members: (string | number | Buffer)[]]): Promise<number>
- \n
Remove one or more members from a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(M*log(N)) with N being the number of elements in the sorted set and M the number of elements to be removed. \n
- since: 1.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<number>
zremrangebylex
- zremrangebylex(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Remove all members in a sorted set between the given lexicographical range
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation. \n
- since: 2.8.9 \n
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
zremrangebyrank
- zremrangebyrank(key: RedisKey, start: string | number, stop: string | number, callback?: Callback<number>): Promise<number>
- \n
Remove all members in a sorted set within the given indexes
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
start: string | number
stop: string | number
Optional callback: Callback<number>
Returns Promise<number>
zremrangebyscore
- zremrangebyscore(key: RedisKey, min: string | number, max: string | number, callback?: Callback<number>): Promise<number>
- \n
Remove all members in a sorted set within the given scores
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation. \n
- since: 1.2.0 \n
Parameters
key: RedisKey
min: string | number
max: string | number
Optional callback: Callback<number>
Returns Promise<number>
zrevrange
- zrevrange(key: RedisKey, start: string | number, stop: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrevrange(key: RedisKey, start: string | number, stop: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- \n
Return a range of members in a sorted set, by index, with scores ordered from high to low
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements returned. \n
- since: 1.2.0 \n
Parameters
key: RedisKey
start: string | number
stop: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
start: string | number
stop: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
zrevrange
zrevrangebylex
- zrevrangebylex(key: RedisKey, max: string | number | Buffer, min: string | number | Buffer, callback?: Callback<string[]>): Promise<string[]>
- zrevrangebylex(key: RedisKey, max: string | number | Buffer, min: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Return a range of members in a sorted set, by lexicographical range, ordered from higher to lower strings.
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)). \n
- since: 2.8.9 \n
Parameters
key: RedisKey
max: string | number | Buffer
min: string | number | Buffer
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
max: string | number | Buffer
min: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
zrevrangebylex
- zrevrangebylex
Buffer(key: RedisKey, max: string | number | Buffer, min: string | number | Buffer, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrevrangebylex
Buffer(key: RedisKey, max: string | number | Buffer, min: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
max: string | number | Buffer
min: string | number | Buffer
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
max: string | number | Buffer
min: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
zrevrangebyscore
- zrevrangebyscore(key: RedisKey, max: string | number, min: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrevrangebyscore(key: RedisKey, max: string | number, min: string | number, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrevrangebyscore(key: RedisKey, max: string | number, min: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrevrangebyscore(key: RedisKey, max: string | number, min: string | number, withscores: "WITHSCORES", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Return a range of members in a sorted set, by score, with scores ordered from high to low
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)). \n
- since: 2.2.0 \n
Parameters
key: RedisKey
max: string | number
min: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
max: string | number
min: string | number
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
max: string | number
min: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
max: string | number
min: string | number
withscores: "WITHSCORES"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
zrevrangebyscore
- zrevrangebyscore
Buffer(key: RedisKey, max: string | number, min: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrevrangebyscore
Buffer(key: RedisKey, max: string | number, min: string | number, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrevrangebyscore
Buffer(key: RedisKey, max: string | number, min: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrevrangebyscore
Buffer(key: RedisKey, max: string | number, min: string | number, withscores: "WITHSCORES", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
max: string | number
min: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
max: string | number
min: string | number
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
max: string | number
min: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
max: string | number
min: string | number
withscores: "WITHSCORES"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
zrevrank
- zrevrank(key: RedisKey, member: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Determine the index of a member in a sorted set, with scores ordered from high to low
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
member: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
zscan
- zscan(key: RedisKey, cursor: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- zscan(key: RedisKey, cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- zscan(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- zscan(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- \n
Incrementally iterate sorted sets elements and associated scores
\n- \n
- group: sorted-set \n
- complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.. \n
- since: 2.8.0 \n
Parameters
key: RedisKey
cursor: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
key: RedisKey
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
zscan
- zscan
Buffer(key: RedisKey, cursor: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - zscan
Buffer(key: RedisKey, cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - zscan
Buffer(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - zscan
Buffer(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
zscan
- zscan
Buffer Stream(key: string, options?: ScanStreamOptions): default
Parameters
key: string
Optional options: ScanStreamOptions
Returns default
zscan
- zscan
Stream(key: string, options?: ScanStreamOptions): default
Parameters
key: string
Optional options: ScanStreamOptions
Returns default
zscore
- zscore(key: RedisKey, member: string | number | Buffer, callback?: Callback<string>): Promise<string>
- \n
Get the score associated with the given member in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(1) \n
- since: 1.2.0 \n
Parameters
key: RedisKey
member: string | number | Buffer
Optional callback: Callback<string>
Returns Promise<string>
zscore
- zscore
Buffer(key: RedisKey, member: string | number | Buffer, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
member: string | number | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
zunion
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[]]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[]]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<string[]>
- \n
Add multiple sorted sets
\n- \n
- group: sorted-set \n
- complexity: O(N)+O(M*log(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set. \n
- since: 6.2.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[]]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<string[]>
zunion
- zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[]]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[]]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
zunionstore
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[]]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[]]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[]]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]): Promise<number>
- \n
Add multiple sorted sets and store the resulting sorted set in a new key
\n- \n
- group: sorted-set \n
- complexity: O(N)+O(M log(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<number>
Generated using TypeDoc
Class Redis
\n
This is the major component of ioredis.\nUse it to connect to a standalone Redis server or Sentinels.
\nconst redis = new Redis(); // Default port is 6379
async function main() {
redis.set("foo", "bar");
redis.get("foo", (err, result) => {
// `result` should be "bar"
console.log(err, result);
});
// Or use Promise
const result = await redis.get("foo");
}\nHierarchy
- Commander
- EventEmitter
- Transaction
- Redis
Implements
- DataHandledable
Index
Constructors
Properties
Accessors
Methods
- acl
- acl
Buffer - add
Builtin Command - append
- asking
- auth
- bgrewriteaof
- bgrewriteaof
Buffer - bgsave
- bitcount
- bitfield
- bitfield_
ro - bitop
- bitpos
- blmove
- blmove
Buffer - blmpop
- blmpop
Buffer - blpop
- blpop
Buffer - brpop
- brpop
Buffer - brpoplpush
- brpoplpush
Buffer - bzmpop
- bzpopmax
- bzpopmax
Buffer - bzpopmin
- bzpopmin
Buffer - call
- call
Buffer - client
- client
Buffer - cluster
- command
- config
- connect
- copy
- create
Builtin Command - dbsize
- debug
- decr
- decrby
- define
Command - del
- discard
- disconnect
- dump
- dump
Buffer - duplicate
- echo
- echo
Buffer - end
- eval
- eval_
ro - evalsha
- evalsha_
ro - exec
- exists
- expire
- expireat
- expiretime
- failover
- fcall
- fcall_
ro - flushall
- flushdb
- function
- function
Buffer - geoadd
- geodist
- geodist
Buffer - geohash
- geohash
Buffer - geopos
- georadius
- georadius_
ro - georadiusbymember
- georadiusbymember_
ro - geosearch
- geosearchstore
- get
- get
Buffer - get
Builtin Commands - getbit
- getdel
- getdel
Buffer - getex
- getex
Buffer - getrange
- getrange
Buffer - getset
- getset
Buffer - hdel
- hello
- hexists
- hexpire
- hexpireat
- hexpiretime
- hget
- hget
Buffer - hgetall
- hgetall
Buffer - hgetdel
- hgetdel
Buffer - hgetex
- hgetex
Buffer - hincrby
- hincrbyfloat
- hincrbyfloat
Buffer - hkeys
- hkeys
Buffer - hlen
- hmget
- hmget
Buffer - hmset
- hpersist
- hpexpire
- hpexpireat
- hpexpiretime
- hpttl
- hrandfield
- hrandfield
Buffer - hscan
- hscan
Buffer - hscan
Buffer Stream - hscan
Stream - hset
- hsetex
- hsetnx
- hstrlen
- httl
- hvals
- hvals
Buffer - incr
- incrby
- incrbyfloat
- info
- keys
- keys
Buffer - lastsave
- latency
- lcs
- lindex
- lindex
Buffer - linsert
- llen
- lmove
- lmove
Buffer - lmpop
- lmpop
Buffer - lolwut
- lpop
- lpop
Buffer - lpos
- lpush
- lpushx
- lrange
- lrange
Buffer - lrem
- lset
- ltrim
- memory
- mget
- mget
Buffer - migrate
- module
- monitor
- move
- mset
- msetnx
- multi
- object
- on
- once
- persist
- pexpire
- pexpireat
- pexpiretime
- pfadd
- pfcount
- pfdebug
- pfmerge
- pfselftest
- ping
- ping
Buffer - pipeline
- psetex
- psubscribe
- psync
- pttl
- publish
- pubsub
- punsubscribe
- quit
- randomkey
- randomkey
Buffer - readonly
- readwrite
- rename
- renamenx
- replconf
- replicaof
- reset
- restore
- restore-
asking - role
- rpop
- rpop
Buffer - rpoplpush
- rpoplpush
Buffer - rpush
- rpushx
- sadd
- save
- scan
- scan
Buffer - scan
Buffer Stream - scan
Stream - scard
- script
- sdiff
- sdiff
Buffer - sdiffstore
- select
- set
- set
Buffer - setbit
- setex
- setnx
- setrange
- shutdown
- sinter
- sinter
Buffer - sintercard
- sinterstore
- sismember
- slaveof
- slowlog
- smembers
- smembers
Buffer - smismember
- smove
- sort
- sort_
ro - spop
- spop
Buffer - spublish
- srandmember
- srandmember
Buffer - srem
- sscan
- sscan
Buffer - sscan
Buffer Stream - sscan
Stream - ssubscribe
- strlen
- subscribe
- substr
- sunion
- sunion
Buffer - sunionstore
- sunsubscribe
- swapdb
- sync
- time
- touch
- ttl
- type
- unlink
- unsubscribe
- unwatch
- wait
- watch
- xack
- xadd
- xadd
Buffer - xautoclaim
- xclaim
- xdel
- xdelex
- xgroup
- xinfo
- xlen
- xpending
- xrange
- xrange
Buffer - xread
- xread
Buffer - xreadgroup
- xrevrange
- xrevrange
Buffer - xsetid
- xtrim
- zadd
- zadd
Buffer - zcard
- zcount
- zdiff
- zdiff
Buffer - zdiffstore
- zincrby
- zincrby
Buffer - zinter
- zinter
Buffer - zintercard
- zinterstore
- zlexcount
- zmpop
- zmscore
- zmscore
Buffer - zpopmax
- zpopmax
Buffer - zpopmin
- zpopmin
Buffer - zrandmember
- zrandmember
Buffer - zrange
- zrange
Buffer - zrangebylex
- zrangebylex
Buffer - zrangebyscore
- zrangebyscore
Buffer - zrangestore
- zrank
- zrem
- zremrangebylex
- zremrangebyrank
- zremrangebyscore
- zrevrange
- zrevrange
Buffer - zrevrangebylex
- zrevrangebylex
Buffer - zrevrangebyscore
- zrevrangebyscore
Buffer - zrevrank
- zscan
- zscan
Buffer - zscan
Buffer Stream - zscan
Stream - zscore
- zscore
Buffer - zunion
- zunion
Buffer - zunionstore
- create
Client
Constructors
constructor
- new
Redis(port: number, host: string, options: RedisOptions): Redis - new
Redis(path: string, options: RedisOptions): Redis - new
Redis(port: number, options: RedisOptions): Redis - new
Redis(port: number, host: string): Redis - new
Redis(options: RedisOptions): Redis - new
Redis(port: number): Redis - new
Redis(path: string): Redis - new
Redis(): Redis
Parameters
port: number
host: string
options: RedisOptions
Returns Redis
Parameters
path: string
options: RedisOptions
Returns Redis
Parameters
port: number
options: RedisOptions
Returns Redis
Parameters
port: number
host: string
Returns Redis
Parameters
options: RedisOptions
Returns Redis
Parameters
port: number
Returns Redis
Parameters
path: string
Returns Redis
Returns Redis
Properties
options
options: RedisOptions
status
status: RedisStatus = "wait"
Static Cluster
Static Command
Command: typeof default = Command
Accessors
auto
- get autoPipelineQueueSize(): number
Returns number
mode
- get mode(): "monitor" | "normal" | "subscriber"
- \n
Mode of the connection.
\nOne of
\n"normal","subscriber", or"monitor". When the connection is\nnot in"normal"mode, certain commands are not allowed.Returns "monitor" | "normal" | "subscriber"
Methods
acl
- acl(subcommand: "CAT", callback?: Callback<unknown>): Promise<unknown>
- acl(subcommand: "CAT", categoryname: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- acl(...args: [subcommand: "DELUSER", ...usernames: (string | Buffer)[], callback: Callback<number>]): Promise<number>
- acl(...args: [subcommand: "DELUSER", ...usernames: (string | Buffer)[]]): Promise<number>
- acl(subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, callback?: Callback<string>): Promise<string>
- acl(...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- acl(...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[]]): Promise<string>
- acl(subcommand: "GENPASS", callback?: Callback<string>): Promise<string>
- acl(subcommand: "GENPASS", bits: string | number, callback?: Callback<string>): Promise<string>
- acl(subcommand: "GETUSER", username: string | Buffer, callback?: Callback<string[]>): Promise<string[]>
- acl(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- acl(subcommand: "LIST", callback?: Callback<string[]>): Promise<string[]>
- acl(subcommand: "LOAD", callback?: Callback<"OK">): Promise<"OK">
- acl(subcommand: "LOG", callback?: Callback<unknown>): Promise<unknown>
- acl(subcommand: "LOG", count: string | number, callback?: Callback<unknown>): Promise<unknown>
- acl(subcommand: "LOG", reset: "RESET", callback?: Callback<unknown>): Promise<unknown>
- acl(subcommand: "SAVE", callback?: Callback<"OK">): Promise<"OK">
- acl(subcommand: "SETUSER", username: string | Buffer, callback?: Callback<"OK">): Promise<"OK">
- acl(...args: [subcommand: "SETUSER", username: string | Buffer, ...rules: (string | Buffer)[], callback: Callback<"OK">]): Promise<"OK">
- acl(...args: [subcommand: "SETUSER", username: string | Buffer, ...rules: (string | Buffer)[]]): Promise<"OK">
- acl(subcommand: "USERS", callback?: Callback<string[]>): Promise<string[]>
- acl(subcommand: "WHOAMI", callback?: Callback<string>): Promise<string>
- \n
List the ACL categories or the commands inside a category
\n- \n
- group: server \n
- complexity: O(1) since the categories and commands are a fixed set. \n
- since: 6.0.0 \n
Parameters
subcommand: "CAT"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "CAT"
categoryname: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Remove the specified ACL users and the associated rules
\n- \n
- group: server \n
- complexity: O(1) amortized time considering the typical user. \n
- since: 6.0.0 \n
Parameters
Rest ...args: [subcommand: "DELUSER", ...usernames: (string | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [subcommand: "DELUSER", ...usernames: (string | Buffer)[]]
Returns Promise<number>
- \n
Returns whether the user can execute the given command without executing the command.
\n- \n
- group: server \n
- complexity: O(1). \n
- since: 7.0.0 \n
Parameters
subcommand: "DRYRUN"
username: string | Buffer
command: string | Buffer
Optional callback: Callback<string>
Returns Promise<string>
Parameters
Rest ...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[]]
Returns Promise<string>
- \n
Generate a pseudorandom secure password to use for ACL users
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 6.0.0 \n
Parameters
subcommand: "GENPASS"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
subcommand: "GENPASS"
bits: string | number
Optional callback: Callback<string>
Returns Promise<string>
- \n
Get the rules for a specific ACL user
\n- \n
- group: server \n
- complexity: O(N). Where N is the number of password, command and pattern rules that the user has. \n
- since: 6.0.0 \n
Parameters
subcommand: "GETUSER"
username: string | Buffer
Optional callback: Callback<string[]>
Returns Promise<string[]>
- \n
Show helpful text about the different subcommands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 6.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
List the current ACL rules in ACL config file format
\n- \n
- group: server \n
- complexity: O(N). Where N is the number of configured users. \n
- since: 6.0.0 \n
Parameters
subcommand: "LIST"
Optional callback: Callback<string[]>
Returns Promise<string[]>
- \n
Reload the ACLs from the configured ACL file
\n- \n
- group: server \n
- complexity: O(N). Where N is the number of configured users. \n
- since: 6.0.0 \n
Parameters
subcommand: "LOAD"
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
List latest events denied because of ACLs in place
\n- \n
- group: server \n
- complexity: O(N) with N being the number of entries shown. \n
- since: 6.0.0 \n
Parameters
subcommand: "LOG"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "LOG"
count: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "LOG"
reset: "RESET"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Save the current ACL rules in the configured ACL file
\n- \n
- group: server \n
- complexity: O(N). Where N is the number of configured users. \n
- since: 6.0.0 \n
Parameters
subcommand: "SAVE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Modify or create the rules for a specific ACL user
\n- \n
- group: server \n
- complexity: O(N). Where N is the number of rules provided. \n
- since: 6.0.0 \n
Parameters
subcommand: "SETUSER"
username: string | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
Rest ...args: [subcommand: "SETUSER", username: string | Buffer, ...rules: (string | Buffer)[], callback: Callback<"OK">]
Returns Promise<"OK">
Parameters
Rest ...args: [subcommand: "SETUSER", username: string | Buffer, ...rules: (string | Buffer)[]]
Returns Promise<"OK">
- \n
List the username of all the configured ACL rules
\n- \n
- group: server \n
- complexity: O(N). Where N is the number of configured users. \n
- since: 6.0.0 \n
Parameters
subcommand: "USERS"
Optional callback: Callback<string[]>
Returns Promise<string[]>
- \n
Return the name of the user associated to the current connection
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 6.0.0 \n
Parameters
subcommand: "WHOAMI"
Optional callback: Callback<string>
Returns Promise<string>
acl
- acl
Buffer(subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, callback?: Callback<Buffer>): Promise<Buffer> - acl
Buffer(...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - acl
Buffer(...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[]]): Promise<Buffer> - acl
Buffer(subcommand: "GENPASS", callback?: Callback<Buffer>): Promise<Buffer> - acl
Buffer(subcommand: "GENPASS", bits: string | number, callback?: Callback<Buffer>): Promise<Buffer> - acl
Buffer(subcommand: "GETUSER", username: string | Buffer, callback?: Callback<Buffer[]>): Promise<Buffer[]> - acl
Buffer(subcommand: "LIST", callback?: Callback<Buffer[]>): Promise<Buffer[]> - acl
Buffer(subcommand: "USERS", callback?: Callback<Buffer[]>): Promise<Buffer[]> - acl
Buffer(subcommand: "WHOAMI", callback?: Callback<Buffer>): Promise<Buffer>
Parameters
subcommand: "DRYRUN"
username: string | Buffer
command: string | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
Rest ...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
subcommand: "GENPASS"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "GENPASS"
bits: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "GETUSER"
username: string | Buffer
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
subcommand: "LIST"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
subcommand: "USERS"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
subcommand: "WHOAMI"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
add
- add
Builtin Command(commandName: string): void
- \n
Create add builtin command
\nParameters
commandName: string
Returns void
append
- append(key: RedisKey, value: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Append a value to a key
\n- \n
- group: string \n
- complexity: O(1). The amortized time complexity is O(1) assuming the appended value is small and the already present value is of any size, since the dynamic string library used by Redis will double the free space available on every reallocation. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
value: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
asking
- asking(callback?: Callback<"OK">): Promise<"OK">
- \n
Sent by cluster clients after an -ASK redirect
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
auth
- auth(password: string | Buffer, callback?: Callback<"OK">): Promise<"OK">
- auth(username: string | Buffer, password: string | Buffer, callback?: Callback<"OK">): Promise<"OK">
- \n
Authenticate to the server
\n- \n
- group: connection \n
- complexity: O(N) where N is the number of passwords defined for the user \n
- since: 1.0.0 \n
Parameters
password: string | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
username: string | Buffer
password: string | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
bgrewriteaof
- bgrewriteaof(callback?: Callback<string>): Promise<string>
- \n
Asynchronously rewrite the append-only file
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<string>
Returns Promise<string>
bgrewriteaof
- bgrewriteaof
Buffer(callback?: Callback<Buffer>): Promise<Buffer>
Parameters
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
bgsave
- bgsave(callback?: Callback<"OK">): Promise<"OK">
- bgsave(schedule: "SCHEDULE", callback?: Callback<"OK">): Promise<"OK">
- \n
Asynchronously save the dataset to disk
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
schedule: "SCHEDULE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
bitcount
- bitcount(key: RedisKey, callback?: Callback<number>): Promise<number>
- bitcount(key: RedisKey, start: string | number, end: string | number, callback?: Callback<number>): Promise<number>
- bitcount(key: RedisKey, start: string | number, end: string | number, byte: "BYTE", callback?: Callback<number>): Promise<number>
- bitcount(key: RedisKey, start: string | number, end: string | number, bit: "BIT", callback?: Callback<number>): Promise<number>
- \n
Count set bits in a string
\n- \n
- group: bitmap \n
- complexity: O(N) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
start: string | number
end: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
start: string | number
end: string | number
byte: "BYTE"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
start: string | number
end: string | number
bit: "BIT"
Optional callback: Callback<number>
Returns Promise<number>
bitfield
- bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: string | number, callback?: Callback<unknown>): Promise<unknown>
- bitfield(key: RedisKey, encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: string | number, value: string | number, callback?: Callback<unknown>): Promise<unknown>
- bitfield(key: RedisKey, encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: string | number, increment: string | number, callback?: Callback<unknown>): Promise<unknown>
- bitfield(key: RedisKey, overflow: "OVERFLOW", wrap: "WRAP", encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: string | number, value: string | number, callback?: Callback<unknown>): Promise<unknown>
- bitfield(key: RedisKey, overflow: "OVERFLOW", wrap: "WRAP", encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: string | number, increment: string | number, callback?: Callback<unknown>): Promise<unknown>
- bitfield(key: RedisKey, overflow: "OVERFLOW", sat: "SAT", encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: string | number, value: string | number, callback?: Callback<unknown>): Promise<unknown>
- bitfield(key: RedisKey, overflow: "OVERFLOW", sat: "SAT", encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: string | number, increment: string | number, callback?: Callback<unknown>): Promise<unknown>
- bitfield(key: RedisKey, overflow: "OVERFLOW", fail: "FAIL", encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: string | number, value: string | number, callback?: Callback<unknown>): Promise<unknown>
- bitfield(key: RedisKey, overflow: "OVERFLOW", fail: "FAIL", encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: string | number, increment: string | number, callback?: Callback<unknown>): Promise<unknown>
- \n
Perform arbitrary bitfield integer operations on strings
\n- \n
- group: bitmap \n
- complexity: O(1) for each subcommand specified \n
- since: 3.2.0 \n
Parameters
key: RedisKey
encodingOffsetToken: "GET"
encoding: string | Buffer
offset: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
encodingOffsetValueToken: "SET"
encoding: string | Buffer
offset: string | number
value: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
encodingOffsetIncrementToken: "INCRBY"
encoding: string | Buffer
offset: string | number
increment: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
overflow: "OVERFLOW"
wrap: "WRAP"
encodingOffsetValueToken: "SET"
encoding: string | Buffer
offset: string | number
value: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
overflow: "OVERFLOW"
wrap: "WRAP"
encodingOffsetIncrementToken: "INCRBY"
encoding: string | Buffer
offset: string | number
increment: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
overflow: "OVERFLOW"
sat: "SAT"
encodingOffsetValueToken: "SET"
encoding: string | Buffer
offset: string | number
value: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
overflow: "OVERFLOW"
sat: "SAT"
encodingOffsetIncrementToken: "INCRBY"
encoding: string | Buffer
offset: string | number
increment: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
overflow: "OVERFLOW"
fail: "FAIL"
encodingOffsetValueToken: "SET"
encoding: string | Buffer
offset: string | number
value: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
overflow: "OVERFLOW"
fail: "FAIL"
encodingOffsetIncrementToken: "INCRBY"
encoding: string | Buffer
offset: string | number
increment: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
bitfield_
- bitfield_
ro(...args: [key: RedisKey, encodingOffsetToken: "GET", ...encodingOffsets: (string | number | Buffer)[], callback: Callback<unknown[]>]): Promise<unknown[]> - bitfield_
ro(...args: [key: RedisKey, encodingOffsetToken: "GET", ...encodingOffsets: (string | number | Buffer)[]]): Promise<unknown[]>
- \n
Perform arbitrary bitfield integer operations on strings. Read-only variant of BITFIELD
\n- \n
- group: bitmap \n
- complexity: O(1) for each subcommand specified \n
- since: 6.0.0 \n
Parameters
Rest ...args: [key: RedisKey, encodingOffsetToken: "GET", ...encodingOffsets: (string | number | Buffer)[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, encodingOffsetToken: "GET", ...encodingOffsets: (string | number | Buffer)[]]
Returns Promise<unknown[]>
bitop
- bitop(...args: [operation: string | Buffer, destkey: RedisKey, ...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- bitop(...args: [operation: string | Buffer, destkey: RedisKey, keys: RedisKey[], callback: Callback<number>]): Promise<number>
- bitop(...args: [operation: string | Buffer, destkey: RedisKey, ...keys: RedisKey[]]): Promise<number>
- bitop(...args: [operation: string | Buffer, destkey: RedisKey, keys: RedisKey[]]): Promise<number>
- \n
Perform bitwise operations between strings
\n- \n
- group: bitmap \n
- complexity: O(N) \n
- since: 2.6.0 \n
Parameters
Rest ...args: [operation: string | Buffer, destkey: RedisKey, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [operation: string | Buffer, destkey: RedisKey, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
bitpos
- bitpos(key: RedisKey, bit: string | number, callback?: Callback<number>): Promise<number>
- bitpos(key: RedisKey, bit: string | number, start: string | number, callback?: Callback<number>): Promise<number>
- bitpos(key: RedisKey, bit: string | number, start: string | number, end: string | number, callback?: Callback<number>): Promise<number>
- bitpos(key: RedisKey, bit: string | number, start: string | number, end: string | number, byte: "BYTE", callback?: Callback<number>): Promise<number>
- bitpos(key: RedisKey, bit: string | number, start: string | number, end: string | number, bit1: "BIT", callback?: Callback<number>): Promise<number>
- \n
Find first bit set or clear in a string
\n- \n
- group: bitmap \n
- complexity: O(N) \n
- since: 2.8.7 \n
Parameters
key: RedisKey
bit: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
bit: string | number
start: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
bit: string | number
start: string | number
end: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
bit: string | number
start: string | number
end: string | number
byte: "BYTE"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
bit: string | number
start: string | number
end: string | number
bit1: "BIT"
Optional callback: Callback<number>
Returns Promise<number>
blmove
- blmove(source: RedisKey, destination: RedisKey, left: "LEFT", left1: "LEFT", timeout: string | number, callback?: Callback<string>): Promise<string>
- blmove(source: RedisKey, destination: RedisKey, left: "LEFT", right: "RIGHT", timeout: string | number, callback?: Callback<string>): Promise<string>
- blmove(source: RedisKey, destination: RedisKey, right: "RIGHT", left: "LEFT", timeout: string | number, callback?: Callback<string>): Promise<string>
- blmove(source: RedisKey, destination: RedisKey, right: "RIGHT", right1: "RIGHT", timeout: string | number, callback?: Callback<string>): Promise<string>
- \n
Pop an element from a list, push it to another list and return it; or block until one is available
\n- \n
- group: list \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
source: RedisKey
destination: RedisKey
left: "LEFT"
left1: "LEFT"
timeout: string | number
Optional callback: Callback<string>
Returns Promise<string>
Parameters
source: RedisKey
destination: RedisKey
left: "LEFT"
right: "RIGHT"
timeout: string | number
Optional callback: Callback<string>
Returns Promise<string>
Parameters
source: RedisKey
destination: RedisKey
right: "RIGHT"
left: "LEFT"
timeout: string | number
Optional callback: Callback<string>
Returns Promise<string>
Parameters
source: RedisKey
destination: RedisKey
right: "RIGHT"
right1: "RIGHT"
timeout: string | number
Optional callback: Callback<string>
Returns Promise<string>
blmove
- blmove
Buffer(source: RedisKey, destination: RedisKey, left: "LEFT", left1: "LEFT", timeout: string | number, callback?: Callback<Buffer>): Promise<Buffer> - blmove
Buffer(source: RedisKey, destination: RedisKey, left: "LEFT", right: "RIGHT", timeout: string | number, callback?: Callback<Buffer>): Promise<Buffer> - blmove
Buffer(source: RedisKey, destination: RedisKey, right: "RIGHT", left: "LEFT", timeout: string | number, callback?: Callback<Buffer>): Promise<Buffer> - blmove
Buffer(source: RedisKey, destination: RedisKey, right: "RIGHT", right1: "RIGHT", timeout: string | number, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
source: RedisKey
destination: RedisKey
left: "LEFT"
left1: "LEFT"
timeout: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
source: RedisKey
destination: RedisKey
left: "LEFT"
right: "RIGHT"
timeout: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
source: RedisKey
destination: RedisKey
right: "RIGHT"
left: "LEFT"
timeout: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
source: RedisKey
destination: RedisKey
right: "RIGHT"
right1: "RIGHT"
timeout: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
blmpop
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT"]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT"]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): Promise<[key: string, members: string[]]>
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): Promise<[key: string, members: string[]]>
- \n
Pop elements from a list, or block until one is available
\n- \n
- group: list \n
- complexity: O(N+M) where N is the number of provided keys and M is the number of elements returned. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns Promise<[key: string, members: string[]]>
blmpop
- blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT"]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT"]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): Promise<[key: Buffer, members: Buffer[]]> - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns Promise<[key: Buffer, members: Buffer[]]>
blpop
- blpop(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]): Promise<[string, string]>
- blpop(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]): Promise<[string, string]>
- blpop(...args: [...keys: RedisKey[], timeout: string | number]): Promise<[string, string]>
- blpop(...args: [keys: RedisKey[], timeout: string | number]): Promise<[string, string]>
- \n
Remove and get the first element in a list, or block until one is available
\n- \n
- group: list \n
- complexity: O(N) where N is the number of provided keys. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]
Returns Promise<[string, string]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]
Returns Promise<[string, string]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[string, string]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[string, string]>
blpop
- blpop
Buffer(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]): Promise<[Buffer, Buffer]> - blpop
Buffer(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]): Promise<[Buffer, Buffer]> - blpop
Buffer(...args: [...keys: RedisKey[], timeout: string | number]): Promise<[Buffer, Buffer]> - blpop
Buffer(...args: [keys: RedisKey[], timeout: string | number]): Promise<[Buffer, Buffer]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]
Returns Promise<[Buffer, Buffer]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]
Returns Promise<[Buffer, Buffer]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[Buffer, Buffer]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[Buffer, Buffer]>
brpop
- brpop(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]): Promise<[string, string]>
- brpop(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]): Promise<[string, string]>
- brpop(...args: [...keys: RedisKey[], timeout: string | number]): Promise<[string, string]>
- brpop(...args: [keys: RedisKey[], timeout: string | number]): Promise<[string, string]>
- \n
Remove and get the last element in a list, or block until one is available
\n- \n
- group: list \n
- complexity: O(N) where N is the number of provided keys. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]
Returns Promise<[string, string]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]
Returns Promise<[string, string]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[string, string]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[string, string]>
brpop
- brpop
Buffer(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]): Promise<[Buffer, Buffer]> - brpop
Buffer(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]): Promise<[Buffer, Buffer]> - brpop
Buffer(...args: [...keys: RedisKey[], timeout: string | number]): Promise<[Buffer, Buffer]> - brpop
Buffer(...args: [keys: RedisKey[], timeout: string | number]): Promise<[Buffer, Buffer]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]
Returns Promise<[Buffer, Buffer]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]
Returns Promise<[Buffer, Buffer]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[Buffer, Buffer]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[Buffer, Buffer]>
brpoplpush
brpoplpush
bzmpop
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN", callback: Callback<unknown>]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN", callback: Callback<unknown>]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN"]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN"]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX", callback: Callback<unknown>]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX", callback: Callback<unknown>]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX"]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX"]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]): Promise<unknown>
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]): Promise<unknown>
- \n
Remove and return members with scores in a sorted set or block until one is available
\n- \n
- group: sorted-set \n
- complexity: O(K) + O(N*log(M)) where K is the number of provided keys, N being the number of elements in the sorted set, and M being the number of elements popped. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN"]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN"]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX"]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX"]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]
Returns Promise<unknown>
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]
Returns Promise<unknown>
bzpopmax
- bzpopmax(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]): Promise<[key: string, member: string, score: string]>
- bzpopmax(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]): Promise<[key: string, member: string, score: string]>
- bzpopmax(...args: [...keys: RedisKey[], timeout: string | number]): Promise<[key: string, member: string, score: string]>
- bzpopmax(...args: [keys: RedisKey[], timeout: string | number]): Promise<[key: string, member: string, score: string]>
- \n
Remove and return the member with the highest score from one or more sorted sets, or block until one is available
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) with N being the number of elements in the sorted set. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]
Returns Promise<[key: string, member: string, score: string]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]
Returns Promise<[key: string, member: string, score: string]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[key: string, member: string, score: string]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[key: string, member: string, score: string]>
bzpopmax
- bzpopmax
Buffer(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]): Promise<[key: Buffer, member: Buffer, score: Buffer]> - bzpopmax
Buffer(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]): Promise<[key: Buffer, member: Buffer, score: Buffer]> - bzpopmax
Buffer(...args: [...keys: RedisKey[], timeout: string | number]): Promise<[key: Buffer, member: Buffer, score: Buffer]> - bzpopmax
Buffer(...args: [keys: RedisKey[], timeout: string | number]): Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
bzpopmin
- bzpopmin(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]): Promise<[key: string, member: string, score: string]>
- bzpopmin(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]): Promise<[key: string, member: string, score: string]>
- bzpopmin(...args: [...keys: RedisKey[], timeout: string | number]): Promise<[key: string, member: string, score: string]>
- bzpopmin(...args: [keys: RedisKey[], timeout: string | number]): Promise<[key: string, member: string, score: string]>
- \n
Remove and return the member with the lowest score from one or more sorted sets, or block until one is available
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) with N being the number of elements in the sorted set. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]
Returns Promise<[key: string, member: string, score: string]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]
Returns Promise<[key: string, member: string, score: string]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[key: string, member: string, score: string]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[key: string, member: string, score: string]>
bzpopmin
- bzpopmin
Buffer(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]): Promise<[key: Buffer, member: Buffer, score: Buffer]> - bzpopmin
Buffer(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]): Promise<[key: Buffer, member: Buffer, score: Buffer]> - bzpopmin
Buffer(...args: [...keys: RedisKey[], timeout: string | number]): Promise<[key: Buffer, member: Buffer, score: Buffer]> - bzpopmin
Buffer(...args: [keys: RedisKey[], timeout: string | number]): Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
call
- call(command: string, callback?: Callback<unknown>): Promise<unknown>
- call(command: string, args: (string | number | Buffer)[], callback?: Callback<unknown>): Promise<unknown>
- call(...args: [command: string, ...args: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- call(...args: [command: string, ...args: (string | number | Buffer)[]]): Promise<unknown>
- \n
Call arbitrary commands.
\n
\nredis.call('set', 'foo', 'bar')is the same asredis.set('foo', 'bar'),\nso the only case you need to use this method is when the command is not\nsupported by ioredis.
\nredis.call('set', 'foo', 'bar');
redis.call('get', 'foo', (err, value) => {
// value === 'bar'
});\nParameters
command: string
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
command: string
args: (string | number | Buffer)[]
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [command: string, ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [command: string, ...args: (string | number | Buffer)[]]
Returns Promise<unknown>
call
- call
Buffer(command: string, callback?: Callback<unknown>): Promise<unknown> - call
Buffer(command: string, args: (string | number | Buffer)[], callback?: Callback<unknown>): Promise<unknown> - call
Buffer(...args: [command: string, ...args: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown> - call
Buffer(...args: [command: string, ...args: (string | number | Buffer)[]]): Promise<unknown>
Parameters
command: string
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
command: string
args: (string | number | Buffer)[]
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [command: string, ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [command: string, ...args: (string | number | Buffer)[]]
Returns Promise<unknown>
client
- client(subcommand: "CACHING", yes: "YES", callback?: Callback<"OK">): Promise<"OK">
- client(subcommand: "CACHING", no: "NO", callback?: Callback<"OK">): Promise<"OK">
- client(subcommand: "GETNAME", callback?: Callback<string>): Promise<string>
- client(subcommand: "GETREDIR", callback?: Callback<number>): Promise<number>
- client(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- client(subcommand: "ID", callback?: Callback<number>): Promise<number>
- client(subcommand: "INFO", callback?: Callback<string>): Promise<string>
- client(...args: [subcommand: "KILL", ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown>
- client(...args: [subcommand: "KILL", ...args: RedisValue[]]): Promise<unknown>
- client(subcommand: "LIST", callback?: Callback<unknown>): Promise<unknown>
- client(...args: [subcommand: "LIST", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]): Promise<unknown>
- client(...args: [subcommand: "LIST", idToken: "ID", ...clientIds: (string | number)[]]): Promise<unknown>
- client(subcommand: "LIST", type: "TYPE", normal: "NORMAL", callback?: Callback<unknown>): Promise<unknown>
- client(...args: [subcommand: "LIST", type: "TYPE", normal: "NORMAL", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]): Promise<unknown>
- client(...args: [subcommand: "LIST", type: "TYPE", normal: "NORMAL", idToken: "ID", ...clientIds: (string | number)[]]): Promise<unknown>
- client(subcommand: "LIST", type: "TYPE", master: "MASTER", callback?: Callback<unknown>): Promise<unknown>
- client(...args: [subcommand: "LIST", type: "TYPE", master: "MASTER", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]): Promise<unknown>
- client(...args: [subcommand: "LIST", type: "TYPE", master: "MASTER", idToken: "ID", ...clientIds: (string | number)[]]): Promise<unknown>
- client(subcommand: "LIST", type: "TYPE", replica: "REPLICA", callback?: Callback<unknown>): Promise<unknown>
- client(...args: [subcommand: "LIST", type: "TYPE", replica: "REPLICA", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]): Promise<unknown>
- client(...args: [subcommand: "LIST", type: "TYPE", replica: "REPLICA", idToken: "ID", ...clientIds: (string | number)[]]): Promise<unknown>
- client(subcommand: "LIST", type: "TYPE", pubsub: "PUBSUB", callback?: Callback<unknown>): Promise<unknown>
- client(...args: [subcommand: "LIST", type: "TYPE", pubsub: "PUBSUB", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]): Promise<unknown>
- client(...args: [subcommand: "LIST", type: "TYPE", pubsub: "PUBSUB", idToken: "ID", ...clientIds: (string | number)[]]): Promise<unknown>
- client(subcommand: "NO-EVICT", on: "ON", callback?: Callback<unknown>): Promise<unknown>
- client(subcommand: "NO-EVICT", off: "OFF", callback?: Callback<unknown>): Promise<unknown>
- client(subcommand: "PAUSE", timeout: string | number, callback?: Callback<"OK">): Promise<"OK">
- client(subcommand: "PAUSE", timeout: string | number, write: "WRITE", callback?: Callback<"OK">): Promise<"OK">
- client(subcommand: "PAUSE", timeout: string | number, all: "ALL", callback?: Callback<"OK">): Promise<"OK">
- client(subcommand: "REPLY", on: "ON", callback?: Callback<unknown>): Promise<unknown>
- client(subcommand: "REPLY", off: "OFF", callback?: Callback<unknown>): Promise<unknown>
- client(subcommand: "REPLY", skip: "SKIP", callback?: Callback<unknown>): Promise<unknown>
- client(subcommand: "SETNAME", connectionName: string | Buffer, callback?: Callback<"OK">): Promise<"OK">
- client(...args: [subcommand: "TRACKING", ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown>
- client(...args: [subcommand: "TRACKING", ...args: RedisValue[]]): Promise<unknown>
- client(subcommand: "TRACKINGINFO", callback?: Callback<string>): Promise<string>
- client(subcommand: "UNBLOCK", clientId: string | number, callback?: Callback<unknown>): Promise<unknown>
- client(subcommand: "UNBLOCK", clientId: string | number, timeout: "TIMEOUT", callback?: Callback<unknown>): Promise<unknown>
- client(subcommand: "UNBLOCK", clientId: string | number, error: "ERROR", callback?: Callback<unknown>): Promise<unknown>
- client(subcommand: "UNPAUSE", callback?: Callback<"OK">): Promise<"OK">
- \n
Instruct the server about tracking or not keys in the next request
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 6.0.0 \n
Parameters
subcommand: "CACHING"
yes: "YES"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "CACHING"
no: "NO"
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Get the current connection name
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 2.6.9 \n
Parameters
subcommand: "GETNAME"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Get tracking notifications redirection client ID if any
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 6.0.0 \n
Parameters
subcommand: "GETREDIR"
Optional callback: Callback<number>
Returns Promise<number>
- \n
Show helpful text about the different subcommands
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Returns the client ID for the current connection
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "ID"
Optional callback: Callback<number>
Returns Promise<number>
- \n
Returns information about the current client connection.
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
subcommand: "INFO"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Kill the connection of a client
\n- \n
- group: connection \n
- complexity: O(N) where N is the number of client connections \n
- since: 2.4.0 \n
Parameters
Rest ...args: [subcommand: "KILL", ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "KILL", ...args: RedisValue[]]
Returns Promise<unknown>
- \n
Get the list of client connections
\n- \n
- group: connection \n
- complexity: O(N) where N is the number of client connections \n
- since: 2.4.0 \n
Parameters
subcommand: "LIST"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", idToken: "ID", ...clientIds: (string | number)[]]
Returns Promise<unknown>
Parameters
subcommand: "LIST"
type: "TYPE"
normal: "NORMAL"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", normal: "NORMAL", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", normal: "NORMAL", idToken: "ID", ...clientIds: (string | number)[]]
Returns Promise<unknown>
Parameters
subcommand: "LIST"
type: "TYPE"
master: "MASTER"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", master: "MASTER", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", master: "MASTER", idToken: "ID", ...clientIds: (string | number)[]]
Returns Promise<unknown>
Parameters
subcommand: "LIST"
type: "TYPE"
replica: "REPLICA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", replica: "REPLICA", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", replica: "REPLICA", idToken: "ID", ...clientIds: (string | number)[]]
Returns Promise<unknown>
Parameters
subcommand: "LIST"
type: "TYPE"
pubsub: "PUBSUB"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", pubsub: "PUBSUB", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", pubsub: "PUBSUB", idToken: "ID", ...clientIds: (string | number)[]]
Returns Promise<unknown>
- \n
Set client eviction mode for the current connection
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
subcommand: "NO-EVICT"
on: "ON"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "NO-EVICT"
off: "OFF"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Stop processing commands from clients for some time
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 2.9.50 \n
Parameters
subcommand: "PAUSE"
timeout: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "PAUSE"
timeout: string | number
write: "WRITE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "PAUSE"
timeout: string | number
all: "ALL"
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Instruct the server whether to reply to commands
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 3.2.0 \n
Parameters
subcommand: "REPLY"
on: "ON"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "REPLY"
off: "OFF"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "REPLY"
skip: "SKIP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Set the current connection name
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 2.6.9 \n
Parameters
subcommand: "SETNAME"
connectionName: string | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Enable or disable server assisted client side caching support
\n- \n
- group: connection \n
- complexity: O(1). Some options may introduce additional complexity. \n
- since: 6.0.0 \n
Parameters
Rest ...args: [subcommand: "TRACKING", ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "TRACKING", ...args: RedisValue[]]
Returns Promise<unknown>
- \n
Return information about server assisted client side caching for the current connection
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
subcommand: "TRACKINGINFO"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Unblock a client blocked in a blocking command from a different connection
\n- \n
- group: connection \n
- complexity: O(log N) where N is the number of client connections \n
- since: 5.0.0 \n
Parameters
subcommand: "UNBLOCK"
clientId: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "UNBLOCK"
clientId: string | number
timeout: "TIMEOUT"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "UNBLOCK"
clientId: string | number
error: "ERROR"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Resume processing of clients that were paused
\n- \n
- group: connection \n
- complexity: O(N) Where N is the number of paused clients \n
- since: 6.2.0 \n
Parameters
subcommand: "UNPAUSE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
client
- client
Buffer(subcommand: "GETNAME", callback?: Callback<Buffer>): Promise<Buffer> - client
Buffer(subcommand: "INFO", callback?: Callback<Buffer>): Promise<Buffer> - client
Buffer(subcommand: "TRACKINGINFO", callback?: Callback<Buffer>): Promise<Buffer>
Parameters
subcommand: "GETNAME"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "INFO"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "TRACKINGINFO"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
cluster
- cluster(...args: [subcommand: "ADDSLOTS", ...slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "ADDSLOTS", slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "ADDSLOTS", ...slots: (string | number)[]]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "ADDSLOTS", slots: (string | number)[]]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "ADDSLOTSRANGE", ...startSlotEndSlots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "ADDSLOTSRANGE", ...startSlotEndSlots: (string | number)[]]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(subcommand: "BUMPEPOCH", callback?: Callback<"BUMPED" | "STILL">): Promise<"BUMPED" | "STILL">
- cluster(subcommand: "COUNT-FAILURE-REPORTS", nodeId: string | number | Buffer, callback?: Callback<number>): Promise<number>
- cluster(subcommand: "COUNTKEYSINSLOT", slot: string | number, callback?: Callback<number>): Promise<number>
- cluster(...args: [subcommand: "DELSLOTS", ...slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "DELSLOTS", slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "DELSLOTS", ...slots: (string | number)[]]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "DELSLOTS", slots: (string | number)[]]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "DELSLOTSRANGE", ...startSlotEndSlots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(...args: [subcommand: "DELSLOTSRANGE", ...startSlotEndSlots: (string | number)[]]): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(subcommand: "FAILOVER", callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "FAILOVER", force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "FAILOVER", takeover: "TAKEOVER", callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "FLUSHSLOTS", callback?: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- cluster(subcommand: "FORGET", nodeId: string | number | Buffer, callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "GETKEYSINSLOT", slot: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- cluster(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- cluster(subcommand: "INFO", callback?: Callback<string>): Promise<string>
- cluster(subcommand: "KEYSLOT", key: string | Buffer, callback?: Callback<number>): Promise<number>
- cluster(subcommand: "LINKS", callback?: Callback<unknown[]>): Promise<unknown[]>
- cluster(subcommand: "MEET", ip: string | Buffer, port: string | number, callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "MYID", callback?: Callback<string>): Promise<string>
- cluster(subcommand: "NODES", callback?: Callback<unknown>): Promise<unknown>
- cluster(subcommand: "REPLICAS", nodeId: string | number | Buffer, callback?: Callback<unknown>): Promise<unknown>
- cluster(subcommand: "REPLICATE", nodeId: string | number | Buffer, callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "RESET", callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "RESET", hard: "HARD", callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "RESET", soft: "SOFT", callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "SAVECONFIG", callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "SET-CONFIG-EPOCH", configEpoch: string | number, callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "SETSLOT", slot: string | number, nodeIdToken: "IMPORTING", nodeId: string | number | Buffer, callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "SETSLOT", slot: string | number, nodeIdToken: "MIGRATING", nodeId: string | number | Buffer, callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "SETSLOT", slot: string | number, nodeIdToken: "NODE", nodeId: string | number | Buffer, callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "SETSLOT", slot: string | number, stable: "STABLE", callback?: Callback<"OK">): Promise<"OK">
- cluster(subcommand: "SHARDS", callback?: Callback<unknown>): Promise<unknown>
- cluster(subcommand: "SLAVES", nodeId: string | number | Buffer, callback?: Callback<unknown>): Promise<unknown>
- cluster(subcommand: "SLOTS", callback?: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>): Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- \n
Assign new hash slots to receiving node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of hash slot arguments \n
- since: 3.0.0 \n
Parameters
Rest ...args: [subcommand: "ADDSLOTS", ...slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Parameters
Rest ...args: [subcommand: "ADDSLOTS", slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Parameters
Rest ...args: [subcommand: "ADDSLOTS", ...slots: (string | number)[]]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Parameters
Rest ...args: [subcommand: "ADDSLOTS", slots: (string | number)[]]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- \n
Assign new hash slots to receiving node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of the slots between the start slot and end slot arguments. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [subcommand: "ADDSLOTSRANGE", ...startSlotEndSlots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Parameters
Rest ...args: [subcommand: "ADDSLOTSRANGE", ...startSlotEndSlots: (string | number)[]]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- \n
Advance the cluster config epoch
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "BUMPEPOCH"
Optional callback: Callback<"BUMPED" | "STILL">
Returns Promise<"BUMPED" | "STILL">
- \n
Return the number of failure reports active for a given node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the number of failure reports \n
- since: 3.0.0 \n
Parameters
subcommand: "COUNT-FAILURE-REPORTS"
nodeId: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
- \n
Return the number of local keys in the specified hash slot
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "COUNTKEYSINSLOT"
slot: string | number
Optional callback: Callback<number>
Returns Promise<number>
- \n
Set hash slots as unbound in receiving node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of hash slot arguments \n
- since: 3.0.0 \n
Parameters
Rest ...args: [subcommand: "DELSLOTS", ...slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Parameters
Rest ...args: [subcommand: "DELSLOTS", slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Parameters
Rest ...args: [subcommand: "DELSLOTS", ...slots: (string | number)[]]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Parameters
Rest ...args: [subcommand: "DELSLOTS", slots: (string | number)[]]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- \n
Set hash slots as unbound in receiving node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of the slots between the start slot and end slot arguments. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [subcommand: "DELSLOTSRANGE", ...startSlotEndSlots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Parameters
Rest ...args: [subcommand: "DELSLOTSRANGE", ...startSlotEndSlots: (string | number)[]]
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- \n
Forces a replica to perform a manual failover of its master.
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "FAILOVER"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "FAILOVER"
force: "FORCE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "FAILOVER"
takeover: "TAKEOVER"
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Delete a node's own slots information
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "FLUSHSLOTS"
Optional callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
- \n
Remove a node from the nodes table
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "FORGET"
nodeId: string | number | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Return local key names in the specified hash slot
\n- \n
- group: cluster \n
- complexity: O(log(N)) where N is the number of requested keys \n
- since: 3.0.0 \n
Parameters
subcommand: "GETKEYSINSLOT"
slot: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
- \n
Show helpful text about the different subcommands
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Provides info about Redis Cluster node state
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "INFO"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Returns the hash slot of the specified key
\n- \n
- group: cluster \n
- complexity: O(N) where N is the number of bytes in the key \n
- since: 3.0.0 \n
Parameters
subcommand: "KEYSLOT"
key: string | Buffer
Optional callback: Callback<number>
Returns Promise<number>
- \n
Returns a list of all TCP links to and from peer nodes in cluster
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of Cluster nodes \n
- since: 7.0.0 \n
Parameters
subcommand: "LINKS"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Force a node cluster to handshake with another node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "MEET"
ip: string | Buffer
port: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Return the node id
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "MYID"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Get Cluster config for the node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of Cluster nodes \n
- since: 3.0.0 \n
Parameters
subcommand: "NODES"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
List replica nodes of the specified master node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "REPLICAS"
nodeId: string | number | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Reconfigure a node as a replica of the specified master node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "REPLICATE"
nodeId: string | number | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Reset a Redis Cluster node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the number of known nodes. The command may execute a FLUSHALL as a side effect. \n
- since: 3.0.0 \n
Parameters
subcommand: "RESET"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "RESET"
hard: "HARD"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "RESET"
soft: "SOFT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Forces the node to save cluster state on disk
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "SAVECONFIG"
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Set the configuration epoch in a new node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "SET-CONFIG-EPOCH"
configEpoch: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Bind a hash slot to a specific node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "SETSLOT"
slot: string | number
nodeIdToken: "IMPORTING"
nodeId: string | number | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "SETSLOT"
slot: string | number
nodeIdToken: "MIGRATING"
nodeId: string | number | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "SETSLOT"
slot: string | number
nodeIdToken: "NODE"
nodeId: string | number | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
subcommand: "SETSLOT"
slot: string | number
stable: "STABLE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Get array of cluster slots to node mappings
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of cluster nodes \n
- since: 7.0.0 \n
Parameters
subcommand: "SHARDS"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
List replica nodes of the specified master node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "SLAVES"
nodeId: string | number | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Get array of Cluster slot to node mappings
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of Cluster nodes \n
- since: 3.0.0 \n
Parameters
subcommand: "SLOTS"
Optional callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Returns Promise<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
command
- command(subcommand: "COUNT", callback?: Callback<unknown[]>): Promise<unknown[]>
- command(subcommand: "DOCS", callback?: Callback<unknown[]>): Promise<unknown[]>
- command(...args: [subcommand: "DOCS", ...commandNames: (string | Buffer)[], callback: Callback<unknown[]>]): Promise<unknown[]>
- command(...args: [subcommand: "DOCS", ...commandNames: (string | Buffer)[]]): Promise<unknown[]>
- command(subcommand: "GETKEYS", callback?: Callback<unknown[]>): Promise<unknown[]>
- command(subcommand: "GETKEYSANDFLAGS", callback?: Callback<unknown[]>): Promise<unknown[]>
- command(subcommand: "HELP", callback?: Callback<unknown[]>): Promise<unknown[]>
- command(subcommand: "INFO", callback?: Callback<unknown[]>): Promise<unknown[]>
- command(...args: [subcommand: "INFO", ...commandNames: (string | Buffer)[], callback: Callback<unknown[]>]): Promise<unknown[]>
- command(...args: [subcommand: "INFO", ...commandNames: (string | Buffer)[]]): Promise<unknown[]>
- command(subcommand: "LIST", callback?: Callback<unknown[]>): Promise<unknown[]>
- command(subcommand: "LIST", filterby: "FILTERBY", moduleNameToken: "MODULE", moduleName: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- command(subcommand: "LIST", filterby: "FILTERBY", categoryToken: "ACLCAT", category: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- command(subcommand: "LIST", filterby: "FILTERBY", patternToken: "PATTERN", pattern: string, callback?: Callback<unknown[]>): Promise<unknown[]>
- \n
Get total number of Redis commands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "COUNT"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Get array of specific Redis command documentation
\n- \n
- group: server \n
- complexity: O(N) where N is the number of commands to look up \n
- since: 7.0.0 \n
Parameters
subcommand: "DOCS"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
Rest ...args: [subcommand: "DOCS", ...commandNames: (string | Buffer)[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [subcommand: "DOCS", ...commandNames: (string | Buffer)[]]
Returns Promise<unknown[]>
- \n
Extract keys given a full Redis command
\n- \n
- group: server \n
- complexity: O(N) where N is the number of arguments to the command \n
- since: 2.8.13 \n
Parameters
subcommand: "GETKEYS"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Extract keys and access flags given a full Redis command
\n- \n
- group: server \n
- complexity: O(N) where N is the number of arguments to the command \n
- since: 7.0.0 \n
Parameters
subcommand: "GETKEYSANDFLAGS"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Show helpful text about the different subcommands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Get array of specific Redis command details, or all when no argument is given.
\n- \n
- group: server \n
- complexity: O(N) where N is the number of commands to look up \n
- since: 2.8.13 \n
Parameters
subcommand: "INFO"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
Rest ...args: [subcommand: "INFO", ...commandNames: (string | Buffer)[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [subcommand: "INFO", ...commandNames: (string | Buffer)[]]
Returns Promise<unknown[]>
- \n
Get an array of Redis command names
\n- \n
- group: server \n
- complexity: O(N) where N is the total number of Redis commands \n
- since: 7.0.0 \n
Parameters
subcommand: "LIST"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
subcommand: "LIST"
filterby: "FILTERBY"
moduleNameToken: "MODULE"
moduleName: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
subcommand: "LIST"
filterby: "FILTERBY"
categoryToken: "ACLCAT"
category: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
subcommand: "LIST"
filterby: "FILTERBY"
patternToken: "PATTERN"
pattern: string
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
config
- config(...args: [subcommand: "GET", ...parameters: (string | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- config(...args: [subcommand: "GET", ...parameters: (string | Buffer)[]]): Promise<unknown>
- config(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- config(subcommand: "RESETSTAT", callback?: Callback<unknown>): Promise<unknown>
- config(subcommand: "REWRITE", callback?: Callback<unknown>): Promise<unknown>
- config(...args: [subcommand: "SET", ...parameterValues: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- config(...args: [subcommand: "SET", ...parameterValues: (string | number | Buffer)[]]): Promise<unknown>
- \n
Get the values of configuration parameters
\n- \n
- group: server \n
- complexity: O(N) when N is the number of configuration parameters provided \n
- since: 2.0.0 \n
Parameters
Rest ...args: [subcommand: "GET", ...parameters: (string | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "GET", ...parameters: (string | Buffer)[]]
Returns Promise<unknown>
- \n
Show helpful text about the different subcommands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Reset the stats returned by INFO
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
subcommand: "RESETSTAT"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Rewrite the configuration file with the in memory configuration
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.0 \n
Parameters
subcommand: "REWRITE"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Set configuration parameters to the given values
\n- \n
- group: server \n
- complexity: O(N) when N is the number of configuration parameters provided \n
- since: 2.0.0 \n
Parameters
Rest ...args: [subcommand: "SET", ...parameterValues: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "SET", ...parameterValues: (string | number | Buffer)[]]
Returns Promise<unknown>
connect
- connect(callback?: Callback<void>): Promise<void>
- \n
Create a connection to Redis.\nThis method will be invoked automatically when creating a new Redis instance\nunless
\nlazyConnect: trueis passed.When calling this method manually, a Promise is returned, which will\nbe resolved when the connection status is ready. The promise can reject\nif the connection fails, times out, or if Redis is already connecting/connected.
\nParameters
Optional callback: Callback<void>
Returns Promise<void>
copy
- copy(source: RedisKey, destination: RedisKey, callback?: Callback<number>): Promise<number>
- copy(source: RedisKey, destination: RedisKey, replace: "REPLACE", callback?: Callback<number>): Promise<number>
- copy(source: RedisKey, destination: RedisKey, destinationDbToken: "DB", destinationDb: string | number, callback?: Callback<number>): Promise<number>
- copy(source: RedisKey, destination: RedisKey, destinationDbToken: "DB", destinationDb: string | number, replace: "REPLACE", callback?: Callback<number>): Promise<number>
- \n
Copy a key
\n- \n
- group: generic \n
- complexity: O(N) worst case for collections, where N is the number of nested items. O(1) for string values. \n
- since: 6.2.0 \n
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
source: RedisKey
destination: RedisKey
destinationDbToken: "DB"
destinationDb: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
source: RedisKey
destination: RedisKey
destinationDbToken: "DB"
destinationDb: string | number
replace: "REPLACE"
Optional callback: Callback<number>
Returns Promise<number>
create
- create
Builtin Command(commandName: string): { buffer: any; string: any }
- \n
Create a builtin command
\nParameters
commandName: string
Returns { buffer: any; string: any }
buffer: any
string: any
dbsize
- dbsize(callback?: Callback<number>): Promise<number>
- \n
Return the number of keys in the selected database
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<number>
Returns Promise<number>
debug
- debug(subcommand: string, callback?: Callback<unknown>): Promise<unknown>
- debug(...args: [subcommand: string, ...args: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- debug(...args: [subcommand: string, ...args: (string | number | Buffer)[]]): Promise<unknown>
- \n
A container for debugging commands
\n- \n
- group: server \n
- complexity: Depends on subcommand. \n
- since: 1.0.0 \n
Parameters
subcommand: string
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: string, ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: string, ...args: (string | number | Buffer)[]]
Returns Promise<unknown>
decr
- decr(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Decrement the integer value of a key by one
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
decrby
- decrby(key: RedisKey, decrement: string | number, callback?: Callback<number>): Promise<number>
- \n
Decrement the integer value of a key by the given number
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
decrement: string | number
Optional callback: Callback<number>
Returns Promise<number>
define
- define
Command(name: string, definition: { lua: string; numberOfKeys?: number; readOnly?: boolean }): void
- \n
Define a custom command using lua script
\nParameters
name: string
definition: { lua: string; numberOfKeys?: number; readOnly?: boolean }
lua: string
Optional number
Of Keys?: number Optional read
Only?: boolean
Returns void
del
- del(...args: [...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- del(...args: [keys: RedisKey[], callback: Callback<number>]): Promise<number>
- del(...args: RedisKey[]): Promise<number>
- del(...args: [keys: RedisKey[]]): Promise<number>
- \n
Delete a key
\n- \n
- group: generic \n
- complexity: O(N) where N is the number of keys that will be removed. When a key to remove holds a value other than a string, the individual complexity for this key is O(M) where M is the number of elements in the list, set, sorted set or hash. Removing a single key that holds a string value is O(1). \n
- since: 1.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: RedisKey[]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<number>
discard
- discard(callback?: Callback<"OK">): Promise<"OK">
- \n
Discard all commands issued after MULTI
\n- \n
- group: transactions \n
- complexity: O(N), when N is the number of queued commands \n
- since: 2.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
disconnect
- disconnect(reconnect?: boolean): void
- \n
Disconnect from Redis.
\nThis method closes the connection immediately,\nand may lose some pending replies that haven't written to client.\nIf you want to wait for the pending replies, use Redis#quit instead.
\nParameters
reconnect: boolean = false
Returns void
dump
- dump(key: RedisKey, callback?: Callback<string>): Promise<string>
- \n
Return a serialized version of the value stored at the specified key.
\n- \n
- group: generic \n
- complexity: O(1) to access the key and additional O(NM) to serialize it, where N is the number of Redis objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1M) where M is small, so simply O(1). \n
- since: 2.6.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
dump
- dump
Buffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
duplicate
- duplicate(override?: Partial<RedisOptions>): Redis
- \n
Create a new instance with the same options as the current one.
\nParameters
Optional override: Partial<RedisOptions>
Returns Redis
echo
- echo(message: string | Buffer, callback?: Callback<string>): Promise<string>
- \n
Echo the given string
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
message: string | Buffer
Optional callback: Callback<string>
Returns Promise<string>
echo
- echo
Buffer(message: string | Buffer, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
message: string | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
end
- end(): void
- \n
Disconnect from Redis.
\nReturns void
eval
- eval(script: string | Buffer, numkeys: string | number, callback?: Callback<unknown>): Promise<unknown>
- eval(...args: [script: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- eval(...args: [script: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[]]): Promise<unknown>
- eval(...args: [script: string | Buffer, numkeys: string | number, ...keys: RedisKey[], callback: Callback<unknown>]): Promise<unknown>
- eval(...args: [script: string | Buffer, numkeys: string | number, keys: RedisKey[], callback: Callback<unknown>]): Promise<unknown>
- eval(...args: [script: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]): Promise<unknown>
- eval(...args: [script: string | Buffer, numkeys: string | number, keys: RedisKey[]]): Promise<unknown>
- eval(...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown>
- eval(...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[]]): Promise<unknown>
- \n
Execute a Lua script server side
\n- \n
- group: scripting \n
- complexity: Depends on the script that is executed. \n
- since: 2.6.0 \n
Parameters
script: string | Buffer
numkeys: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[]]
Returns Promise<unknown>
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...keys: RedisKey[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, keys: RedisKey[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<unknown>
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, keys: RedisKey[]]
Returns Promise<unknown>
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
eval_
- eval_
ro(...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown> - eval_
ro(...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[]]): Promise<unknown>
- \n
Execute a read-only Lua script server side
\n- \n
- group: scripting \n
- complexity: Depends on the script that is executed. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
evalsha
- evalsha(sha1: string | Buffer, numkeys: string | number, callback?: Callback<unknown>): Promise<unknown>
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[]]): Promise<unknown>
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, ...keys: RedisKey[], callback: Callback<unknown>]): Promise<unknown>
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, keys: RedisKey[], callback: Callback<unknown>]): Promise<unknown>
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]): Promise<unknown>
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, keys: RedisKey[]]): Promise<unknown>
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown>
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[]]): Promise<unknown>
- \n
Execute a Lua script server side
\n- \n
- group: scripting \n
- complexity: Depends on the script that is executed. \n
- since: 2.6.0 \n
Parameters
sha1: string | Buffer
numkeys: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[]]
Returns Promise<unknown>
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...keys: RedisKey[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, keys: RedisKey[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<unknown>
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, keys: RedisKey[]]
Returns Promise<unknown>
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
evalsha_
- evalsha_
ro(...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown> - evalsha_
ro(...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[]]): Promise<unknown>
- \n
Execute a read-only Lua script server side
\n- \n
- group: scripting \n
- complexity: Depends on the script that is executed. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
exec
- exec(callback?: Callback<[error: Error, result: unknown][]>): Promise<[error: Error, result: unknown][]>
- \n
Execute all commands issued after MULTI
\n- \n
- group: transactions \n
- complexity: Depends on commands in the transaction \n
- since: 1.2.0 \n
Parameters
Optional callback: Callback<[error: Error, result: unknown][]>
Returns Promise<[error: Error, result: unknown][]>
exists
- exists(...args: [...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- exists(...args: [keys: RedisKey[], callback: Callback<number>]): Promise<number>
- exists(...args: RedisKey[]): Promise<number>
- exists(...args: [keys: RedisKey[]]): Promise<number>
- \n
Determine if a key exists
\n- \n
- group: generic \n
- complexity: O(N) where N is the number of keys to check. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: RedisKey[]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<number>
expire
- expire(key: RedisKey, seconds: string | number, callback?: Callback<number>): Promise<number>
- expire(key: RedisKey, seconds: string | number, nx: "NX", callback?: Callback<number>): Promise<number>
- expire(key: RedisKey, seconds: string | number, xx: "XX", callback?: Callback<number>): Promise<number>
- expire(key: RedisKey, seconds: string | number, gt: "GT", callback?: Callback<number>): Promise<number>
- expire(key: RedisKey, seconds: string | number, lt: "LT", callback?: Callback<number>): Promise<number>
- \n
Set a key's time to live in seconds
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
seconds: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
seconds: string | number
nx: "NX"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
seconds: string | number
xx: "XX"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
seconds: string | number
gt: "GT"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
seconds: string | number
lt: "LT"
Optional callback: Callback<number>
Returns Promise<number>
expireat
- expireat(key: RedisKey, unixTimeSeconds: string | number, callback?: Callback<number>): Promise<number>
- expireat(key: RedisKey, unixTimeSeconds: string | number, nx: "NX", callback?: Callback<number>): Promise<number>
- expireat(key: RedisKey, unixTimeSeconds: string | number, xx: "XX", callback?: Callback<number>): Promise<number>
- expireat(key: RedisKey, unixTimeSeconds: string | number, gt: "GT", callback?: Callback<number>): Promise<number>
- expireat(key: RedisKey, unixTimeSeconds: string | number, lt: "LT", callback?: Callback<number>): Promise<number>
- \n
Set the expiration for a key as a UNIX timestamp
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.2.0 \n
Parameters
key: RedisKey
unixTimeSeconds: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
unixTimeSeconds: string | number
nx: "NX"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
unixTimeSeconds: string | number
xx: "XX"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
unixTimeSeconds: string | number
gt: "GT"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
unixTimeSeconds: string | number
lt: "LT"
Optional callback: Callback<number>
Returns Promise<number>
expiretime
- expiretime(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Get the expiration Unix timestamp for a key
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
failover
- failover(callback?: Callback<"OK">): Promise<"OK">
- failover(millisecondsToken: "TIMEOUT", milliseconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- failover(abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- failover(abort: "ABORT", millisecondsToken: "TIMEOUT", milliseconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- failover(targetToken: "TO", host: string | Buffer, port: string | number, callback?: Callback<"OK">): Promise<"OK">
- failover(targetToken: "TO", host: string | Buffer, port: string | number, millisecondsToken: "TIMEOUT", milliseconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- failover(targetToken: "TO", host: string | Buffer, port: string | number, abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- failover(targetToken: "TO", host: string | Buffer, port: string | number, abort: "ABORT", millisecondsToken: "TIMEOUT", milliseconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- failover(targetToken: "TO", host: string | Buffer, port: string | number, force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
- failover(targetToken: "TO", host: string | Buffer, port: string | number, force: "FORCE", millisecondsToken: "TIMEOUT", milliseconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- failover(targetToken: "TO", host: string | Buffer, port: string | number, force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- failover(targetToken: "TO", host: string | Buffer, port: string | number, force: "FORCE", abort: "ABORT", millisecondsToken: "TIMEOUT", milliseconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- \n
Start a coordinated failover between this server and one of its replicas.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
millisecondsToken: "TIMEOUT"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
abort: "ABORT"
millisecondsToken: "TIMEOUT"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
millisecondsToken: "TIMEOUT"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
abort: "ABORT"
millisecondsToken: "TIMEOUT"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
force: "FORCE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
force: "FORCE"
millisecondsToken: "TIMEOUT"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
force: "FORCE"
abort: "ABORT"
millisecondsToken: "TIMEOUT"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
fcall
- fcall(...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown>
- fcall(...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[]]): Promise<unknown>
- \n
Invoke a function
\n- \n
- group: scripting \n
- complexity: Depends on the function that is executed. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
fcall_
- fcall_
ro(...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown> - fcall_
ro(...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[]]): Promise<unknown>
- \n
Invoke a read-only function
\n- \n
- group: scripting \n
- complexity: Depends on the function that is executed. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
flushall
- flushall(callback?: Callback<"OK">): Promise<"OK">
- flushall(async: "ASYNC", callback?: Callback<"OK">): Promise<"OK">
- flushall(sync: "SYNC", callback?: Callback<"OK">): Promise<"OK">
- \n
Remove all keys from all databases
\n- \n
- group: server \n
- complexity: O(N) where N is the total number of keys in all databases \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
async: "ASYNC"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
sync: "SYNC"
Optional callback: Callback<"OK">
Returns Promise<"OK">
flushdb
- flushdb(callback?: Callback<"OK">): Promise<"OK">
- flushdb(async: "ASYNC", callback?: Callback<"OK">): Promise<"OK">
- flushdb(sync: "SYNC", callback?: Callback<"OK">): Promise<"OK">
- \n
Remove all keys from the current database
\n- \n
- group: server \n
- complexity: O(N) where N is the number of keys in the selected database \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
async: "ASYNC"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
sync: "SYNC"
Optional callback: Callback<"OK">
Returns Promise<"OK">
function
- function(subcommand: "DELETE", libraryName: string | Buffer, callback?: Callback<string>): Promise<string>
- function(subcommand: "DUMP", callback?: Callback<string>): Promise<string>
- function(subcommand: "FLUSH", callback?: Callback<string>): Promise<string>
- function(subcommand: "FLUSH", async: "ASYNC", callback?: Callback<string>): Promise<string>
- function(subcommand: "FLUSH", sync: "SYNC", callback?: Callback<string>): Promise<string>
- function(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- function(subcommand: "KILL", callback?: Callback<string>): Promise<string>
- function(subcommand: "LIST", callback?: Callback<unknown[]>): Promise<unknown[]>
- function(subcommand: "LIST", withcode: "WITHCODE", callback?: Callback<unknown[]>): Promise<unknown[]>
- function(subcommand: "LIST", libraryNamePatternToken: "LIBRARYNAME", libraryNamePattern: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- function(subcommand: "LIST", libraryNamePatternToken: "LIBRARYNAME", libraryNamePattern: string | Buffer, withcode: "WITHCODE", callback?: Callback<unknown[]>): Promise<unknown[]>
- function(subcommand: "LOAD", functionCode: string | Buffer, callback?: Callback<string>): Promise<string>
- function(subcommand: "LOAD", replace: "REPLACE", functionCode: string | Buffer, callback?: Callback<string>): Promise<string>
- function(subcommand: "RESTORE", serializedValue: string | number | Buffer, callback?: Callback<string>): Promise<string>
- function(subcommand: "RESTORE", serializedValue: string | number | Buffer, flush: "FLUSH", callback?: Callback<string>): Promise<string>
- function(subcommand: "RESTORE", serializedValue: string | number | Buffer, append: "APPEND", callback?: Callback<string>): Promise<string>
- function(subcommand: "RESTORE", serializedValue: string | number | Buffer, replace: "REPLACE", callback?: Callback<string>): Promise<string>
- function(subcommand: "STATS", callback?: Callback<unknown>): Promise<unknown>
- \n
Delete a function by name
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
subcommand: "DELETE"
libraryName: string | Buffer
Optional callback: Callback<string>
Returns Promise<string>
- \n
Dump all functions into a serialized binary payload
\n- \n
- group: scripting \n
- complexity: O(N) where N is the number of functions \n
- since: 7.0.0 \n
Parameters
subcommand: "DUMP"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Deleting all functions
\n- \n
- group: scripting \n
- complexity: O(N) where N is the number of functions deleted \n
- since: 7.0.0 \n
Parameters
subcommand: "FLUSH"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
subcommand: "FLUSH"
async: "ASYNC"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
subcommand: "FLUSH"
sync: "SYNC"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Show helpful text about the different subcommands
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Kill the function currently in execution.
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
subcommand: "KILL"
Optional callback: Callback<string>
Returns Promise<string>
- \n
List information about all the functions
\n- \n
- group: scripting \n
- complexity: O(N) where N is the number of functions \n
- since: 7.0.0 \n
Parameters
subcommand: "LIST"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
subcommand: "LIST"
withcode: "WITHCODE"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
subcommand: "LIST"
libraryNamePatternToken: "LIBRARYNAME"
libraryNamePattern: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
subcommand: "LIST"
libraryNamePatternToken: "LIBRARYNAME"
libraryNamePattern: string | Buffer
withcode: "WITHCODE"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Create a function with the given arguments (name, code, description)
\n- \n
- group: scripting \n
- complexity: O(1) (considering compilation time is redundant) \n
- since: 7.0.0 \n
Parameters
subcommand: "LOAD"
functionCode: string | Buffer
Optional callback: Callback<string>
Returns Promise<string>
Parameters
subcommand: "LOAD"
replace: "REPLACE"
functionCode: string | Buffer
Optional callback: Callback<string>
Returns Promise<string>
- \n
Restore all the functions on the given payload
\n- \n
- group: scripting \n
- complexity: O(N) where N is the number of functions on the payload \n
- since: 7.0.0 \n
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
Optional callback: Callback<string>
Returns Promise<string>
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
flush: "FLUSH"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
append: "APPEND"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
replace: "REPLACE"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Return information about the function currently running (name, description, duration)
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
subcommand: "STATS"
Optional callback: Callback<unknown>
Returns Promise<unknown>
function
- function
Buffer(subcommand: "DELETE", libraryName: string | Buffer, callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "DUMP", callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "FLUSH", callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "FLUSH", async: "ASYNC", callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "FLUSH", sync: "SYNC", callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "KILL", callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "LOAD", functionCode: string | Buffer, callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "LOAD", replace: "REPLACE", functionCode: string | Buffer, callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "RESTORE", serializedValue: string | number | Buffer, callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "RESTORE", serializedValue: string | number | Buffer, flush: "FLUSH", callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "RESTORE", serializedValue: string | number | Buffer, append: "APPEND", callback?: Callback<Buffer>): Promise<Buffer> - function
Buffer(subcommand: "RESTORE", serializedValue: string | number | Buffer, replace: "REPLACE", callback?: Callback<Buffer>): Promise<Buffer>
Parameters
subcommand: "DELETE"
libraryName: string | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "DUMP"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "FLUSH"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "FLUSH"
async: "ASYNC"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "FLUSH"
sync: "SYNC"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "KILL"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "LOAD"
functionCode: string | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "LOAD"
replace: "REPLACE"
functionCode: string | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
flush: "FLUSH"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
append: "APPEND"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
replace: "REPLACE"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
geoadd
- geoadd(...args: [key: RedisKey, ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- geoadd(...args: [key: RedisKey, ...longitudeLatitudeMembers: (string | number | Buffer)[]]): Promise<number>
- geoadd(...args: [key: RedisKey, ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- geoadd(...args: [key: RedisKey, ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[]]): Promise<number>
- geoadd(...args: [key: RedisKey, nx: "NX", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- geoadd(...args: [key: RedisKey, nx: "NX", ...longitudeLatitudeMembers: (string | number | Buffer)[]]): Promise<number>
- geoadd(...args: [key: RedisKey, nx: "NX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- geoadd(...args: [key: RedisKey, nx: "NX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[]]): Promise<number>
- geoadd(...args: [key: RedisKey, xx: "XX", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- geoadd(...args: [key: RedisKey, xx: "XX", ...longitudeLatitudeMembers: (string | number | Buffer)[]]): Promise<number>
- geoadd(...args: [key: RedisKey, xx: "XX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- geoadd(...args: [key: RedisKey, xx: "XX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[]]): Promise<number>
- \n
Add one or more geospatial items in the geospatial index represented using a sorted set
\n- \n
- group: geo \n
- complexity: O(log(N)) for each item added, where N is the number of elements in the sorted set. \n
- since: 3.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...longitudeLatitudeMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ...longitudeLatitudeMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ...longitudeLatitudeMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[]]
Returns Promise<number>
geodist
- geodist(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, callback?: Callback<string>): Promise<string>
- geodist(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, m: "M", callback?: Callback<string>): Promise<string>
- geodist(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, km: "KM", callback?: Callback<string>): Promise<string>
- geodist(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, ft: "FT", callback?: Callback<string>): Promise<string>
- geodist(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, mi: "MI", callback?: Callback<string>): Promise<string>
- \n
Returns the distance between two members of a geospatial index
\n- \n
- group: geo \n
- complexity: O(log(N)) \n
- since: 3.2.0 \n
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
m: "M"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
km: "KM"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
ft: "FT"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
mi: "MI"
Optional callback: Callback<string>
Returns Promise<string>
geodist
- geodist
Buffer(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, callback?: Callback<Buffer>): Promise<Buffer> - geodist
Buffer(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, m: "M", callback?: Callback<Buffer>): Promise<Buffer> - geodist
Buffer(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, km: "KM", callback?: Callback<Buffer>): Promise<Buffer> - geodist
Buffer(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, ft: "FT", callback?: Callback<Buffer>): Promise<Buffer> - geodist
Buffer(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, mi: "MI", callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
m: "M"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
km: "KM"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
ft: "FT"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
mi: "MI"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
geohash
- geohash(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- geohash(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- geohash(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): Promise<string[]>
- geohash(...args: [key: RedisKey, members: (string | number | Buffer)[]]): Promise<string[]>
- \n
Returns members of a geospatial index as standard geohash strings
\n- \n
- group: geo \n
- complexity: O(log(N)) for each member requested, where N is the number of elements in the sorted set. \n
- since: 3.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<string[]>
geohash
- geohash
Buffer(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - geohash
Buffer(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - geohash
Buffer(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): Promise<Buffer[]> - geohash
Buffer(...args: [key: RedisKey, members: (string | number | Buffer)[]]): Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<Buffer[]>
geopos
- geopos(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<[longitude: string, latitude: string][]>]): Promise<[longitude: string, latitude: string][]>
- geopos(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<[longitude: string, latitude: string][]>]): Promise<[longitude: string, latitude: string][]>
- geopos(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): Promise<[longitude: string, latitude: string][]>
- geopos(...args: [key: RedisKey, members: (string | number | Buffer)[]]): Promise<[longitude: string, latitude: string][]>
- \n
Returns longitude and latitude of members of a geospatial index
\n- \n
- group: geo \n
- complexity: O(N) where N is the number of members requested. \n
- since: 3.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<[longitude: string, latitude: string][]>]
Returns Promise<[longitude: string, latitude: string][]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<[longitude: string, latitude: string][]>]
Returns Promise<[longitude: string, latitude: string][]>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<[longitude: string, latitude: string][]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<[longitude: string, latitude: string][]>
georadius
- georadius(...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- georadius(...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[]]): Promise<unknown[]>
- \n
Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point
\n- \n
- group: geo \n
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index. \n
- since: 3.2.0 \n
Parameters
Rest ...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[]]
Returns Promise<unknown[]>
georadius_
- georadius_
ro(...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown> - georadius_
ro(...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[]]): Promise<unknown>
- \n
A read-only variant for GEORADIUS
\n- \n
- group: geo \n
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index. \n
- since: 3.2.10 \n
Parameters
Rest ...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
georadiusbymember
- georadiusbymember(...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown>
- georadiusbymember(...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[]]): Promise<unknown>
- \n
Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a member
\n- \n
- group: geo \n
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index. \n
- since: 3.2.0 \n
Parameters
Rest ...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
georadiusbymember_
- georadiusbymember_
ro(...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown> - georadiusbymember_
ro(...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[]]): Promise<unknown>
- \n
A read-only variant for GEORADIUSBYMEMBER
\n- \n
- group: geo \n
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index. \n
- since: 3.2.10 \n
Parameters
Rest ...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
geosearch
- geosearch(...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- geosearch(...args: [key: RedisKey, ...args: RedisValue[]]): Promise<unknown[]>
- \n
Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle.
\n- \n
- group: geo \n
- complexity: O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape \n
- since: 6.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[]]
Returns Promise<unknown[]>
geosearchstore
- geosearchstore(...args: [destination: RedisKey, source: RedisKey, ...args: RedisValue[], callback: Callback<number>]): Promise<number>
- geosearchstore(...args: [destination: RedisKey, source: RedisKey, ...args: RedisValue[]]): Promise<number>
- \n
Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle, and store the result in another key.
\n- \n
- group: geo \n
- complexity: O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape \n
- since: 6.2.0 \n
Parameters
Rest ...args: [destination: RedisKey, source: RedisKey, ...args: RedisValue[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, source: RedisKey, ...args: RedisValue[]]
Returns Promise<number>
get
- get(key: RedisKey, callback?: Callback<string>): Promise<string>
- \n
Get the value of a key
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
get
- get
Buffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
get
- get
Builtin Commands(): string[]
- \n
Return supported builtin commands
\nReturns string[]
getbit
- getbit(key: RedisKey, offset: string | number, callback?: Callback<number>): Promise<number>
- \n
Returns the bit value at offset in the string value stored at key
\n- \n
- group: bitmap \n
- complexity: O(1) \n
- since: 2.2.0 \n
Parameters
key: RedisKey
offset: string | number
Optional callback: Callback<number>
Returns Promise<number>
getdel
- getdel(key: RedisKey, callback?: Callback<string>): Promise<string>
- \n
Get the value of a key and delete the key
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
getdel
- getdel
Buffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
getex
- getex(key: RedisKey, callback?: Callback<string>): Promise<string>
- getex(key: RedisKey, secondsToken: "EX", seconds: string | number, callback?: Callback<string>): Promise<string>
- getex(key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, callback?: Callback<string>): Promise<string>
- getex(key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, callback?: Callback<string>): Promise<string>
- getex(key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, callback?: Callback<string>): Promise<string>
- getex(key: RedisKey, persist: "PERSIST", callback?: Callback<string>): Promise<string>
- \n
Get the value of a key and optionally set its expiration
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
secondsToken: "EX"
seconds: string | number
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
millisecondsToken: "PX"
milliseconds: string | number
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
persist: "PERSIST"
Optional callback: Callback<string>
Returns Promise<string>
getex
- getex
Buffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer> - getex
Buffer(key: RedisKey, secondsToken: "EX", seconds: string | number, callback?: Callback<Buffer>): Promise<Buffer> - getex
Buffer(key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, callback?: Callback<Buffer>): Promise<Buffer> - getex
Buffer(key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, callback?: Callback<Buffer>): Promise<Buffer> - getex
Buffer(key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, callback?: Callback<Buffer>): Promise<Buffer> - getex
Buffer(key: RedisKey, persist: "PERSIST", callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
secondsToken: "EX"
seconds: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
millisecondsToken: "PX"
milliseconds: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
persist: "PERSIST"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
getrange
- getrange(key: RedisKey, start: string | number, end: string | number, callback?: Callback<string>): Promise<string>
- \n
Get a substring of the string stored at a key
\n- \n
- group: string \n
- complexity: O(N) where N is the length of the returned string. The complexity is ultimately determined by the returned length, but because creating a substring from an existing string is very cheap, it can be considered O(1) for small strings. \n
- since: 2.4.0 \n
Parameters
key: RedisKey
start: string | number
end: string | number
Optional callback: Callback<string>
Returns Promise<string>
getrange
- getrange
Buffer(key: RedisKey, start: string | number, end: string | number, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
start: string | number
end: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
getset
- getset(key: RedisKey, value: string | number | Buffer, callback?: Callback<string>): Promise<string>
- \n
Set the string value of a key and return its old value
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
value: string | number | Buffer
Optional callback: Callback<string>
Returns Promise<string>
getset
- getset
Buffer(key: RedisKey, value: string | number | Buffer, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
hdel
- hdel(...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<number>]): Promise<number>
- hdel(...args: [key: RedisKey, ...fields: (string | Buffer)[]]): Promise<number>
- \n
Delete one or more hash fields
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of fields to be removed. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...fields: (string | Buffer)[]]
Returns Promise<number>
hello
- hello(callback?: Callback<unknown[]>): Promise<unknown[]>
- hello(protover: string | number, callback?: Callback<unknown[]>): Promise<unknown[]>
- hello(protover: string | number, clientnameToken: "SETNAME", clientname: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- hello(protover: string | number, usernamePasswordToken: "AUTH", username: string | Buffer, password: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- hello(protover: string | number, usernamePasswordToken: "AUTH", username: string | Buffer, password: string | Buffer, clientnameToken: "SETNAME", clientname: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- \n
Handshake with Redis
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 6.0.0 \n
Parameters
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
protover: string | number
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
protover: string | number
clientnameToken: "SETNAME"
clientname: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
protover: string | number
usernamePasswordToken: "AUTH"
username: string | Buffer
password: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
protover: string | number
usernamePasswordToken: "AUTH"
username: string | Buffer
password: string | Buffer
clientnameToken: "SETNAME"
clientname: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
hexists
- hexists(key: RedisKey, field: string | Buffer, callback?: Callback<number>): Promise<number>
- \n
Determine if a hash field exists
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
field: string | Buffer
Optional callback: Callback<number>
Returns Promise<number>
hexpire
- hexpire(...args: [key: RedisKey, seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpire(...args: [key: RedisKey, seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hexpire(...args: [key: RedisKey, seconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpire(...args: [key: RedisKey, seconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hexpire(...args: [key: RedisKey, seconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpire(...args: [key: RedisKey, seconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hexpire(...args: [key: RedisKey, seconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpire(...args: [key: RedisKey, seconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hexpire(...args: [key: RedisKey, seconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpire(...args: [key: RedisKey, seconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- \n
Set expiry for hash field using relative time to expire (seconds)
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
hexpireat
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- \n
Set expiry for hash field using an absolute Unix timestamp (seconds)
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
hexpiretime
- hexpiretime(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hexpiretime(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- \n
Returns the expiration time of a hash field as a Unix timestamp, in seconds.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
hget
- hget(key: RedisKey, field: string | Buffer, callback?: Callback<string>): Promise<string>
- \n
Get the value of a hash field
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
field: string | Buffer
Optional callback: Callback<string>
Returns Promise<string>
hget
- hget
Buffer(key: RedisKey, field: string | Buffer, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
field: string | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
hgetall
- hgetall(key: RedisKey, callback?: Callback<Record<string, string>>): Promise<Record<string, string>>
- \n
Get all the fields and values in a hash
\n- \n
- group: hash \n
- complexity: O(N) where N is the size of the hash. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<Record<string, string>>
Returns Promise<Record<string, string>>
hgetall
- hgetall
Buffer(key: RedisKey, callback?: Callback<Record<string, Buffer>>): Promise<Record<string, Buffer>>
Parameters
key: RedisKey
Optional callback: Callback<Record<string, Buffer>>
Returns Promise<Record<string, Buffer>>
hgetdel
- hgetdel(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- hgetdel(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<string[]>
- \n
Returns the value of a field and deletes it from the hash.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 8.0.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<string[]>
hgetdel
- hgetdel
Buffer(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - hgetdel
Buffer(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<Buffer[]>
hgetex
- hgetex(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- hgetex(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<string[]>
- hgetex(...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- hgetex(...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<string[]>
- hgetex(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- hgetex(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<string[]>
- hgetex(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- hgetex(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<string[]>
- hgetex(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- hgetex(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<string[]>
- hgetex(...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- hgetex(...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<string[]>
- \n
Get the value of one or more fields of a given hash key, and optionally set their expiration.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 8.0.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<string[]>
hgetex
- hgetex
Buffer(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - hgetex
Buffer(...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<Buffer[]>
hincrby
- hincrby(key: RedisKey, field: string | Buffer, increment: string | number, callback?: Callback<number>): Promise<number>
- \n
Increment the integer value of a hash field by the given number
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
field: string | Buffer
increment: string | number
Optional callback: Callback<number>
Returns Promise<number>
hincrbyfloat
- hincrbyfloat(key: RedisKey, field: string | Buffer, increment: string | number, callback?: Callback<string>): Promise<string>
- \n
Increment the float value of a hash field by the given amount
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
field: string | Buffer
increment: string | number
Optional callback: Callback<string>
Returns Promise<string>
hincrbyfloat
- hincrbyfloat
Buffer(key: RedisKey, field: string | Buffer, increment: string | number, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
field: string | Buffer
increment: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
hkeys
- hkeys(key: RedisKey, callback?: Callback<string[]>): Promise<string[]>
- \n
Get all the fields in a hash
\n- \n
- group: hash \n
- complexity: O(N) where N is the size of the hash. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string[]>
Returns Promise<string[]>
hkeys
- hkeys
Buffer(key: RedisKey, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
hlen
- hlen(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Get the number of fields in a hash
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
hmget
- hmget(...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- hmget(...args: [key: RedisKey, ...fields: (string | Buffer)[]]): Promise<string[]>
- \n
Get the values of all the given hash fields
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of fields being requested. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, ...fields: (string | Buffer)[]]
Returns Promise<string[]>
hmget
hmset
- hmset(key: RedisKey, object: object, callback?: Callback<"OK">): Promise<"OK">
- hmset(key: RedisKey, map: Map<string | number | Buffer, string | number | Buffer>, callback?: Callback<"OK">): Promise<"OK">
- hmset(...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[], callback: Callback<"OK">]): Promise<"OK">
- hmset(...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[]]): Promise<"OK">
- \n
Set multiple hash fields to multiple values
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of fields being set. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
object: object
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
map: Map<string | number | Buffer, string | number | Buffer>
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
Rest ...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[], callback: Callback<"OK">]
Returns Promise<"OK">
Parameters
Rest ...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[]]
Returns Promise<"OK">
hpersist
- hpersist(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpersist(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- \n
Removes the expiration time for each specified field
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
hpexpire
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- \n
Set expiry for hash field using relative time to expire (milliseconds)
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
hpexpireat
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- \n
Set expiry for hash field using an absolute Unix timestamp (milliseconds)
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
hpexpiretime
- hpexpiretime(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpexpiretime(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- \n
Returns the expiration time of a hash field as a Unix timestamp, in msec.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
hpttl
- hpttl(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- hpttl(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- \n
Returns the TTL in milliseconds of a hash field.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
hrandfield
- hrandfield(key: RedisKey, callback?: Callback<string | unknown[]>): Promise<string | unknown[]>
- hrandfield(key: RedisKey, count: string | number, callback?: Callback<string | unknown[]>): Promise<string | unknown[]>
- hrandfield(key: RedisKey, count: string | number, withvalues: "WITHVALUES", callback?: Callback<string | unknown[]>): Promise<string | unknown[]>
- \n
Get one or multiple random fields from a hash
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of fields returned \n
- since: 6.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string | unknown[]>
Returns Promise<string | unknown[]>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string | unknown[]>
Returns Promise<string | unknown[]>
Parameters
key: RedisKey
count: string | number
withvalues: "WITHVALUES"
Optional callback: Callback<string | unknown[]>
Returns Promise<string | unknown[]>
hrandfield
- hrandfield
Buffer(key: RedisKey, callback?: Callback<unknown[] | Buffer>): Promise<unknown[] | Buffer> - hrandfield
Buffer(key: RedisKey, count: string | number, callback?: Callback<unknown[] | Buffer>): Promise<unknown[] | Buffer> - hrandfield
Buffer(key: RedisKey, count: string | number, withvalues: "WITHVALUES", callback?: Callback<unknown[] | Buffer>): Promise<unknown[] | Buffer>
Parameters
key: RedisKey
Optional callback: Callback<unknown[] | Buffer>
Returns Promise<unknown[] | Buffer>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<unknown[] | Buffer>
Returns Promise<unknown[] | Buffer>
Parameters
key: RedisKey
count: string | number
withvalues: "WITHVALUES"
Optional callback: Callback<unknown[] | Buffer>
Returns Promise<unknown[] | Buffer>
hscan
- hscan(key: RedisKey, cursor: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- hscan(key: RedisKey, cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- hscan(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- hscan(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- \n
Incrementally iterate hash fields and associated values
\n- \n
- group: hash \n
- complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.. \n
- since: 2.8.0 \n
Parameters
key: RedisKey
cursor: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
key: RedisKey
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
hscan
- hscan
Buffer(key: RedisKey, cursor: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - hscan
Buffer(key: RedisKey, cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - hscan
Buffer(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - hscan
Buffer(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
hscan
- hscan
Buffer Stream(key: string, options?: ScanStreamOptions): default
Parameters
key: string
Optional options: ScanStreamOptions
Returns default
hscan
- hscan
Stream(key: string, options?: ScanStreamOptions): default
Parameters
key: string
Optional options: ScanStreamOptions
Returns default
hset
- hset(key: RedisKey, object: object, callback?: Callback<number>): Promise<number>
- hset(key: RedisKey, map: Map<string | number | Buffer, string | number | Buffer>, callback?: Callback<number>): Promise<number>
- hset(...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hset(...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[]]): Promise<number>
- \n
Set the string value of a hash field
\n- \n
- group: hash \n
- complexity: O(1) for each field/value pair added, so O(N) to add N field/value pairs when the command is called with multiple field/value pairs. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
object: object
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
map: Map<string | number | Buffer, string | number | Buffer>
Optional callback: Callback<number>
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[]]
Returns Promise<number>
hsetex
- hsetex(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fnx: "FNX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- hsetex(...args: [key: RedisKey, fxx: "FXX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): Promise<number>
- \n
Set the value of one or more fields of a given hash key, and optionally set their expiration.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of fields being set. \n
- since: 8.0.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns Promise<number>
hsetnx
- hsetnx(key: RedisKey, field: string | Buffer, value: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Set the value of a hash field, only if the field does not exist
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
field: string | Buffer
value: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
hstrlen
- hstrlen(key: RedisKey, field: string | Buffer, callback?: Callback<number>): Promise<number>
- \n
Get the length of the value of a hash field
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 3.2.0 \n
Parameters
key: RedisKey
field: string | Buffer
Optional callback: Callback<number>
Returns Promise<number>
httl
- httl(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- httl(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): Promise<number[]>
- \n
Returns the TTL in seconds of a hash field.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns Promise<number[]>
hvals
- hvals(key: RedisKey, callback?: Callback<string[]>): Promise<string[]>
- \n
Get all the values in a hash
\n- \n
- group: hash \n
- complexity: O(N) where N is the size of the hash. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string[]>
Returns Promise<string[]>
hvals
- hvals
Buffer(key: RedisKey, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
incr
- incr(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Increment the integer value of a key by one
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
incrby
- incrby(key: RedisKey, increment: string | number, callback?: Callback<number>): Promise<number>
- \n
Increment the integer value of a key by the given amount
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
increment: string | number
Optional callback: Callback<number>
Returns Promise<number>
incrbyfloat
- incrbyfloat(key: RedisKey, increment: string | number, callback?: Callback<string>): Promise<string>
- \n
Increment the float value of a key by the given amount
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
increment: string | number
Optional callback: Callback<string>
Returns Promise<string>
info
- info(callback?: Callback<string>): Promise<string>
- info(...args: [...sections: (string | Buffer)[], callback: Callback<string>]): Promise<string>
- info(...args: (string | Buffer)[]): Promise<string>
- \n
Get information and statistics about the server
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<string>
Returns Promise<string>
Parameters
Rest ...args: [...sections: (string | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: (string | Buffer)[]
Returns Promise<string>
keys
- keys(pattern: string, callback?: Callback<string[]>): Promise<string[]>
- \n
Find all keys matching the given pattern
\n- \n
- group: generic \n
- complexity: O(N) with N being the number of keys in the database, under the assumption that the key names in the database and the given pattern have limited length. \n
- since: 1.0.0 \n
Parameters
pattern: string
Optional callback: Callback<string[]>
Returns Promise<string[]>
keys
- keys
Buffer(pattern: string, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
pattern: string
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
lastsave
- lastsave(callback?: Callback<number>): Promise<number>
- \n
Get the UNIX time stamp of the last successful save to disk
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<number>
Returns Promise<number>
latency
- latency(subcommand: "DOCTOR", callback?: Callback<string>): Promise<string>
- latency(subcommand: "GRAPH", event: string | Buffer, callback?: Callback<string>): Promise<string>
- latency(subcommand: "HELP", callback?: Callback<unknown[]>): Promise<unknown[]>
- latency(subcommand: "HISTOGRAM", callback?: Callback<unknown>): Promise<unknown>
- latency(...args: [subcommand: "HISTOGRAM", ...commands: (string | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- latency(...args: [subcommand: "HISTOGRAM", ...commands: (string | Buffer)[]]): Promise<unknown>
- latency(subcommand: "HISTORY", event: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- latency(subcommand: "LATEST", callback?: Callback<unknown[]>): Promise<unknown[]>
- latency(subcommand: "RESET", callback?: Callback<number>): Promise<number>
- latency(...args: [subcommand: "RESET", ...events: (string | Buffer)[], callback: Callback<number>]): Promise<number>
- latency(...args: [subcommand: "RESET", ...events: (string | Buffer)[]]): Promise<number>
- \n
Return a human readable latency analysis report.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "DOCTOR"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Return a latency graph for the event.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "GRAPH"
event: string | Buffer
Optional callback: Callback<string>
Returns Promise<string>
- \n
Show helpful text about the different subcommands.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Return the cumulative distribution of latencies of a subset of commands or all.
\n- \n
- group: server \n
- complexity: O(N) where N is the number of commands with latency information being retrieved. \n
- since: 7.0.0 \n
Parameters
subcommand: "HISTOGRAM"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "HISTOGRAM", ...commands: (string | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "HISTOGRAM", ...commands: (string | Buffer)[]]
Returns Promise<unknown>
- \n
Return timestamp-latency samples for the event.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "HISTORY"
event: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Return the latest latency samples for all events.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "LATEST"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Reset latency data for one or more events.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "RESET"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
Rest ...args: [subcommand: "RESET", ...events: (string | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [subcommand: "RESET", ...events: (string | Buffer)[]]
Returns Promise<number>
lcs
- lcs(key1: RedisKey, key2: RedisKey, callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, lenToken: "MINMATCHLEN", len: string | number, callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, lenToken: "MINMATCHLEN", len: string | number, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, idx: "IDX", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, idx: "IDX", withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, idx: "IDX", lenToken: "MINMATCHLEN", len: string | number, callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, idx: "IDX", lenToken: "MINMATCHLEN", len: string | number, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", lenToken: "MINMATCHLEN", len1: string | number, callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", lenToken: "MINMATCHLEN", len1: string | number, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", idx: "IDX", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", idx: "IDX", withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", idx: "IDX", lenToken: "MINMATCHLEN", len1: string | number, callback?: Callback<unknown>): Promise<unknown>
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", idx: "IDX", lenToken: "MINMATCHLEN", len1: string | number, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Promise<unknown>
- \n
Find longest common substring
\n- \n
- group: string \n
- complexity: O(N*M) where N and M are the lengths of s1 and s2, respectively \n
- since: 7.0.0 \n
Parameters
Returns Promise<unknown>
Parameters
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
lenToken: "MINMATCHLEN"
len: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
lenToken: "MINMATCHLEN"
len: string | number
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
idx: "IDX"
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
idx: "IDX"
lenToken: "MINMATCHLEN"
len: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
idx: "IDX"
lenToken: "MINMATCHLEN"
len: string | number
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
len: "LEN"
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
len: "LEN"
lenToken: "MINMATCHLEN"
len1: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
len: "LEN"
lenToken: "MINMATCHLEN"
len1: string | number
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
len: "LEN"
idx: "IDX"
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
len: "LEN"
idx: "IDX"
lenToken: "MINMATCHLEN"
len1: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key1: RedisKey
key2: RedisKey
len: "LEN"
idx: "IDX"
lenToken: "MINMATCHLEN"
len1: string | number
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns Promise<unknown>
lindex
- lindex(key: RedisKey, index: string | number, callback?: Callback<string>): Promise<string>
- \n
Get an element from a list by its index
\n- \n
- group: list \n
- complexity: O(N) where N is the number of elements to traverse to get to the element at index. This makes asking for the first or the last element of the list O(1). \n
- since: 1.0.0 \n
Parameters
key: RedisKey
index: string | number
Optional callback: Callback<string>
Returns Promise<string>
lindex
- lindex
Buffer(key: RedisKey, index: string | number, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
index: string | number
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
linsert
- linsert(key: RedisKey, before: "BEFORE", pivot: string | number | Buffer, element: string | number | Buffer, callback?: Callback<number>): Promise<number>
- linsert(key: RedisKey, after: "AFTER", pivot: string | number | Buffer, element: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Insert an element before or after another element in a list
\n- \n
- group: list \n
- complexity: O(N) where N is the number of elements to traverse before seeing the value pivot. This means that inserting somewhere on the left end on the list (head) can be considered O(1) and inserting somewhere on the right end (tail) is O(N). \n
- since: 2.2.0 \n
Parameters
key: RedisKey
before: "BEFORE"
pivot: string | number | Buffer
element: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
after: "AFTER"
pivot: string | number | Buffer
element: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
llen
- llen(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Get the length of a list
\n- \n
- group: list \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
lmove
- lmove(source: RedisKey, destination: RedisKey, left: "LEFT", left1: "LEFT", callback?: Callback<string>): Promise<string>
- lmove(source: RedisKey, destination: RedisKey, left: "LEFT", right: "RIGHT", callback?: Callback<string>): Promise<string>
- lmove(source: RedisKey, destination: RedisKey, right: "RIGHT", left: "LEFT", callback?: Callback<string>): Promise<string>
- lmove(source: RedisKey, destination: RedisKey, right: "RIGHT", right1: "RIGHT", callback?: Callback<string>): Promise<string>
- \n
Pop an element from a list, push it to another list and return it
\n- \n
- group: list \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
Returns Promise<string>
Parameters
Returns Promise<string>
Parameters
Returns Promise<string>
Parameters
source: RedisKey
destination: RedisKey
right: "RIGHT"
right1: "RIGHT"
Optional callback: Callback<string>
Returns Promise<string>
lmove
- lmove
Buffer(source: RedisKey, destination: RedisKey, left: "LEFT", left1: "LEFT", callback?: Callback<Buffer>): Promise<Buffer> - lmove
Buffer(source: RedisKey, destination: RedisKey, left: "LEFT", right: "RIGHT", callback?: Callback<Buffer>): Promise<Buffer> - lmove
Buffer(source: RedisKey, destination: RedisKey, right: "RIGHT", left: "LEFT", callback?: Callback<Buffer>): Promise<Buffer> - lmove
Buffer(source: RedisKey, destination: RedisKey, right: "RIGHT", right1: "RIGHT", callback?: Callback<Buffer>): Promise<Buffer>
lmpop
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT"]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT"]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): Promise<[key: string, members: string[]]>
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): Promise<[key: string, members: string[]]>
- \n
Pop elements from a list
\n- \n
- group: list \n
- complexity: O(N+M) where N is the number of provided keys and M is the number of elements returned. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns Promise<[key: string, members: string[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns Promise<[key: string, members: string[]]>
lmpop
- lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT"]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT"]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): Promise<[key: Buffer, members: Buffer[]]> - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns Promise<[key: Buffer, members: Buffer[]]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns Promise<[key: Buffer, members: Buffer[]]>
lolwut
- lolwut(callback?: Callback<string>): Promise<string>
- lolwut(versionToken: "VERSION", version: string | number, callback?: Callback<string>): Promise<string>
- \n
Display some computer art and the Redis version
\n- \n
- group: server \n
- complexity: undefined \n
- since: 5.0.0 \n
Parameters
Optional callback: Callback<string>
Returns Promise<string>
Parameters
versionToken: "VERSION"
version: string | number
Optional callback: Callback<string>
Returns Promise<string>
lpop
- lpop(key: RedisKey, callback?: Callback<string>): Promise<string>
- lpop(key: RedisKey, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Remove and get the first elements in a list
\n- \n
- group: list \n
- complexity: O(N) where N is the number of elements returned \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
lpop
lpos
- lpos(key: RedisKey, element: string | number | Buffer, callback?: Callback<number>): Promise<number>
- lpos(key: RedisKey, element: string | number | Buffer, lenToken: "MAXLEN", len: string | number, callback?: Callback<number>): Promise<number>
- lpos(key: RedisKey, element: string | number | Buffer, numMatchesToken: "COUNT", numMatches: string | number, callback?: Callback<number[]>): Promise<number[]>
- lpos(key: RedisKey, element: string | number | Buffer, numMatchesToken: "COUNT", numMatches: string | number, lenToken: "MAXLEN", len: string | number, callback?: Callback<number[]>): Promise<number[]>
- lpos(key: RedisKey, element: string | number | Buffer, rankToken: "RANK", rank: string | number, callback?: Callback<number>): Promise<number>
- lpos(key: RedisKey, element: string | number | Buffer, rankToken: "RANK", rank: string | number, lenToken: "MAXLEN", len: string | number, callback?: Callback<number>): Promise<number>
- lpos(key: RedisKey, element: string | number | Buffer, rankToken: "RANK", rank: string | number, numMatchesToken: "COUNT", numMatches: string | number, callback?: Callback<number[]>): Promise<number[]>
- lpos(key: RedisKey, element: string | number | Buffer, rankToken: "RANK", rank: string | number, numMatchesToken: "COUNT", numMatches: string | number, lenToken: "MAXLEN", len: string | number, callback?: Callback<number[]>): Promise<number[]>
- \n
Return the index of matching elements on a list
\n- \n
- group: list \n
- complexity: O(N) where N is the number of elements in the list, for the average case. When searching for elements near the head or the tail of the list, or when the MAXLEN option is provided, the command may run in constant time. \n
- since: 6.0.6 \n
Parameters
key: RedisKey
element: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
element: string | number | Buffer
lenToken: "MAXLEN"
len: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
element: string | number | Buffer
numMatchesToken: "COUNT"
numMatches: string | number
Optional callback: Callback<number[]>
Returns Promise<number[]>
Parameters
key: RedisKey
element: string | number | Buffer
numMatchesToken: "COUNT"
numMatches: string | number
lenToken: "MAXLEN"
len: string | number
Optional callback: Callback<number[]>
Returns Promise<number[]>
Parameters
key: RedisKey
element: string | number | Buffer
rankToken: "RANK"
rank: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
element: string | number | Buffer
rankToken: "RANK"
rank: string | number
lenToken: "MAXLEN"
len: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
element: string | number | Buffer
rankToken: "RANK"
rank: string | number
numMatchesToken: "COUNT"
numMatches: string | number
Optional callback: Callback<number[]>
Returns Promise<number[]>
Parameters
key: RedisKey
element: string | number | Buffer
rankToken: "RANK"
rank: string | number
numMatchesToken: "COUNT"
numMatches: string | number
lenToken: "MAXLEN"
len: string | number
Optional callback: Callback<number[]>
Returns Promise<number[]>
lpush
- lpush(...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- lpush(...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]): Promise<number>
- \n
Prepend one or multiple elements to a list
\n- \n
- group: list \n
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns Promise<number>
lpushx
- lpushx(...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- lpushx(...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]): Promise<number>
- \n
Prepend an element to a list, only if the list exists
\n- \n
- group: list \n
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments. \n
- since: 2.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns Promise<number>
lrange
- lrange(key: RedisKey, start: string | number, stop: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Get a range of elements from a list
\n- \n
- group: list \n
- complexity: O(S+N) where S is the distance of start offset from HEAD for small lists, from nearest end (HEAD or TAIL) for large lists; and N is the number of elements in the specified range. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
start: string | number
stop: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
lrange
- lrange
Buffer(key: RedisKey, start: string | number, stop: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
start: string | number
stop: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
lrem
- lrem(key: RedisKey, count: string | number, element: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Remove elements from a list
\n- \n
- group: list \n
- complexity: O(N+M) where N is the length of the list and M is the number of elements removed. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
count: string | number
element: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
lset
- lset(key: RedisKey, index: string | number, element: string | number | Buffer, callback?: Callback<"OK">): Promise<"OK">
- \n
Set the value of an element in a list by its index
\n- \n
- group: list \n
- complexity: O(N) where N is the length of the list. Setting either the first or the last element of the list is O(1). \n
- since: 1.0.0 \n
Parameters
key: RedisKey
index: string | number
element: string | number | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
ltrim
- ltrim(key: RedisKey, start: string | number, stop: string | number, callback?: Callback<"OK">): Promise<"OK">
- \n
Trim a list to the specified range
\n- \n
- group: list \n
- complexity: O(N) where N is the number of elements to be removed by the operation. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
start: string | number
stop: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
memory
- memory(subcommand: "DOCTOR", callback?: Callback<string>): Promise<string>
- memory(subcommand: "HELP", callback?: Callback<unknown[]>): Promise<unknown[]>
- memory(subcommand: "MALLOC-STATS", callback?: Callback<string>): Promise<string>
- memory(subcommand: "PURGE", callback?: Callback<"OK">): Promise<"OK">
- memory(subcommand: "STATS", callback?: Callback<unknown[]>): Promise<unknown[]>
- memory(subcommand: "USAGE", key: RedisKey, callback?: Callback<number>): Promise<number>
- memory(subcommand: "USAGE", key: RedisKey, countToken: "SAMPLES", count: string | number, callback?: Callback<number>): Promise<number>
- \n
Outputs memory problems report
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 4.0.0 \n
Parameters
subcommand: "DOCTOR"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Show helpful text about the different subcommands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 4.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Show allocator internal stats
\n- \n
- group: server \n
- complexity: Depends on how much memory is allocated, could be slow \n
- since: 4.0.0 \n
Parameters
subcommand: "MALLOC-STATS"
Optional callback: Callback<string>
Returns Promise<string>
- \n
Ask the allocator to release memory
\n- \n
- group: server \n
- complexity: Depends on how much memory is allocated, could be slow \n
- since: 4.0.0 \n
Parameters
subcommand: "PURGE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
- \n
Show memory usage details
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 4.0.0 \n
Parameters
subcommand: "STATS"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Estimate the memory usage of a key
\n- \n
- group: server \n
- complexity: O(N) where N is the number of samples. \n
- since: 4.0.0 \n
Parameters
subcommand: "USAGE"
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
Parameters
subcommand: "USAGE"
key: RedisKey
countToken: "SAMPLES"
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
mget
- mget(...args: [...keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- mget(...args: [keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- mget(...args: RedisKey[]): Promise<string[]>
- mget(...args: [keys: RedisKey[]]): Promise<string[]>
- \n
Get the values of all the given keys
\n- \n
- group: string \n
- complexity: O(N) where N is the number of keys to retrieve. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: RedisKey[]
Returns Promise<string[]>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<string[]>
mget
- mget
Buffer(...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - mget
Buffer(...args: [keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - mget
Buffer(...args: RedisKey[]): Promise<Buffer[]> - mget
Buffer(...args: [keys: RedisKey[]]): Promise<Buffer[]>
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: RedisKey[]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<Buffer[]>
migrate
- migrate(...args: [host: string | Buffer, port: string | number, ...args: RedisValue[], callback: Callback<"OK">]): Promise<"OK">
- migrate(...args: [host: string | Buffer, port: string | number, ...args: RedisValue[]]): Promise<"OK">
- \n
Atomically transfer a key from a Redis instance to another one.
\n- \n
- group: generic \n
- complexity: This command actually executes a DUMP+DEL in the source instance, and a RESTORE in the target instance. See the pages of these commands for time complexity. Also an O(N) data transfer between the two instances is performed. \n
- since: 2.6.0 \n
Parameters
Rest ...args: [host: string | Buffer, port: string | number, ...args: RedisValue[], callback: Callback<"OK">]
Returns Promise<"OK">
Parameters
Rest ...args: [host: string | Buffer, port: string | number, ...args: RedisValue[]]
Returns Promise<"OK">
module
- module(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- module(subcommand: "LIST", callback?: Callback<unknown>): Promise<unknown>
- module(subcommand: "LOAD", path: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- module(...args: [subcommand: "LOAD", path: string | Buffer, ...args: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- module(...args: [subcommand: "LOAD", path: string | Buffer, ...args: (string | number | Buffer)[]]): Promise<unknown>
- module(subcommand: "LOADEX", path: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- module(...args: [subcommand: "LOADEX", path: string | Buffer, argsToken: "ARGS", ...args: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- module(...args: [subcommand: "LOADEX", path: string | Buffer, argsToken: "ARGS", ...args: (string | number | Buffer)[]]): Promise<unknown>
- module(...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...configs: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- module(...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...configs: (string | number | Buffer)[]]): Promise<unknown>
- module(...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown>
- module(...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...args: RedisValue[]]): Promise<unknown>
- module(subcommand: "UNLOAD", name: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- \n
Show helpful text about the different subcommands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
List all modules loaded by the server
\n- \n
- group: server \n
- complexity: O(N) where N is the number of loaded modules. \n
- since: 4.0.0 \n
Parameters
subcommand: "LIST"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Load a module
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 4.0.0 \n
Parameters
subcommand: "LOAD"
path: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LOAD", path: string | Buffer, ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LOAD", path: string | Buffer, ...args: (string | number | Buffer)[]]
Returns Promise<unknown>
- \n
Load a module with extended parameters
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
subcommand: "LOADEX"
path: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LOADEX", path: string | Buffer, argsToken: "ARGS", ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LOADEX", path: string | Buffer, argsToken: "ARGS", ...args: (string | number | Buffer)[]]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...configs: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...configs: (string | number | Buffer)[]]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...args: RedisValue[]]
Returns Promise<unknown>
- \n
Unload a module
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 4.0.0 \n
Parameters
subcommand: "UNLOAD"
name: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
monitor
- \n
Listen for all requests received by the server in real time.
\nThis command will create a new connection to Redis and send a\nMONITOR command via the new connection in order to avoid disturbing\nthe current connection.
\nParameters
Optional callback: Callback<Redis>
\nThe callback function. If omit, a promise will be returned.
\n
Returns Promise<Redis>
move
- move(key: RedisKey, db: string | number, callback?: Callback<number>): Promise<number>
- \n
Move a key to another database
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
db: string | number
Optional callback: Callback<number>
Returns Promise<number>
mset
- mset(object: object, callback?: Callback<"OK">): Promise<"OK">
- mset(map: Map<string | number | Buffer, string | number | Buffer>, callback?: Callback<"OK">): Promise<"OK">
- mset(...args: [...keyValues: (number | RedisKey)[], callback: Callback<"OK">]): Promise<"OK">
- mset(...args: (number | RedisKey)[]): Promise<"OK">
- \n
Set multiple keys to multiple values
\n- \n
- group: string \n
- complexity: O(N) where N is the number of keys to set. \n
- since: 1.0.1 \n
Parameters
object: object
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
map: Map<string | number | Buffer, string | number | Buffer>
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
Rest ...args: [...keyValues: (number | RedisKey)[], callback: Callback<"OK">]
Returns Promise<"OK">
Parameters
Rest ...args: (number | RedisKey)[]
Returns Promise<"OK">
msetnx
- msetnx(object: object, callback?: Callback<"OK">): Promise<"OK">
- msetnx(map: Map<string | number | Buffer, string | number | Buffer>, callback?: Callback<"OK">): Promise<"OK">
- msetnx(...args: [...keyValues: (number | RedisKey)[], callback: Callback<number>]): Promise<number>
- msetnx(...args: (number | RedisKey)[]): Promise<number>
- \n
Set multiple keys to multiple values, only if none of the keys exist
\n- \n
- group: string \n
- complexity: O(N) where N is the number of keys to set. \n
- since: 1.0.1 \n
Parameters
object: object
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
map: Map<string | number | Buffer, string | number | Buffer>
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
Rest ...args: [...keyValues: (number | RedisKey)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: (number | RedisKey)[]
Returns Promise<number>
multi
- multi(options: { pipeline: false }): Promise<"OK">
- multi(): ChainableCommander
- multi(options: { pipeline: true }): ChainableCommander
- multi(commands?: unknown[][]): ChainableCommander
Parameters
options: { pipeline: false }
pipeline: false
Returns Promise<"OK">
Returns ChainableCommander
Parameters
options: { pipeline: true }
pipeline: true
Returns ChainableCommander
Parameters
Optional commands: unknown[][]
Returns ChainableCommander
object
- object(subcommand: "ENCODING", key: RedisKey, callback?: Callback<unknown>): Promise<unknown>
- object(subcommand: "FREQ", key: RedisKey, callback?: Callback<unknown>): Promise<unknown>
- object(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- object(subcommand: "IDLETIME", key: RedisKey, callback?: Callback<unknown>): Promise<unknown>
- object(subcommand: "REFCOUNT", key: RedisKey, callback?: Callback<unknown>): Promise<unknown>
- \n
Inspect the internal encoding of a Redis object
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.2.3 \n
Parameters
subcommand: "ENCODING"
key: RedisKey
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Get the logarithmic access frequency counter of a Redis object
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 4.0.0 \n
Parameters
subcommand: "FREQ"
key: RedisKey
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Show helpful text about the different subcommands
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Get the time since a Redis object was last accessed
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.2.3 \n
Parameters
subcommand: "IDLETIME"
key: RedisKey
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Get the number of references to the value of the key
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.2.3 \n
Parameters
subcommand: "REFCOUNT"
key: RedisKey
Optional callback: Callback<unknown>
Returns Promise<unknown>
on
- on(event: "message", cb: ((channel: string, message: string) => void)): Redis
- on(event: "messageBuffer", cb: ((channel: Buffer, message: Buffer) => void)): Redis
- on(event: "pmessage", cb: ((pattern: string, channel: string, message: string) => void)): Redis
- on(event: "pmessageBuffer", cb: ((pattern: string, channel: Buffer, message: Buffer) => void)): Redis
- on(event: "error", cb: ((error: Error) => void)): Redis
- on(event: RedisStatus, cb: (() => void)): Redis
- on(event: string | symbol, listener: ((...args: any[]) => void)): Redis
Parameters
event: "message"
cb: ((channel: string, message: string) => void)
- (channel: string, message: string): void
Parameters
channel: string
message: string
Returns void
Returns Redis
Parameters
event: "messageBuffer"
cb: ((channel: Buffer, message: Buffer) => void)
- (channel: Buffer, message: Buffer): void
Parameters
channel: Buffer
message: Buffer
Returns void
Returns Redis
Parameters
event: "pmessage"
cb: ((pattern: string, channel: string, message: string) => void)
- (pattern: string, channel: string, message: string): void
Parameters
pattern: string
channel: string
message: string
Returns void
Returns Redis
Parameters
event: "pmessageBuffer"
cb: ((pattern: string, channel: Buffer, message: Buffer) => void)
- (pattern: string, channel: Buffer, message: Buffer): void
Parameters
pattern: string
channel: Buffer
message: Buffer
Returns void
Returns Redis
Parameters
event: "error"
cb: ((error: Error) => void)
- (error: Error): void
Parameters
error: Error
Returns void
Returns Redis
Parameters
event: RedisStatus
cb: (() => void)
- (): void
Returns void
Returns Redis
Parameters
event: string | symbol
listener: ((...args: any[]) => void)
- (...args: any[]): void
Parameters
Rest ...args: any[]
Returns void
Returns Redis
once
- once(event: "message", cb: ((channel: string, message: string) => void)): Redis
- once(event: "messageBuffer", cb: ((channel: Buffer, message: Buffer) => void)): Redis
- once(event: "pmessage", cb: ((pattern: string, channel: string, message: string) => void)): Redis
- once(event: "pmessageBuffer", cb: ((pattern: string, channel: Buffer, message: Buffer) => void)): Redis
- once(event: "error", cb: ((error: Error) => void)): Redis
- once(event: RedisStatus, cb: (() => void)): Redis
- once(event: string | symbol, listener: ((...args: any[]) => void)): Redis
Parameters
event: "message"
cb: ((channel: string, message: string) => void)
- (channel: string, message: string): void
Parameters
channel: string
message: string
Returns void
Returns Redis
Parameters
event: "messageBuffer"
cb: ((channel: Buffer, message: Buffer) => void)
- (channel: Buffer, message: Buffer): void
Parameters
channel: Buffer
message: Buffer
Returns void
Returns Redis
Parameters
event: "pmessage"
cb: ((pattern: string, channel: string, message: string) => void)
- (pattern: string, channel: string, message: string): void
Parameters
pattern: string
channel: string
message: string
Returns void
Returns Redis
Parameters
event: "pmessageBuffer"
cb: ((pattern: string, channel: Buffer, message: Buffer) => void)
- (pattern: string, channel: Buffer, message: Buffer): void
Parameters
pattern: string
channel: Buffer
message: Buffer
Returns void
Returns Redis
Parameters
event: "error"
cb: ((error: Error) => void)
- (error: Error): void
Parameters
error: Error
Returns void
Returns Redis
Parameters
event: RedisStatus
cb: (() => void)
- (): void
Returns void
Returns Redis
Parameters
event: string | symbol
listener: ((...args: any[]) => void)
- (...args: any[]): void
Parameters
Rest ...args: any[]
Returns void
Returns Redis
persist
- persist(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Remove the expiration from a key
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
pexpire
- pexpire(key: RedisKey, milliseconds: string | number, callback?: Callback<number>): Promise<number>
- pexpire(key: RedisKey, milliseconds: string | number, nx: "NX", callback?: Callback<number>): Promise<number>
- pexpire(key: RedisKey, milliseconds: string | number, xx: "XX", callback?: Callback<number>): Promise<number>
- pexpire(key: RedisKey, milliseconds: string | number, gt: "GT", callback?: Callback<number>): Promise<number>
- pexpire(key: RedisKey, milliseconds: string | number, lt: "LT", callback?: Callback<number>): Promise<number>
- \n
Set a key's time to live in milliseconds
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
milliseconds: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
milliseconds: string | number
nx: "NX"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
milliseconds: string | number
xx: "XX"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
milliseconds: string | number
gt: "GT"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
milliseconds: string | number
lt: "LT"
Optional callback: Callback<number>
Returns Promise<number>
pexpireat
- pexpireat(key: RedisKey, unixTimeMilliseconds: string | number, callback?: Callback<number>): Promise<number>
- pexpireat(key: RedisKey, unixTimeMilliseconds: string | number, nx: "NX", callback?: Callback<number>): Promise<number>
- pexpireat(key: RedisKey, unixTimeMilliseconds: string | number, xx: "XX", callback?: Callback<number>): Promise<number>
- pexpireat(key: RedisKey, unixTimeMilliseconds: string | number, gt: "GT", callback?: Callback<number>): Promise<number>
- pexpireat(key: RedisKey, unixTimeMilliseconds: string | number, lt: "LT", callback?: Callback<number>): Promise<number>
- \n
Set the expiration for a key as a UNIX timestamp specified in milliseconds
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
unixTimeMilliseconds: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
unixTimeMilliseconds: string | number
nx: "NX"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
unixTimeMilliseconds: string | number
xx: "XX"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
unixTimeMilliseconds: string | number
gt: "GT"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
unixTimeMilliseconds: string | number
lt: "LT"
Optional callback: Callback<number>
Returns Promise<number>
pexpiretime
- pexpiretime(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Get the expiration Unix timestamp for a key in milliseconds
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
pfadd
- pfadd(key: RedisKey, callback?: Callback<number>): Promise<number>
- pfadd(...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- pfadd(...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]): Promise<number>
- \n
Adds the specified elements to the specified HyperLogLog.
\n- \n
- group: hyperloglog \n
- complexity: O(1) to add every element. \n
- since: 2.8.9 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns Promise<number>
pfcount
- pfcount(...args: [...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- pfcount(...args: [keys: RedisKey[], callback: Callback<number>]): Promise<number>
- pfcount(...args: RedisKey[]): Promise<number>
- pfcount(...args: [keys: RedisKey[]]): Promise<number>
- \n
Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s).
\n- \n
- group: hyperloglog \n
- complexity: O(1) with a very small average constant time when called with a single key. O(N) with N being the number of keys, and much bigger constant times, when called with multiple keys. \n
- since: 2.8.9 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: RedisKey[]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<number>
pfdebug
- pfdebug(subcommand: string | Buffer, key: RedisKey, callback?: Callback<unknown>): Promise<unknown>
- \n
Internal commands for debugging HyperLogLog values
\n- \n
- group: hyperloglog \n
- complexity: N/A \n
- since: 2.8.9 \n
Parameters
subcommand: string | Buffer
key: RedisKey
Optional callback: Callback<unknown>
Returns Promise<unknown>
pfmerge
- pfmerge(...args: [destkey: RedisKey, ...sourcekeys: RedisKey[], callback: Callback<"OK">]): Promise<"OK">
- pfmerge(...args: [destkey: RedisKey, sourcekeys: RedisKey[], callback: Callback<"OK">]): Promise<"OK">
- pfmerge(...args: [destkey: RedisKey, ...sourcekeys: RedisKey[]]): Promise<"OK">
- pfmerge(...args: [destkey: RedisKey, sourcekeys: RedisKey[]]): Promise<"OK">
- \n
Merge N different HyperLogLogs into a single one.
\n- \n
- group: hyperloglog \n
- complexity: O(N) to merge N HyperLogLogs, but with high constant times. \n
- since: 2.8.9 \n
Parameters
Returns Promise<"OK">
Parameters
Returns Promise<"OK">
Parameters
Returns Promise<"OK">
Parameters
Returns Promise<"OK">
pfselftest
- pfselftest(callback?: Callback<unknown>): Promise<unknown>
- \n
An internal command for testing HyperLogLog values
\n- \n
- group: hyperloglog \n
- complexity: N/A \n
- since: 2.8.9 \n
Parameters
Optional callback: Callback<unknown>
Returns Promise<unknown>
ping
- ping(callback?: Callback<"PONG">): Promise<"PONG">
- ping(message: string | Buffer, callback?: Callback<string>): Promise<string>
- \n
Ping the server
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"PONG">
Returns Promise<"PONG">
Parameters
message: string | Buffer
Optional callback: Callback<string>
Returns Promise<string>
ping
- ping
Buffer(message: string | Buffer, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
message: string | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
pipeline
- pipeline(commands?: unknown[][]): ChainableCommander
Parameters
Optional commands: unknown[][]
Returns ChainableCommander
psetex
- psetex(key: RedisKey, milliseconds: string | number, value: string | number | Buffer, callback?: Callback<unknown>): Promise<unknown>
- \n
Set the value and expiration in milliseconds of a key
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
milliseconds: string | number
value: string | number | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
psubscribe
- psubscribe(...args: [...patterns: string[], callback: Callback<unknown>]): Promise<unknown>
- psubscribe(...args: string[]): Promise<unknown>
- \n
Listen for messages published to channels matching the given patterns
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of patterns the client is already subscribed to. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [...patterns: string[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: string[]
Returns Promise<unknown>
psync
- psync(replicationid: string | number | Buffer, offset: string | number, callback?: Callback<unknown>): Promise<unknown>
- \n
Internal command used for replication
\n- \n
- group: server \n
- complexity: undefined \n
- since: 2.8.0 \n
Parameters
replicationid: string | number | Buffer
offset: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
pttl
- pttl(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Get the time to live for a key in milliseconds
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
publish
- publish(channel: string | Buffer, message: string | Buffer, callback?: Callback<number>): Promise<number>
- \n
Post a message to a channel
\n- \n
- group: pubsub \n
- complexity: O(N+M) where N is the number of clients subscribed to the receiving channel and M is the total number of subscribed patterns (by any client). \n
- since: 2.0.0 \n
Parameters
channel: string | Buffer
message: string | Buffer
Optional callback: Callback<number>
Returns Promise<number>
pubsub
- pubsub(subcommand: "CHANNELS", callback?: Callback<unknown[]>): Promise<unknown[]>
- pubsub(subcommand: "CHANNELS", pattern: string, callback?: Callback<unknown[]>): Promise<unknown[]>
- pubsub(subcommand: "HELP", callback?: Callback<unknown[]>): Promise<unknown[]>
- pubsub(subcommand: "NUMPAT", callback?: Callback<unknown[]>): Promise<unknown[]>
- pubsub(subcommand: "NUMSUB", callback?: Callback<unknown[]>): Promise<unknown[]>
- pubsub(...args: [subcommand: "NUMSUB", ...channels: (string | Buffer)[], callback: Callback<unknown[]>]): Promise<unknown[]>
- pubsub(...args: [subcommand: "NUMSUB", ...channels: (string | Buffer)[]]): Promise<unknown[]>
- pubsub(subcommand: "SHARDCHANNELS", callback?: Callback<unknown[]>): Promise<unknown[]>
- pubsub(subcommand: "SHARDCHANNELS", pattern: string, callback?: Callback<unknown[]>): Promise<unknown[]>
- pubsub(subcommand: "SHARDNUMSUB", callback?: Callback<unknown[]>): Promise<unknown[]>
- pubsub(...args: [subcommand: "SHARDNUMSUB", ...shardchannels: (string | Buffer)[], callback: Callback<unknown[]>]): Promise<unknown[]>
- pubsub(...args: [subcommand: "SHARDNUMSUB", ...shardchannels: (string | Buffer)[]]): Promise<unknown[]>
- \n
List active channels
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of active channels, and assuming constant time pattern matching (relatively short channels and patterns) \n
- since: 2.8.0 \n
Parameters
subcommand: "CHANNELS"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
subcommand: "CHANNELS"
pattern: string
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Show helpful text about the different subcommands
\n- \n
- group: pubsub \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Get the count of unique patterns pattern subscriptions
\n- \n
- group: pubsub \n
- complexity: O(1) \n
- since: 2.8.0 \n
Parameters
subcommand: "NUMPAT"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Get the count of subscribers for channels
\n- \n
- group: pubsub \n
- complexity: O(N) for the NUMSUB subcommand, where N is the number of requested channels \n
- since: 2.8.0 \n
Parameters
subcommand: "NUMSUB"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
Rest ...args: [subcommand: "NUMSUB", ...channels: (string | Buffer)[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [subcommand: "NUMSUB", ...channels: (string | Buffer)[]]
Returns Promise<unknown[]>
- \n
List active shard channels
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of active shard channels, and assuming constant time pattern matching (relatively short shard channels). \n
- since: 7.0.0 \n
Parameters
subcommand: "SHARDCHANNELS"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
subcommand: "SHARDCHANNELS"
pattern: string
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
- \n
Get the count of subscribers for shard channels
\n- \n
- group: pubsub \n
- complexity: O(N) for the SHARDNUMSUB subcommand, where N is the number of requested shard channels \n
- since: 7.0.0 \n
Parameters
subcommand: "SHARDNUMSUB"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
Rest ...args: [subcommand: "SHARDNUMSUB", ...shardchannels: (string | Buffer)[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [subcommand: "SHARDNUMSUB", ...shardchannels: (string | Buffer)[]]
Returns Promise<unknown[]>
punsubscribe
- punsubscribe(callback?: Callback<unknown>): Promise<unknown>
- punsubscribe(...args: [...patterns: string[], callback: Callback<unknown>]): Promise<unknown>
- punsubscribe(...args: string[]): Promise<unknown>
- \n
Stop listening for messages posted to channels matching the given patterns
\n- \n
- group: pubsub \n
- complexity: O(N+M) where N is the number of patterns the client is already subscribed and M is the number of total patterns subscribed in the system (by any client). \n
- since: 2.0.0 \n
Parameters
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [...patterns: string[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: string[]
Returns Promise<unknown>
quit
- quit(callback?: Callback<"OK">): Promise<"OK">
- \n
Close the connection
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
randomkey
- randomkey(callback?: Callback<string>): Promise<string>
- \n
Return a random key from the keyspace
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<string>
Returns Promise<string>
randomkey
- randomkey
Buffer(callback?: Callback<Buffer>): Promise<Buffer>
Parameters
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
readonly
- readonly(callback?: Callback<"OK">): Promise<"OK">
- \n
Enables read queries for a connection to a cluster replica node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
readwrite
- readwrite(callback?: Callback<"OK">): Promise<"OK">
- \n
Disables read queries for a connection to a cluster replica node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
rename
renamenx
replconf
- replconf(callback?: Callback<unknown>): Promise<unknown>
- \n
An internal command for configuring the replication stream
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
Optional callback: Callback<unknown>
Returns Promise<unknown>
replicaof
- replicaof(host: string | Buffer, port: string | number, callback?: Callback<"OK">): Promise<"OK">
- \n
Make the server a replica of another instance, or promote it as master.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
host: string | Buffer
port: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
reset
- reset(callback?: Callback<"OK">): Promise<"OK">
- \n
Reset the connection
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
restore
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): Promise<"OK">
- \n
Create a key using the provided serialized value, previously obtained using DUMP.
\n- \n
- group: generic \n
- complexity: O(1) to create the new key and additional O(NM) to reconstruct the serialized value, where N is the number of Redis objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1M) where M is small, so simply O(1). However for sorted set values the complexity is O(NMlog(N)) because inserting values into sorted sets is O(log(N)). \n
- since: 2.6.0 \n
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
restore-
- restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<unknown>): Promise<unknown> - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): Promise<unknown>
- \n
An internal command for migrating keys in a cluster
\n- \n
- group: server \n
- complexity: O(1) to create the new key and additional O(NM) to reconstruct the serialized value, where N is the number of Redis objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1M) where M is small, so simply O(1). However for sorted set values the complexity is O(NMlog(N)) because inserting values into sorted sets is O(log(N)). \n
- since: 3.0.0 \n
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
role
- role(callback?: Callback<unknown[]>): Promise<unknown[]>
- \n
Return the role of the instance in the context of replication
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.12 \n
Parameters
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
rpop
- rpop(key: RedisKey, callback?: Callback<string>): Promise<string>
- rpop(key: RedisKey, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Remove and get the last elements in a list
\n- \n
- group: list \n
- complexity: O(N) where N is the number of elements returned \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
rpop
rpoplpush
rpoplpush
rpush
- rpush(...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- rpush(...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]): Promise<number>
- \n
Append one or multiple elements to a list
\n- \n
- group: list \n
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns Promise<number>
rpushx
- rpushx(...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- rpushx(...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]): Promise<number>
- \n
Append an element to a list, only if the list exists
\n- \n
- group: list \n
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments. \n
- since: 2.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns Promise<number>
sadd
- sadd(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- sadd(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- sadd(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): Promise<number>
- sadd(...args: [key: RedisKey, members: (string | number | Buffer)[]]): Promise<number>
- \n
Add one or more members to a set
\n- \n
- group: set \n
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<number>
save
- save(callback?: Callback<"OK">): Promise<"OK">
- \n
Synchronously save the dataset to disk
\n- \n
- group: server \n
- complexity: O(N) where N is the total number of keys in all databases \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
scan
- scan(cursor: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- scan(cursor: string | number, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- scan(cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- scan(cursor: string | number, countToken: "COUNT", count: string | number, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- scan(cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- scan(cursor: string | number, patternToken: "MATCH", pattern: string, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- scan(cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- scan(cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- \n
Incrementally iterate the keys space
\n- \n
- group: generic \n
- complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection. \n
- since: 2.8.0 \n
Parameters
cursor: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
cursor: string | number
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
cursor: string | number
countToken: "COUNT"
count: string | number
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
scan
- scan
Buffer(cursor: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - scan
Buffer(cursor: string | number, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - scan
Buffer(cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - scan
Buffer(cursor: string | number, countToken: "COUNT", count: string | number, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - scan
Buffer(cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - scan
Buffer(cursor: string | number, patternToken: "MATCH", pattern: string, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - scan
Buffer(cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - scan
Buffer(cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
cursor: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
cursor: string | number
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
cursor: string | number
countToken: "COUNT"
count: string | number
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
scan
- scan
Buffer Stream(options?: ScanStreamOptions): default
Parameters
Optional options: ScanStreamOptions
Returns default
scan
- scan
Stream(options?: ScanStreamOptions): default
Parameters
Optional options: ScanStreamOptions
Returns default
scard
- scard(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Get the number of members in a set
\n- \n
- group: set \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
script
- script(subcommand: "DEBUG", yes: "YES", callback?: Callback<unknown>): Promise<unknown>
- script(subcommand: "DEBUG", sync: "SYNC", callback?: Callback<unknown>): Promise<unknown>
- script(subcommand: "DEBUG", no: "NO", callback?: Callback<unknown>): Promise<unknown>
- script(...args: [subcommand: "EXISTS", ...sha1s: (string | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- script(...args: [subcommand: "EXISTS", ...sha1s: (string | Buffer)[]]): Promise<unknown>
- script(subcommand: "FLUSH", callback?: Callback<unknown>): Promise<unknown>
- script(subcommand: "FLUSH", async: "ASYNC", callback?: Callback<unknown>): Promise<unknown>
- script(subcommand: "FLUSH", sync: "SYNC", callback?: Callback<unknown>): Promise<unknown>
- script(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- script(subcommand: "KILL", callback?: Callback<unknown>): Promise<unknown>
- script(subcommand: "LOAD", script: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- \n
Set the debug mode for executed scripts.
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 3.2.0 \n
Parameters
subcommand: "DEBUG"
yes: "YES"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "DEBUG"
sync: "SYNC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "DEBUG"
no: "NO"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Check existence of scripts in the script cache.
\n- \n
- group: scripting \n
- complexity: O(N) with N being the number of scripts to check (so checking a single script is an O(1) operation). \n
- since: 2.6.0 \n
Parameters
Rest ...args: [subcommand: "EXISTS", ...sha1s: (string | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [subcommand: "EXISTS", ...sha1s: (string | Buffer)[]]
Returns Promise<unknown>
- \n
Remove all the scripts from the script cache.
\n- \n
- group: scripting \n
- complexity: O(N) with N being the number of scripts in cache \n
- since: 2.6.0 \n
Parameters
subcommand: "FLUSH"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "FLUSH"
async: "ASYNC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "FLUSH"
sync: "SYNC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Show helpful text about the different subcommands
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Kill the script currently in execution.
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
subcommand: "KILL"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Load the specified Lua script into the script cache.
\n- \n
- group: scripting \n
- complexity: O(N) with N being the length in bytes of the script body. \n
- since: 2.6.0 \n
Parameters
subcommand: "LOAD"
script: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
sdiff
- sdiff(...args: [...keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- sdiff(...args: [keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- sdiff(...args: RedisKey[]): Promise<string[]>
- sdiff(...args: [keys: RedisKey[]]): Promise<string[]>
- \n
Subtract multiple sets
\n- \n
- group: set \n
- complexity: O(N) where N is the total number of elements in all given sets. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: RedisKey[]
Returns Promise<string[]>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<string[]>
sdiff
- sdiff
Buffer(...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - sdiff
Buffer(...args: [keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - sdiff
Buffer(...args: RedisKey[]): Promise<Buffer[]> - sdiff
Buffer(...args: [keys: RedisKey[]]): Promise<Buffer[]>
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: RedisKey[]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<Buffer[]>
sdiffstore
- sdiffstore(...args: [destination: RedisKey, ...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- sdiffstore(...args: [destination: RedisKey, keys: RedisKey[], callback: Callback<number>]): Promise<number>
- sdiffstore(...args: [destination: RedisKey, ...keys: RedisKey[]]): Promise<number>
- sdiffstore(...args: [destination: RedisKey, keys: RedisKey[]]): Promise<number>
- \n
Subtract multiple sets and store the resulting set in a key
\n- \n
- group: set \n
- complexity: O(N) where N is the total number of elements in all given sets. \n
- since: 1.0.0 \n
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
select
- select(index: string | number, callback?: Callback<"OK">): Promise<"OK">
- \n
Change the selected database for the current connection
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
index: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
set
- set(key: RedisKey, value: string | number | Buffer, callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, nx: "NX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, nx: "NX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, xx: "XX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, xx: "XX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, nx: "NX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, nx: "NX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, xx: "XX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, xx: "XX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, nx: "NX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, nx: "NX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, xx: "XX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, xx: "XX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, nx: "NX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, nx: "NX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, xx: "XX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, xx: "XX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, nx: "NX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, nx: "NX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, xx: "XX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, xx: "XX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", nx: "NX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", nx: "NX", get: "GET", callback?: Callback<string>): Promise<string>
- set(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", xx: "XX", callback?: Callback<"OK">): Promise<"OK">
- set(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", xx: "XX", get: "GET", callback?: Callback<string>): Promise<string>
- \n
Set the string value of a key
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
value: string | number | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
nx: "NX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
nx: "NX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
xx: "XX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
xx: "XX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
nx: "NX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
xx: "XX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
nx: "NX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
xx: "XX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
nx: "NX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
xx: "XX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
nx: "NX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
xx: "XX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
nx: "NX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
nx: "NX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
xx: "XX"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
xx: "XX"
get: "GET"
Optional callback: Callback<string>
Returns Promise<string>
set
- set
Buffer(key: RedisKey, value: string | number | Buffer, get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, nx: "NX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, xx: "XX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, nx: "NX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, xx: "XX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, nx: "NX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, xx: "XX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, nx: "NX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, xx: "XX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, nx: "NX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, xx: "XX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", nx: "NX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer> - set
Buffer(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", xx: "XX", get: "GET", callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
nx: "NX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
xx: "XX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
nx: "NX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
xx: "XX"
get: "GET"
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
setbit
- setbit(key: RedisKey, offset: string | number, value: string | number, callback?: Callback<number>): Promise<number>
- \n
Sets or clears the bit at offset in the string value stored at key
\n- \n
- group: bitmap \n
- complexity: O(1) \n
- since: 2.2.0 \n
Parameters
key: RedisKey
offset: string | number
value: string | number
Optional callback: Callback<number>
Returns Promise<number>
setex
- setex(key: RedisKey, seconds: string | number, value: string | number | Buffer, callback?: Callback<"OK">): Promise<"OK">
- \n
Set the value and expiration of a key
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
seconds: string | number
value: string | number | Buffer
Optional callback: Callback<"OK">
Returns Promise<"OK">
setnx
- setnx(key: RedisKey, value: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Set the value of a key, only if the key does not exist
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
value: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
setrange
- setrange(key: RedisKey, offset: string | number, value: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Overwrite part of a string at key starting at the specified offset
\n- \n
- group: string \n
- complexity: O(1), not counting the time taken to copy the new string in place. Usually, this string is very small so the amortized complexity is O(1). Otherwise, complexity is O(M) with M being the length of the value argument. \n
- since: 2.2.0 \n
Parameters
key: RedisKey
offset: string | number
value: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
shutdown
- shutdown(callback?: Callback<"OK">): Promise<"OK">
- shutdown(abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
- shutdown(force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(now: "NOW", callback?: Callback<"OK">): Promise<"OK">
- shutdown(now: "NOW", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(now: "NOW", force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
- shutdown(now: "NOW", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(nosave: "NOSAVE", callback?: Callback<"OK">): Promise<"OK">
- shutdown(nosave: "NOSAVE", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(nosave: "NOSAVE", force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
- shutdown(nosave: "NOSAVE", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(nosave: "NOSAVE", now: "NOW", callback?: Callback<"OK">): Promise<"OK">
- shutdown(nosave: "NOSAVE", now: "NOW", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(nosave: "NOSAVE", now: "NOW", force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
- shutdown(nosave: "NOSAVE", now: "NOW", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(save: "SAVE", callback?: Callback<"OK">): Promise<"OK">
- shutdown(save: "SAVE", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(save: "SAVE", force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
- shutdown(save: "SAVE", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(save: "SAVE", now: "NOW", callback?: Callback<"OK">): Promise<"OK">
- shutdown(save: "SAVE", now: "NOW", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- shutdown(save: "SAVE", now: "NOW", force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
- shutdown(save: "SAVE", now: "NOW", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
- \n
Synchronously save the dataset to disk and then shut down the server
\n- \n
- group: server \n
- complexity: O(N) when saving, where N is the total number of keys in all databases when saving data, otherwise O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
force: "FORCE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
now: "NOW"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
now: "NOW"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
now: "NOW"
force: "FORCE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
now: "NOW"
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
nosave: "NOSAVE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
nosave: "NOSAVE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
nosave: "NOSAVE"
force: "FORCE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
nosave: "NOSAVE"
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
nosave: "NOSAVE"
now: "NOW"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
nosave: "NOSAVE"
now: "NOW"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
nosave: "NOSAVE"
now: "NOW"
force: "FORCE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
nosave: "NOSAVE"
now: "NOW"
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
save: "SAVE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
save: "SAVE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
save: "SAVE"
force: "FORCE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
save: "SAVE"
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
save: "SAVE"
now: "NOW"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
save: "SAVE"
now: "NOW"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
save: "SAVE"
now: "NOW"
force: "FORCE"
Optional callback: Callback<"OK">
Returns Promise<"OK">
Parameters
save: "SAVE"
now: "NOW"
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns Promise<"OK">
sinter
- sinter(...args: [...keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- sinter(...args: [keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- sinter(...args: RedisKey[]): Promise<string[]>
- sinter(...args: [keys: RedisKey[]]): Promise<string[]>
- \n
Intersect multiple sets
\n- \n
- group: set \n
- complexity: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: RedisKey[]
Returns Promise<string[]>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<string[]>
sinter
- sinter
Buffer(...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - sinter
Buffer(...args: [keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - sinter
Buffer(...args: RedisKey[]): Promise<Buffer[]> - sinter
Buffer(...args: [keys: RedisKey[]]): Promise<Buffer[]>
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: RedisKey[]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<Buffer[]>
sintercard
- sintercard(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- sintercard(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<number>]): Promise<number>
- sintercard(...args: [numkeys: string | number, ...keys: RedisKey[]]): Promise<number>
- sintercard(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<number>
- sintercard(...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]): Promise<number>
- sintercard(...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]): Promise<number>
- sintercard(...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number]): Promise<number>
- sintercard(...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number]): Promise<number>
- \n
Intersect multiple sets and return the cardinality of the result
\n- \n
- group: set \n
- complexity: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number]
Returns Promise<number>
sinterstore
- sinterstore(...args: [destination: RedisKey, ...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- sinterstore(...args: [destination: RedisKey, keys: RedisKey[], callback: Callback<number>]): Promise<number>
- sinterstore(...args: [destination: RedisKey, ...keys: RedisKey[]]): Promise<number>
- sinterstore(...args: [destination: RedisKey, keys: RedisKey[]]): Promise<number>
- \n
Intersect multiple sets and store the resulting set in a key
\n- \n
- group: set \n
- complexity: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets. \n
- since: 1.0.0 \n
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
sismember
- sismember(key: RedisKey, member: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Determine if a given value is a member of a set
\n- \n
- group: set \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
member: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
slaveof
- slaveof(host: string | Buffer, port: string | number, callback?: Callback<"OK">): Promise<"OK">
- \n
Make the server a replica of another instance, or promote it as master.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
host: string | Buffer
port: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
slowlog
- slowlog(subcommand: "GET", callback?: Callback<unknown>): Promise<unknown>
- slowlog(subcommand: "GET", count: string | number, callback?: Callback<unknown>): Promise<unknown>
- slowlog(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- slowlog(subcommand: "LEN", callback?: Callback<unknown>): Promise<unknown>
- slowlog(subcommand: "RESET", callback?: Callback<unknown>): Promise<unknown>
- \n
Get the slow log's entries
\n- \n
- group: server \n
- complexity: O(N) where N is the number of entries returned \n
- since: 2.2.12 \n
Parameters
subcommand: "GET"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "GET"
count: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Show helpful text about the different subcommands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Get the slow log's length
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.2.12 \n
Parameters
subcommand: "LEN"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Clear all entries from the slow log
\n- \n
- group: server \n
- complexity: O(N) where N is the number of entries in the slowlog \n
- since: 2.2.12 \n
Parameters
subcommand: "RESET"
Optional callback: Callback<unknown>
Returns Promise<unknown>
smembers
- smembers(key: RedisKey, callback?: Callback<string[]>): Promise<string[]>
- \n
Get all the members in a set
\n- \n
- group: set \n
- complexity: O(N) where N is the set cardinality. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string[]>
Returns Promise<string[]>
smembers
- smembers
Buffer(key: RedisKey, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
smismember
- smismember(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- smismember(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number[]>]): Promise<number[]>
- smismember(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): Promise<number[]>
- smismember(...args: [key: RedisKey, members: (string | number | Buffer)[]]): Promise<number[]>
- \n
Returns the membership associated with the given elements for a set
\n- \n
- group: set \n
- complexity: O(N) where N is the number of elements being checked for membership \n
- since: 6.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number[]>]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<number[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<number[]>
smove
sort
- sort(...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<unknown>]): Promise<unknown>
- sort(...args: [key: RedisKey, ...args: RedisValue[]]): Promise<unknown>
- \n
Sort the elements in a list, set or sorted set
\n- \n
- group: generic \n
- complexity: O(N+M*log(M)) where N is the number of elements in the list or set to sort, and M the number of returned elements. When the elements are not sorted, complexity is O(N). \n
- since: 1.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[]]
Returns Promise<unknown>
sort_
- sort_
ro(key: RedisKey, callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, asc: "ASC", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, asc: "ASC", alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, desc: "DESC", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, desc: "DESC", alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[]]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], alpha: "ALPHA"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA"]): Promise<unknown> - sort_
ro(key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, asc: "ASC", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, asc: "ASC", alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, desc: "DESC", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, desc: "DESC", alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[]]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], alpha: "ALPHA"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA"]): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, asc: "ASC", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, asc: "ASC", alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, desc: "DESC", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, desc: "DESC", alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[]]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA"]): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, asc: "ASC", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, asc: "ASC", alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, desc: "DESC", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, desc: "DESC", alpha: "ALPHA", callback?: Callback<unknown>): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[]]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC"]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]): Promise<unknown> - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA"]): Promise<unknown>
- \n
Sort the elements in a list, set or sorted set. Read-only variant of SORT.
\n- \n
- group: generic \n
- complexity: O(N+M*log(M)) where N is the number of elements in the list or set to sort, and M the number of returned elements. When the elements are not sorted, complexity is O(N). \n
- since: 7.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
asc: "ASC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
asc: "ASC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
desc: "DESC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
desc: "DESC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[]]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
key: RedisKey
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
asc: "ASC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
asc: "ASC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
desc: "DESC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
desc: "DESC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[]]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
asc: "ASC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
asc: "ASC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
desc: "DESC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
desc: "DESC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[]]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
asc: "ASC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
asc: "ASC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
desc: "DESC"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
desc: "DESC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[]]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC"]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA"]
Returns Promise<unknown>
spop
- spop(key: RedisKey, callback?: Callback<string>): Promise<string>
- spop(key: RedisKey, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Remove and return one or multiple random members from a set
\n- \n
- group: set \n
- complexity: Without the count argument O(1), otherwise O(N) where N is the value of the passed count. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
spop
spublish
- spublish(shardchannel: string | Buffer, message: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- \n
Post a message to a shard channel
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of clients subscribed to the receiving shard channel. \n
- since: 7.0.0 \n
Parameters
shardchannel: string | Buffer
message: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
srandmember
- srandmember(key: RedisKey, callback?: Callback<string>): Promise<string>
- srandmember(key: RedisKey, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Get one or multiple random members from a set
\n- \n
- group: set \n
- complexity: Without the count argument O(1), otherwise O(N) where N is the absolute value of the passed count. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
srandmember
srem
- srem(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- srem(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- srem(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): Promise<number>
- srem(...args: [key: RedisKey, members: (string | number | Buffer)[]]): Promise<number>
- \n
Remove one or more members from a set
\n- \n
- group: set \n
- complexity: O(N) where N is the number of members to be removed. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<number>
sscan
- sscan(key: RedisKey, cursor: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- sscan(key: RedisKey, cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- sscan(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- sscan(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- \n
Incrementally iterate Set elements
\n- \n
- group: set \n
- complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.. \n
- since: 2.8.0 \n
Parameters
key: RedisKey
cursor: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
key: RedisKey
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
sscan
- sscan
Buffer(key: RedisKey, cursor: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - sscan
Buffer(key: RedisKey, cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - sscan
Buffer(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - sscan
Buffer(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
sscan
- sscan
Buffer Stream(key: string, options?: ScanStreamOptions): default
Parameters
key: string
Optional options: ScanStreamOptions
Returns default
sscan
- sscan
Stream(key: string, options?: ScanStreamOptions): default
Parameters
key: string
Optional options: ScanStreamOptions
Returns default
ssubscribe
- ssubscribe(...args: [...shardchannels: (string | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- ssubscribe(...args: (string | Buffer)[]): Promise<unknown>
- \n
Listen for messages published to the given shard channels
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of shard channels to subscribe to. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [...shardchannels: (string | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: (string | Buffer)[]
Returns Promise<unknown>
strlen
- strlen(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Get the length of the value stored in a key
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 2.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
subscribe
- subscribe(...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- subscribe(...args: (string | Buffer)[]): Promise<unknown>
- \n
Listen for messages published to the given channels
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of channels to subscribe to. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: (string | Buffer)[]
Returns Promise<unknown>
substr
- substr(key: RedisKey, start: string | number, end: string | number, callback?: Callback<unknown>): Promise<unknown>
- \n
Get a substring of the string stored at a key
\n- \n
- group: string \n
- complexity: O(N) where N is the length of the returned string. The complexity is ultimately determined by the returned length, but because creating a substring from an existing string is very cheap, it can be considered O(1) for small strings. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
start: string | number
end: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
sunion
- sunion(...args: [...keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- sunion(...args: [keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- sunion(...args: RedisKey[]): Promise<string[]>
- sunion(...args: [keys: RedisKey[]]): Promise<string[]>
- \n
Add multiple sets
\n- \n
- group: set \n
- complexity: O(N) where N is the total number of elements in all given sets. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: RedisKey[]
Returns Promise<string[]>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<string[]>
sunion
- sunion
Buffer(...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - sunion
Buffer(...args: [keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - sunion
Buffer(...args: RedisKey[]): Promise<Buffer[]> - sunion
Buffer(...args: [keys: RedisKey[]]): Promise<Buffer[]>
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: RedisKey[]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<Buffer[]>
sunionstore
- sunionstore(...args: [destination: RedisKey, ...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- sunionstore(...args: [destination: RedisKey, keys: RedisKey[], callback: Callback<number>]): Promise<number>
- sunionstore(...args: [destination: RedisKey, ...keys: RedisKey[]]): Promise<number>
- sunionstore(...args: [destination: RedisKey, keys: RedisKey[]]): Promise<number>
- \n
Add multiple sets and store the resulting set in a key
\n- \n
- group: set \n
- complexity: O(N) where N is the total number of elements in all given sets. \n
- since: 1.0.0 \n
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
sunsubscribe
- sunsubscribe(callback?: Callback<unknown>): Promise<unknown>
- sunsubscribe(...args: [...shardchannels: (string | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- sunsubscribe(...args: (string | Buffer)[]): Promise<unknown>
- \n
Stop listening for messages posted to the given shard channels
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of clients already subscribed to a shard channel. \n
- since: 7.0.0 \n
Parameters
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [...shardchannels: (string | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: (string | Buffer)[]
Returns Promise<unknown>
swapdb
- swapdb(index1: string | number, index2: string | number, callback?: Callback<"OK">): Promise<"OK">
- \n
Swaps two Redis databases
\n- \n
- group: server \n
- complexity: O(N) where N is the count of clients watching or blocking on keys from both databases. \n
- since: 4.0.0 \n
Parameters
index1: string | number
index2: string | number
Optional callback: Callback<"OK">
Returns Promise<"OK">
sync
- sync(callback?: Callback<unknown>): Promise<unknown>
- \n
Internal command used for replication
\n- \n
- group: server \n
- complexity: undefined \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<unknown>
Returns Promise<unknown>
time
- time(callback?: Callback<number[]>): Promise<number[]>
- \n
Return the current server time
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
Optional callback: Callback<number[]>
Returns Promise<number[]>
touch
- touch(...args: [...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- touch(...args: [keys: RedisKey[], callback: Callback<number>]): Promise<number>
- touch(...args: RedisKey[]): Promise<number>
- touch(...args: [keys: RedisKey[]]): Promise<number>
- \n
Alters the last access time of a key(s). Returns the number of existing keys specified.
\n- \n
- group: generic \n
- complexity: O(N) where N is the number of keys that will be touched. \n
- since: 3.2.1 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: RedisKey[]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<number>
ttl
- ttl(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Get the time to live for a key in seconds
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
type
- type(key: RedisKey, callback?: Callback<string>): Promise<string>
- \n
Determine the type stored at key
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
unlink
- unlink(...args: [...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- unlink(...args: [keys: RedisKey[], callback: Callback<number>]): Promise<number>
- unlink(...args: RedisKey[]): Promise<number>
- unlink(...args: [keys: RedisKey[]]): Promise<number>
- \n
Delete a key asynchronously in another thread. Otherwise it is just as DEL, but non blocking.
\n- \n
- group: generic \n
- complexity: O(1) for each key removed regardless of its size. Then the command does O(N) work in a different thread in order to reclaim memory, where N is the number of allocations the deleted objects where composed of. \n
- since: 4.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: RedisKey[]
Returns Promise<number>
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<number>
unsubscribe
- unsubscribe(callback?: Callback<unknown>): Promise<unknown>
- unsubscribe(...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- unsubscribe(...args: (string | Buffer)[]): Promise<unknown>
- \n
Stop listening for messages posted to the given channels
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of clients already subscribed to a channel. \n
- since: 2.0.0 \n
Parameters
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
Rest ...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: (string | Buffer)[]
Returns Promise<unknown>
unwatch
- unwatch(callback?: Callback<"OK">): Promise<"OK">
- \n
Forget about all watched keys
\n- \n
- group: transactions \n
- complexity: O(1) \n
- since: 2.2.0 \n
Parameters
Optional callback: Callback<"OK">
Returns Promise<"OK">
wait
- wait(numreplicas: string | number, timeout: string | number, callback?: Callback<number>): Promise<number>
- \n
Wait for the synchronous replication of all the write commands sent in the context of the current connection
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
numreplicas: string | number
timeout: string | number
Optional callback: Callback<number>
Returns Promise<number>
watch
- watch(...args: [...keys: RedisKey[], callback: Callback<"OK">]): Promise<"OK">
- watch(...args: [keys: RedisKey[], callback: Callback<"OK">]): Promise<"OK">
- watch(...args: RedisKey[]): Promise<"OK">
- watch(...args: [keys: RedisKey[]]): Promise<"OK">
- \n
Watch the given keys to determine execution of the MULTI/EXEC block
\n- \n
- group: transactions \n
- complexity: O(1) for every key. \n
- since: 2.2.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<"OK">]
Returns Promise<"OK">
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<"OK">]
Returns Promise<"OK">
Parameters
Rest ...args: RedisKey[]
Returns Promise<"OK">
Parameters
Rest ...args: [keys: RedisKey[]]
Returns Promise<"OK">
xack
- xack(...args: [key: RedisKey, group: string | Buffer, ...ids: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- xack(...args: [key: RedisKey, group: string | Buffer, ...ids: (string | number | Buffer)[]]): Promise<number>
- \n
Marks a pending message as correctly processed, effectively removing it from the pending entries list of the consumer group. Return value of the command is the number of messages successfully acknowledged, that is, the IDs we were actually able to resolve in the PEL.
\n- \n
- group: stream \n
- complexity: O(1) for each message ID processed. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, ...ids: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, ...ids: (string | number | Buffer)[]]
Returns Promise<number>
xadd
- xadd(...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<string>]): Promise<string>
- xadd(...args: [key: RedisKey, ...args: RedisValue[]]): Promise<string>
- \n
Appends a new entry to a stream
\n- \n
- group: stream \n
- complexity: O(1) when adding a new entry, O(N) when trimming where N being the number of entries evicted. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[]]
Returns Promise<string>
xadd
- xadd
Buffer(...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<Buffer>]): Promise<Buffer> - xadd
Buffer(...args: [key: RedisKey, ...args: RedisValue[]]): Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[]]
Returns Promise<Buffer>
xautoclaim
- xautoclaim(key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, start: string | number | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- xautoclaim(key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, start: string | number | Buffer, justid: "JUSTID", callback?: Callback<unknown[]>): Promise<unknown[]>
- xautoclaim(key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, start: string | number | Buffer, countToken: "COUNT", count: string | number, callback?: Callback<unknown[]>): Promise<unknown[]>
- xautoclaim(key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, start: string | number | Buffer, countToken: "COUNT", count: string | number, justid: "JUSTID", callback?: Callback<unknown[]>): Promise<unknown[]>
- \n
Changes (or acquires) ownership of messages in a consumer group, as if the messages were delivered to the specified consumer.
\n- \n
- group: stream \n
- complexity: O(1) if COUNT is small. \n
- since: 6.2.0 \n
Parameters
key: RedisKey
group: string | Buffer
consumer: string | Buffer
minIdleTime: string | number | Buffer
start: string | number | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
key: RedisKey
group: string | Buffer
consumer: string | Buffer
minIdleTime: string | number | Buffer
start: string | number | Buffer
justid: "JUSTID"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
key: RedisKey
group: string | Buffer
consumer: string | Buffer
minIdleTime: string | number | Buffer
start: string | number | Buffer
countToken: "COUNT"
count: string | number
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
key: RedisKey
group: string | Buffer
consumer: string | Buffer
minIdleTime: string | number | Buffer
start: string | number | Buffer
countToken: "COUNT"
count: string | number
justid: "JUSTID"
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
xclaim
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[]]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE", justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE", justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", callback: Callback<unknown[]>]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", justid: "JUSTID"]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): Promise<unknown[]>
- \n
Changes (or acquires) ownership of a message in a consumer group, as if the message was delivered to the specified consumer.
\n- \n
- group: stream \n
- complexity: O(log N) with N being the number of messages in the PEL of the consumer group. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[]]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE", justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE", justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", justid: "JUSTID"]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns Promise<unknown[]>
xdel
- xdel(...args: [key: RedisKey, ...ids: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- xdel(...args: [key: RedisKey, ...ids: (string | number | Buffer)[]]): Promise<number>
- \n
Removes the specified entries from the stream. Returns the number of items actually deleted, that may be different from the number of IDs passed in case certain IDs do not exist.
\n- \n
- group: stream \n
- complexity: O(1) for each single item to delete in the stream, regardless of the stream size. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...ids: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...ids: (string | number | Buffer)[]]
Returns Promise<number>
xdelex
- xdelex(...args: [key: RedisKey, idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- xdelex(...args: [key: RedisKey, idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]): Promise<unknown>
- xdelex(...args: [key: RedisKey, keepref: "KEEPREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- xdelex(...args: [key: RedisKey, keepref: "KEEPREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]): Promise<unknown>
- xdelex(...args: [key: RedisKey, delref: "DELREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- xdelex(...args: [key: RedisKey, delref: "DELREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]): Promise<unknown>
- xdelex(...args: [key: RedisKey, acked: "ACKED", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]): Promise<unknown>
- xdelex(...args: [key: RedisKey, acked: "ACKED", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]): Promise<unknown>
- \n
Deletes one or multiple entries from the stream.
\n- \n
- group: stream \n
- complexity: O(1) for each single item to delete in the stream, regardless of the stream size. \n
- since: 8.2.0 \n
Parameters
Rest ...args: [key: RedisKey, idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, keepref: "KEEPREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, keepref: "KEEPREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, delref: "DELREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, delref: "DELREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, acked: "ACKED", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [key: RedisKey, acked: "ACKED", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]
Returns Promise<unknown>
xgroup
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, id: string | number | Buffer, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, id: string | number | Buffer, entriesReadToken: "ENTRIESREAD", entriesRead: string | number, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, id: string | number | Buffer, mkstream: "MKSTREAM", callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, id: string | number | Buffer, mkstream: "MKSTREAM", entriesReadToken: "ENTRIESREAD", entriesRead: string | number, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, newId: "$", callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, newId: "$", entriesReadToken: "ENTRIESREAD", entriesRead: string | number, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, newId: "$", mkstream: "MKSTREAM", callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, newId: "$", mkstream: "MKSTREAM", entriesReadToken: "ENTRIESREAD", entriesRead: string | number, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "CREATECONSUMER", key: RedisKey, groupname: string | Buffer, consumername: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "DELCONSUMER", key: RedisKey, groupname: string | Buffer, consumername: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "DESTROY", key: RedisKey, groupname: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "SETID", key: RedisKey, groupname: string | Buffer, id: string | number | Buffer, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "SETID", key: RedisKey, groupname: string | Buffer, id: string | number | Buffer, entriesReadToken: "ENTRIESREAD", entriesRead: string | number, callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "SETID", key: RedisKey, groupname: string | Buffer, newId: "$", callback?: Callback<unknown>): Promise<unknown>
- xgroup(subcommand: "SETID", key: RedisKey, groupname: string | Buffer, newId: "$", entriesReadToken: "ENTRIESREAD", entriesRead: string | number, callback?: Callback<unknown>): Promise<unknown>
- \n
Create a consumer group.
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
id: string | number | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
id: string | number | Buffer
entriesReadToken: "ENTRIESREAD"
entriesRead: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
id: string | number | Buffer
mkstream: "MKSTREAM"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
id: string | number | Buffer
mkstream: "MKSTREAM"
entriesReadToken: "ENTRIESREAD"
entriesRead: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
newId: "$"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
newId: "$"
entriesReadToken: "ENTRIESREAD"
entriesRead: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
newId: "$"
mkstream: "MKSTREAM"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
newId: "$"
mkstream: "MKSTREAM"
entriesReadToken: "ENTRIESREAD"
entriesRead: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Create a consumer in a consumer group.
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
subcommand: "CREATECONSUMER"
key: RedisKey
groupname: string | Buffer
consumername: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Delete a consumer from a consumer group.
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "DELCONSUMER"
key: RedisKey
groupname: string | Buffer
consumername: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Destroy a consumer group.
\n- \n
- group: stream \n
- complexity: O(N) where N is the number of entries in the group's pending entries list (PEL). \n
- since: 5.0.0 \n
Parameters
subcommand: "DESTROY"
key: RedisKey
groupname: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Show helpful text about the different subcommands
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Set a consumer group to an arbitrary last delivered ID value.
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "SETID"
key: RedisKey
groupname: string | Buffer
id: string | number | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "SETID"
key: RedisKey
groupname: string | Buffer
id: string | number | Buffer
entriesReadToken: "ENTRIESREAD"
entriesRead: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "SETID"
key: RedisKey
groupname: string | Buffer
newId: "$"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "SETID"
key: RedisKey
groupname: string | Buffer
newId: "$"
entriesReadToken: "ENTRIESREAD"
entriesRead: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
xinfo
- xinfo(subcommand: "CONSUMERS", key: RedisKey, groupname: string | Buffer, callback?: Callback<unknown>): Promise<unknown>
- xinfo(subcommand: "GROUPS", key: RedisKey, callback?: Callback<unknown>): Promise<unknown>
- xinfo(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
- xinfo(subcommand: "STREAM", key: RedisKey, callback?: Callback<unknown>): Promise<unknown>
- xinfo(subcommand: "STREAM", key: RedisKey, fullToken: "FULL", callback?: Callback<unknown>): Promise<unknown>
- xinfo(subcommand: "STREAM", key: RedisKey, fullToken: "FULL", countToken: "COUNT", count: string | number, callback?: Callback<unknown>): Promise<unknown>
- \n
List the consumers in a consumer group
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "CONSUMERS"
key: RedisKey
groupname: string | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
List the consumer groups of a stream
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "GROUPS"
key: RedisKey
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Show helpful text about the different subcommands
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns Promise<unknown>
- \n
Get information about a stream
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "STREAM"
key: RedisKey
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "STREAM"
key: RedisKey
fullToken: "FULL"
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
subcommand: "STREAM"
key: RedisKey
fullToken: "FULL"
countToken: "COUNT"
count: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
xlen
- xlen(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Return the number of entries in a stream
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
xpending
- xpending(key: RedisKey, group: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- xpending(key: RedisKey, group: string | Buffer, start: string | number | Buffer, end: string | number | Buffer, count: string | number, callback?: Callback<unknown[]>): Promise<unknown[]>
- xpending(key: RedisKey, group: string | Buffer, start: string | number | Buffer, end: string | number | Buffer, count: string | number, consumer: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- xpending(key: RedisKey, group: string | Buffer, minIdleTimeToken: "IDLE", minIdleTime: string | number, start: string | number | Buffer, end: string | number | Buffer, count: string | number, callback?: Callback<unknown[]>): Promise<unknown[]>
- xpending(key: RedisKey, group: string | Buffer, minIdleTimeToken: "IDLE", minIdleTime: string | number, start: string | number | Buffer, end: string | number | Buffer, count: string | number, consumer: string | Buffer, callback?: Callback<unknown[]>): Promise<unknown[]>
- \n
Return information and entries from a stream consumer group pending entries list, that are messages fetched but never acknowledged.
\n- \n
- group: stream \n
- complexity: O(N) with N being the number of elements returned, so asking for a small fixed number of entries per call is O(1). O(M), where M is the total number of entries scanned when used with the IDLE filter. When the command returns just the summary and the list of consumers is small, it runs in O(1) time; otherwise, an additional O(N) time for iterating every consumer. \n
- since: 5.0.0 \n
Parameters
key: RedisKey
group: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
key: RedisKey
group: string | Buffer
start: string | number | Buffer
end: string | number | Buffer
count: string | number
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
key: RedisKey
group: string | Buffer
start: string | number | Buffer
end: string | number | Buffer
count: string | number
consumer: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
key: RedisKey
group: string | Buffer
minIdleTimeToken: "IDLE"
minIdleTime: string | number
start: string | number | Buffer
end: string | number | Buffer
count: string | number
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
Parameters
key: RedisKey
group: string | Buffer
minIdleTimeToken: "IDLE"
minIdleTime: string | number
start: string | number | Buffer
end: string | number | Buffer
count: string | number
consumer: string | Buffer
Optional callback: Callback<unknown[]>
Returns Promise<unknown[]>
xrange
- xrange(key: RedisKey, start: string | number | Buffer, end: string | number | Buffer, callback?: Callback<[id: string, fields: string[]][]>): Promise<[id: string, fields: string[]][]>
- xrange(key: RedisKey, start: string | number | Buffer, end: string | number | Buffer, countToken: "COUNT", count: string | number, callback?: Callback<[id: string, fields: string[]][]>): Promise<[id: string, fields: string[]][]>
- \n
Return a range of elements in a stream, with IDs matching the specified IDs interval
\n- \n
- group: stream \n
- complexity: O(N) with N being the number of elements being returned. If N is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1). \n
- since: 5.0.0 \n
Parameters
key: RedisKey
start: string | number | Buffer
end: string | number | Buffer
Optional callback: Callback<[id: string, fields: string[]][]>
Returns Promise<[id: string, fields: string[]][]>
Parameters
key: RedisKey
start: string | number | Buffer
end: string | number | Buffer
countToken: "COUNT"
count: string | number
Optional callback: Callback<[id: string, fields: string[]][]>
Returns Promise<[id: string, fields: string[]][]>
xrange
- xrange
Buffer(key: RedisKey, start: string | number | Buffer, end: string | number | Buffer, callback?: Callback<[id: Buffer, fields: Buffer[]][]>): Promise<[id: Buffer, fields: Buffer[]][]> - xrange
Buffer(key: RedisKey, start: string | number | Buffer, end: string | number | Buffer, countToken: "COUNT", count: string | number, callback?: Callback<[id: Buffer, fields: Buffer[]][]>): Promise<[id: Buffer, fields: Buffer[]][]>
Parameters
key: RedisKey
start: string | number | Buffer
end: string | number | Buffer
Optional callback: Callback<[id: Buffer, fields: Buffer[]][]>
Returns Promise<[id: Buffer, fields: Buffer[]][]>
Parameters
key: RedisKey
start: string | number | Buffer
end: string | number | Buffer
countToken: "COUNT"
count: string | number
Optional callback: Callback<[id: Buffer, fields: Buffer[]][]>
Returns Promise<[id: Buffer, fields: Buffer[]][]>
xread
- xread(...args: [streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]): Promise<[key: string, items: [id: string, fields: string[]][]][]>
- xread(...args: [streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<[key: string, items: [id: string, fields: string[]][]][]>
- xread(...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]): Promise<[key: string, items: [id: string, fields: string[]][]][]>
- xread(...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<[key: string, items: [id: string, fields: string[]][]][]>
- xread(...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]): Promise<[key: string, items: [id: string, fields: string[]][]][]>
- xread(...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<[key: string, items: [id: string, fields: string[]][]][]>
- xread(...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]): Promise<[key: string, items: [id: string, fields: string[]][]][]>
- xread(...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<[key: string, items: [id: string, fields: string[]][]][]>
- \n
Return never seen elements in multiple streams, with IDs greater than the ones reported by the caller for each stream. Can block.
\n- \n
- group: stream \n
- complexity: For each stream mentioned: O(N) with N being the number of elements being returned, it means that XREAD-ing with a fixed COUNT is O(1). Note that when the BLOCK option is used, XADD will pay O(M) time in order to serve the M clients blocked on the stream getting new data. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
Rest ...args: [streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
Rest ...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
Rest ...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
xread
- xread
Buffer(...args: [streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]> - xread
Buffer(...args: [streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]> - xread
Buffer(...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]> - xread
Buffer(...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]> - xread
Buffer(...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]> - xread
Buffer(...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]> - xread
Buffer(...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]> - xread
Buffer(...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
Rest ...args: [streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
Rest ...args: [streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
Rest ...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
Rest ...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
xreadgroup
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): Promise<unknown[]>
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]): Promise<unknown[]>
- \n
Return new entries from a stream using a consumer group, or access the history of the pending entries for a given consumer. Can block.
\n- \n
- group: stream \n
- complexity: For each stream mentioned: O(M) with M being the number of elements returned. If M is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1). On the other side when XREADGROUP blocks, XADD will pay the O(N) time in order to serve the N clients blocked on the stream getting new data. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<unknown[]>
xrevrange
- xrevrange(key: RedisKey, end: string | number | Buffer, start: string | number | Buffer, callback?: Callback<[id: string, fields: string[]][]>): Promise<[id: string, fields: string[]][]>
- xrevrange(key: RedisKey, end: string | number | Buffer, start: string | number | Buffer, countToken: "COUNT", count: string | number, callback?: Callback<[id: string, fields: string[]][]>): Promise<[id: string, fields: string[]][]>
- \n
Return a range of elements in a stream, with IDs matching the specified IDs interval, in reverse order (from greater to smaller IDs) compared to XRANGE
\n- \n
- group: stream \n
- complexity: O(N) with N being the number of elements returned. If N is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1). \n
- since: 5.0.0 \n
Parameters
key: RedisKey
end: string | number | Buffer
start: string | number | Buffer
Optional callback: Callback<[id: string, fields: string[]][]>
Returns Promise<[id: string, fields: string[]][]>
Parameters
key: RedisKey
end: string | number | Buffer
start: string | number | Buffer
countToken: "COUNT"
count: string | number
Optional callback: Callback<[id: string, fields: string[]][]>
Returns Promise<[id: string, fields: string[]][]>
xrevrange
- xrevrange
Buffer(key: RedisKey, end: string | number | Buffer, start: string | number | Buffer, callback?: Callback<[id: Buffer, fields: Buffer[]][]>): Promise<[id: Buffer, fields: Buffer[]][]> - xrevrange
Buffer(key: RedisKey, end: string | number | Buffer, start: string | number | Buffer, countToken: "COUNT", count: string | number, callback?: Callback<[id: Buffer, fields: Buffer[]][]>): Promise<[id: Buffer, fields: Buffer[]][]>
Parameters
key: RedisKey
end: string | number | Buffer
start: string | number | Buffer
Optional callback: Callback<[id: Buffer, fields: Buffer[]][]>
Returns Promise<[id: Buffer, fields: Buffer[]][]>
Parameters
key: RedisKey
end: string | number | Buffer
start: string | number | Buffer
countToken: "COUNT"
count: string | number
Optional callback: Callback<[id: Buffer, fields: Buffer[]][]>
Returns Promise<[id: Buffer, fields: Buffer[]][]>
xsetid
- xsetid(key: RedisKey, lastId: string | number | Buffer, callback?: Callback<unknown>): Promise<unknown>
- xsetid(key: RedisKey, lastId: string | number | Buffer, maxDeletedEntryIdToken: "MAXDELETEDID", maxDeletedEntryId: string | number | Buffer, callback?: Callback<unknown>): Promise<unknown>
- xsetid(key: RedisKey, lastId: string | number | Buffer, entriesAddedToken: "ENTRIESADDED", entriesAdded: string | number, callback?: Callback<unknown>): Promise<unknown>
- xsetid(key: RedisKey, lastId: string | number | Buffer, entriesAddedToken: "ENTRIESADDED", entriesAdded: string | number, maxDeletedEntryIdToken: "MAXDELETEDID", maxDeletedEntryId: string | number | Buffer, callback?: Callback<unknown>): Promise<unknown>
- \n
An internal command for replicating stream values
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
key: RedisKey
lastId: string | number | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
lastId: string | number | Buffer
maxDeletedEntryIdToken: "MAXDELETEDID"
maxDeletedEntryId: string | number | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
lastId: string | number | Buffer
entriesAddedToken: "ENTRIESADDED"
entriesAdded: string | number
Optional callback: Callback<unknown>
Returns Promise<unknown>
Parameters
key: RedisKey
lastId: string | number | Buffer
entriesAddedToken: "ENTRIESADDED"
entriesAdded: string | number
maxDeletedEntryIdToken: "MAXDELETEDID"
maxDeletedEntryId: string | number | Buffer
Optional callback: Callback<unknown>
Returns Promise<unknown>
xtrim
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, acked: "ACKED", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, keepref: "KEEPREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, delref: "DELREF", callback?: Callback<number>): Promise<number>
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, acked: "ACKED", callback?: Callback<number>): Promise<number>
- \n
Deletes messages from the beginning of a stream.
\n- \n
- group: stream \n
- complexity: O(N), with N being the number of evicted entries. Constant times are very small however, since entries are organized in macro nodes containing multiple entries that can be released with a single deallocation. \n
- since: 5.0.0 \n
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
delref: "DELREF"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
acked: "ACKED"
Optional callback: Callback<number>
Returns Promise<number>
zadd
- zadd(...args: [key: RedisKey, ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, gt: "GT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, gt: "GT", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, lt: "LT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, lt: "LT", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): Promise<number>
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): Promise<string>
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<string>
- \n
Add one or more members to a sorted set, or update its score if it already exists
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) for each item added, where N is the number of elements in the sorted set. \n
- since: 1.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<string>
zadd
- zadd
Buffer(...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): Promise<Buffer> - zadd
Buffer(...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns Promise<Buffer>
zcard
- zcard(key: RedisKey, callback?: Callback<number>): Promise<number>
- \n
Get the number of members in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(1) \n
- since: 1.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns Promise<number>
zcount
- zcount(key: RedisKey, min: string | number, max: string | number, callback?: Callback<number>): Promise<number>
- \n
Count the members in a sorted set with scores within the given values
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) with N being the number of elements in the sorted set. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
min: string | number
max: string | number
Optional callback: Callback<number>
Returns Promise<number>
zdiff
- zdiff(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- zdiff(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- zdiff(...args: [numkeys: string | number, ...keys: RedisKey[]]): Promise<string[]>
- zdiff(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<string[]>
- zdiff(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zdiff(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zdiff(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]): Promise<string[]>
- zdiff(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]): Promise<string[]>
- \n
Subtract multiple sorted sets
\n- \n
- group: sorted-set \n
- complexity: O(L + (N-K)log(N)) worst case where L is the total number of elements in all the sets, N is the size of the first set, and K is the size of the result set. \n
- since: 6.2.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<string[]>
zdiff
- zdiff
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zdiff
Buffer(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zdiff
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[]]): Promise<Buffer[]> - zdiff
Buffer(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<Buffer[]> - zdiff
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zdiff
Buffer(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zdiff
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]): Promise<Buffer[]> - zdiff
Buffer(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]): Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
zdiffstore
- zdiffstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- zdiffstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], callback: Callback<number>]): Promise<number>
- zdiffstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[]]): Promise<number>
- zdiffstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[]]): Promise<number>
- \n
Subtract multiple sorted sets and store the resulting sorted set in a new key
\n- \n
- group: sorted-set \n
- complexity: O(L + (N-K)log(N)) worst case where L is the total number of elements in all the sets, N is the size of the first set, and K is the size of the result set. \n
- since: 6.2.0 \n
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
zincrby
- zincrby(key: RedisKey, increment: string | number, member: string | number | Buffer, callback?: Callback<string>): Promise<string>
- \n
Increment the score of a member in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) where N is the number of elements in the sorted set. \n
- since: 1.2.0 \n
Parameters
key: RedisKey
increment: string | number
member: string | number | Buffer
Optional callback: Callback<string>
Returns Promise<string>
zincrby
- zincrby
Buffer(key: RedisKey, increment: string | number, member: string | number | Buffer, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
increment: string | number
member: string | number | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
zinter
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[]]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[]]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<string[]>
- \n
Intersect multiple sorted sets
\n- \n
- group: sorted-set \n
- complexity: O(NK)+O(Mlog(M)) worst case with N being the smallest input sorted set, K being the number of input sorted sets and M being the number of elements in the resulting sorted set. \n
- since: 6.2.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[]]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<string[]>
zinter
- zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[]]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[]]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
zintercard
- zintercard(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- zintercard(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<number>]): Promise<number>
- zintercard(...args: [numkeys: string | number, ...keys: RedisKey[]]): Promise<number>
- zintercard(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<number>
- zintercard(...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]): Promise<number>
- zintercard(...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]): Promise<number>
- zintercard(...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number]): Promise<number>
- zintercard(...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number]): Promise<number>
- \n
Intersect multiple sorted sets and return the cardinality of the result
\n- \n
- group: sorted-set \n
- complexity: O(N*K) worst case with N being the smallest input sorted set, K being the number of input sorted sets. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number]
Returns Promise<number>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number]
Returns Promise<number>
zinterstore
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[]]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[]]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[]]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]): Promise<number>
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]): Promise<number>
- \n
Intersect multiple sorted sets and store the resulting sorted set in a new key
\n- \n
- group: sorted-set \n
- complexity: O(NK)+O(Mlog(M)) worst case with N being the smallest input sorted set, K being the number of input sorted sets and M being the number of elements in the resulting sorted set. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<number>
zlexcount
- zlexcount(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Count the number of members in a sorted set between a given lexicographical range
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) with N being the number of elements in the sorted set. \n
- since: 2.8.9 \n
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
zmpop
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN", callback: Callback<unknown>]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], min: "MIN", callback: Callback<unknown>]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN"]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], min: "MIN"]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX", callback: Callback<unknown>]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], max: "MAX", callback: Callback<unknown>]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX"]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], max: "MAX"]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]): Promise<unknown>
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]): Promise<unknown>
- \n
Remove and return members with scores in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(K) + O(N*log(M)) where K is the number of provided keys, N being the number of elements in the sorted set, and M being the number of elements popped. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], min: "MIN", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN"]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], min: "MIN"]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], max: "MAX", callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX"]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], max: "MAX"]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]
Returns Promise<unknown>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]
Returns Promise<unknown>
zmscore
- zmscore(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- zmscore(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<string[]>]): Promise<string[]>
- zmscore(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): Promise<string[]>
- zmscore(...args: [key: RedisKey, members: (string | number | Buffer)[]]): Promise<string[]>
- \n
Get the score associated with the given members in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(N) where N is the number of members being requested. \n
- since: 6.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<string[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<string[]>
zmscore
- zmscore
Buffer(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zmscore
Buffer(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zmscore
Buffer(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): Promise<Buffer[]> - zmscore
Buffer(...args: [key: RedisKey, members: (string | number | Buffer)[]]): Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<Buffer[]>
zpopmax
- zpopmax(key: RedisKey, callback?: Callback<string[]>): Promise<string[]>
- zpopmax(key: RedisKey, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Remove and return members with the highest scores in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(log(N)*M) with N being the number of elements in the sorted set, and M being the number of elements popped. \n
- since: 5.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
zpopmax
zpopmin
- zpopmin(key: RedisKey, callback?: Callback<string[]>): Promise<string[]>
- zpopmin(key: RedisKey, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Remove and return members with the lowest scores in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(log(N)*M) with N being the number of elements in the sorted set, and M being the number of elements popped. \n
- since: 5.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
zpopmin
zrandmember
- zrandmember(key: RedisKey, callback?: Callback<string>): Promise<string>
- zrandmember(key: RedisKey, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrandmember(key: RedisKey, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- \n
Get one or multiple random elements from a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(N) where N is the number of elements returned \n
- since: 6.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns Promise<string>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
zrandmember
- zrandmember
Buffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer> - zrandmember
Buffer(key: RedisKey, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrandmember
Buffer(key: RedisKey, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
zrange
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- \n
Return a range of members in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements returned. \n
- since: 1.2.0 \n
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
zrange
- zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
zrangebylex
- zrangebylex(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<string[]>): Promise<string[]>
- zrangebylex(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Return a range of members in a sorted set, by lexicographical range
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)). \n
- since: 2.8.9 \n
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
zrangebylex
- zrangebylex
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrangebylex
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
zrangebyscore
- zrangebyscore(key: RedisKey, min: string | number, max: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrangebyscore(key: RedisKey, min: string | number, max: string | number, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrangebyscore(key: RedisKey, min: string | number, max: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrangebyscore(key: RedisKey, min: string | number, max: string | number, withscores: "WITHSCORES", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Return a range of members in a sorted set, by score
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)). \n
- since: 1.0.5 \n
Parameters
key: RedisKey
min: string | number
max: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number
max: string | number
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number
max: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
min: string | number
max: string | number
withscores: "WITHSCORES"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
zrangebyscore
- zrangebyscore
Buffer(key: RedisKey, min: string | number, max: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrangebyscore
Buffer(key: RedisKey, min: string | number, max: string | number, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrangebyscore
Buffer(key: RedisKey, min: string | number, max: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrangebyscore
Buffer(key: RedisKey, min: string | number, max: string | number, withscores: "WITHSCORES", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number
max: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number
max: string | number
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number
max: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
min: string | number
max: string | number
withscores: "WITHSCORES"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
zrangestore
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", callback?: Callback<number>): Promise<number>
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<number>): Promise<number>
- \n
Store a range of members from sorted set into another key
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements stored into the destination key. \n
- since: 6.2.0 \n
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
Optional callback: Callback<number>
Returns Promise<number>
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<number>
Returns Promise<number>
zrank
- zrank(key: RedisKey, member: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Determine the index of a member in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
member: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
zrem
- zrem(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zrem(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number>]): Promise<number>
- zrem(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): Promise<number>
- zrem(...args: [key: RedisKey, members: (string | number | Buffer)[]]): Promise<number>
- \n
Remove one or more members from a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(M*log(N)) with N being the number of elements in the sorted set and M the number of elements to be removed. \n
- since: 1.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<number>
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<number>
zremrangebylex
- zremrangebylex(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Remove all members in a sorted set between the given lexicographical range
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation. \n
- since: 2.8.9 \n
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
zremrangebyrank
- zremrangebyrank(key: RedisKey, start: string | number, stop: string | number, callback?: Callback<number>): Promise<number>
- \n
Remove all members in a sorted set within the given indexes
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
start: string | number
stop: string | number
Optional callback: Callback<number>
Returns Promise<number>
zremrangebyscore
- zremrangebyscore(key: RedisKey, min: string | number, max: string | number, callback?: Callback<number>): Promise<number>
- \n
Remove all members in a sorted set within the given scores
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation. \n
- since: 1.2.0 \n
Parameters
key: RedisKey
min: string | number
max: string | number
Optional callback: Callback<number>
Returns Promise<number>
zrevrange
- zrevrange(key: RedisKey, start: string | number, stop: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrevrange(key: RedisKey, start: string | number, stop: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- \n
Return a range of members in a sorted set, by index, with scores ordered from high to low
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements returned. \n
- since: 1.2.0 \n
Parameters
key: RedisKey
start: string | number
stop: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
start: string | number
stop: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
zrevrange
zrevrangebylex
- zrevrangebylex(key: RedisKey, max: string | number | Buffer, min: string | number | Buffer, callback?: Callback<string[]>): Promise<string[]>
- zrevrangebylex(key: RedisKey, max: string | number | Buffer, min: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Return a range of members in a sorted set, by lexicographical range, ordered from higher to lower strings.
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)). \n
- since: 2.8.9 \n
Parameters
key: RedisKey
max: string | number | Buffer
min: string | number | Buffer
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
max: string | number | Buffer
min: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
zrevrangebylex
- zrevrangebylex
Buffer(key: RedisKey, max: string | number | Buffer, min: string | number | Buffer, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrevrangebylex
Buffer(key: RedisKey, max: string | number | Buffer, min: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
max: string | number | Buffer
min: string | number | Buffer
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
max: string | number | Buffer
min: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
zrevrangebyscore
- zrevrangebyscore(key: RedisKey, max: string | number, min: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrevrangebyscore(key: RedisKey, max: string | number, min: string | number, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- zrevrangebyscore(key: RedisKey, max: string | number, min: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Promise<string[]>
- zrevrangebyscore(key: RedisKey, max: string | number, min: string | number, withscores: "WITHSCORES", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): Promise<string[]>
- \n
Return a range of members in a sorted set, by score, with scores ordered from high to low
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)). \n
- since: 2.2.0 \n
Parameters
key: RedisKey
max: string | number
min: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
max: string | number
min: string | number
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
max: string | number
min: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns Promise<string[]>
Parameters
key: RedisKey
max: string | number
min: string | number
withscores: "WITHSCORES"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns Promise<string[]>
zrevrangebyscore
- zrevrangebyscore
Buffer(key: RedisKey, max: string | number, min: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrevrangebyscore
Buffer(key: RedisKey, max: string | number, min: string | number, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrevrangebyscore
Buffer(key: RedisKey, max: string | number, min: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Promise<Buffer[]> - zrevrangebyscore
Buffer(key: RedisKey, max: string | number, min: string | number, withscores: "WITHSCORES", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
key: RedisKey
max: string | number
min: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
max: string | number
min: string | number
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
max: string | number
min: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Parameters
key: RedisKey
max: string | number
min: string | number
withscores: "WITHSCORES"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns Promise<Buffer[]>
zrevrank
- zrevrank(key: RedisKey, member: string | number | Buffer, callback?: Callback<number>): Promise<number>
- \n
Determine the index of a member in a sorted set, with scores ordered from high to low
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
member: string | number | Buffer
Optional callback: Callback<number>
Returns Promise<number>
zscan
- zscan(key: RedisKey, cursor: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- zscan(key: RedisKey, cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- zscan(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- zscan(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): Promise<[cursor: string, elements: string[]]>
- \n
Incrementally iterate sorted sets elements and associated scores
\n- \n
- group: sorted-set \n
- complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.. \n
- since: 2.8.0 \n
Parameters
key: RedisKey
cursor: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
key: RedisKey
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
zscan
- zscan
Buffer(key: RedisKey, cursor: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - zscan
Buffer(key: RedisKey, cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - zscan
Buffer(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]> - zscan
Buffer(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
zscan
- zscan
Buffer Stream(key: string, options?: ScanStreamOptions): default
Parameters
key: string
Optional options: ScanStreamOptions
Returns default
zscan
- zscan
Stream(key: string, options?: ScanStreamOptions): default
Parameters
key: string
Optional options: ScanStreamOptions
Returns default
zscore
- zscore(key: RedisKey, member: string | number | Buffer, callback?: Callback<string>): Promise<string>
- \n
Get the score associated with the given member in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(1) \n
- since: 1.2.0 \n
Parameters
key: RedisKey
member: string | number | Buffer
Optional callback: Callback<string>
Returns Promise<string>
zscore
- zscore
Buffer(key: RedisKey, member: string | number | Buffer, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
key: RedisKey
member: string | number | Buffer
Optional callback: Callback<Buffer>
Returns Promise<Buffer>
zunion
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[]]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[]]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]): Promise<string[]>
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<string[]>
- \n
Add multiple sorted sets
\n- \n
- group: sorted-set \n
- complexity: O(N)+O(M*log(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set. \n
- since: 6.2.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[]]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns Promise<string[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<string[]>
zunion
- zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[]]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[]]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): Promise<Buffer[]> - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[]]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
zunionstore
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[]]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[]]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[]]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]): Promise<number>
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]): Promise<number>
- \n
Add multiple sorted sets and store the resulting sorted set in a new key
\n- \n
- group: sorted-set \n
- complexity: O(N)+O(M log(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]
Returns Promise<number>
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<number>
Static create
- create
Client(...args: []): Redis
- \n
Create a Redis instance.\nThis is the same as
\nnew Redis()but is included for compatibility with node-redis.Parameters
Rest ...args: []
Returns Redis
Generated using TypeDoc
ioredis
Index
References
default
Renames and re-exports RedisType Aliases
Cluster
Cluster
DNSLookup
DNSLookup
Type declaration
- (hostname: string, callback: ((err: NodeJS.ErrnoException | null | undefined, address: string, family?: number) => void)): void
Parameters
hostname: string
callback: ((err: NodeJS.ErrnoException | null | undefined, address: string, family?: number) => void)
- (err: NodeJS.ErrnoException | null | undefined, address: string, family?: number): void
Parameters
err: NodeJS.ErrnoException | null | undefined
address: string
Optional family: number
Returns void
Returns void
DNSResolve
DNSResolve
Type declaration
- (hostname: string, callback: ((err: NodeJS.ErrnoException | null | undefined, records?: SrvRecord[]) => void)): void
Parameters
hostname: string
callback: ((err: NodeJS.ErrnoException | null | undefined, records?: SrvRecord[]) => void)
- (err: NodeJS.ErrnoException | null | undefined, records?: SrvRecord[]): void
Parameters
err: NodeJS.ErrnoException | null | undefined
Optional records: SrvRecord[]
Returns void
Returns void
Nat
Nat
Node
Node
Redis
Redis
Redis
Redis
Redis
Standalone
Standalone
Variables
Const Reply
Reply
Generated using TypeDoc
Interface ChainableCommander
Hierarchy
- RedisCommander<{ type: "pipeline" }>
- ChainableCommander
Index
Properties
Methods
- acl
- acl
Buffer - append
- asking
- auth
- bgrewriteaof
- bgrewriteaof
Buffer - bgsave
- bitcount
- bitfield
- bitfield_
ro - bitop
- bitpos
- blmove
- blmove
Buffer - blmpop
- blmpop
Buffer - blpop
- blpop
Buffer - brpop
- brpop
Buffer - brpoplpush
- brpoplpush
Buffer - bzmpop
- bzpopmax
- bzpopmax
Buffer - bzpopmin
- bzpopmin
Buffer - call
- call
Buffer - client
- client
Buffer - cluster
- command
- config
- copy
- dbsize
- debug
- decr
- decrby
- del
- discard
- dump
- dump
Buffer - echo
- echo
Buffer - eval
- eval_
ro - evalsha
- evalsha_
ro - exec
- exists
- expire
- expireat
- expiretime
- failover
- fcall
- fcall_
ro - flushall
- flushdb
- function
- function
Buffer - geoadd
- geodist
- geodist
Buffer - geohash
- geohash
Buffer - geopos
- georadius
- georadius_
ro - georadiusbymember
- georadiusbymember_
ro - geosearch
- geosearchstore
- get
- get
Buffer - getbit
- getdel
- getdel
Buffer - getex
- getex
Buffer - getrange
- getrange
Buffer - getset
- getset
Buffer - hdel
- hello
- hexists
- hexpire
- hexpireat
- hexpiretime
- hget
- hget
Buffer - hgetall
- hgetall
Buffer - hgetdel
- hgetdel
Buffer - hgetex
- hgetex
Buffer - hincrby
- hincrbyfloat
- hincrbyfloat
Buffer - hkeys
- hkeys
Buffer - hlen
- hmget
- hmget
Buffer - hmset
- hpersist
- hpexpire
- hpexpireat
- hpexpiretime
- hpttl
- hrandfield
- hrandfield
Buffer - hscan
- hscan
Buffer - hset
- hsetex
- hsetnx
- hstrlen
- httl
- hvals
- hvals
Buffer - incr
- incrby
- incrbyfloat
- info
- keys
- keys
Buffer - lastsave
- latency
- lcs
- lindex
- lindex
Buffer - linsert
- llen
- lmove
- lmove
Buffer - lmpop
- lmpop
Buffer - lolwut
- lpop
- lpop
Buffer - lpos
- lpush
- lpushx
- lrange
- lrange
Buffer - lrem
- lset
- ltrim
- memory
- mget
- mget
Buffer - migrate
- module
- move
- mset
- msetnx
- object
- persist
- pexpire
- pexpireat
- pexpiretime
- pfadd
- pfcount
- pfdebug
- pfmerge
- pfselftest
- ping
- ping
Buffer - psetex
- psubscribe
- psync
- pttl
- publish
- pubsub
- punsubscribe
- quit
- randomkey
- randomkey
Buffer - readonly
- readwrite
- rename
- renamenx
- replconf
- replicaof
- reset
- restore
- restore-
asking - role
- rpop
- rpop
Buffer - rpoplpush
- rpoplpush
Buffer - rpush
- rpushx
- sadd
- save
- scan
- scan
Buffer - scard
- script
- sdiff
- sdiff
Buffer - sdiffstore
- select
- set
- set
Buffer - setbit
- setex
- setnx
- setrange
- shutdown
- sinter
- sinter
Buffer - sintercard
- sinterstore
- sismember
- slaveof
- slowlog
- smembers
- smembers
Buffer - smismember
- smove
- sort
- sort_
ro - spop
- spop
Buffer - spublish
- srandmember
- srandmember
Buffer - srem
- sscan
- sscan
Buffer - ssubscribe
- strlen
- subscribe
- substr
- sunion
- sunion
Buffer - sunionstore
- sunsubscribe
- swapdb
- sync
- time
- touch
- ttl
- type
- unlink
- unsubscribe
- unwatch
- wait
- watch
- xack
- xadd
- xadd
Buffer - xautoclaim
- xclaim
- xdel
- xdelex
- xgroup
- xinfo
- xlen
- xpending
- xrange
- xrange
Buffer - xread
- xread
Buffer - xreadgroup
- xrevrange
- xrevrange
Buffer - xsetid
- xtrim
- zadd
- zadd
Buffer - zcard
- zcount
- zdiff
- zdiff
Buffer - zdiffstore
- zincrby
- zincrby
Buffer - zinter
- zinter
Buffer - zintercard
- zinterstore
- zlexcount
- zmpop
- zmscore
- zmscore
Buffer - zpopmax
- zpopmax
Buffer - zpopmin
- zpopmin
Buffer - zrandmember
- zrandmember
Buffer - zrange
- zrange
Buffer - zrangebylex
- zrangebylex
Buffer - zrangebyscore
- zrangebyscore
Buffer - zrangestore
- zrank
- zrem
- zremrangebylex
- zremrangebyrank
- zremrangebyscore
- zrevrange
- zrevrange
Buffer - zrevrangebylex
- zrevrangebylex
Buffer - zrevrangebyscore
- zrevrangebyscore
Buffer - zrevrank
- zscan
- zscan
Buffer - zscore
- zscore
Buffer - zunion
- zunion
Buffer - zunionstore
Properties
length
length: number
Methods
acl
- acl(subcommand: "CAT", callback?: Callback<unknown>): ChainableCommander
- acl(subcommand: "CAT", categoryname: string | Buffer, callback?: Callback<unknown>): ChainableCommander
- acl(...args: [subcommand: "DELUSER", ...usernames: (string | Buffer)[], callback: Callback<number>]): ChainableCommander
- acl(...args: [subcommand: "DELUSER", ...usernames: (string | Buffer)[]]): ChainableCommander
- acl(subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, callback?: Callback<string>): ChainableCommander
- acl(...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- acl(...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[]]): ChainableCommander
- acl(subcommand: "GENPASS", callback?: Callback<string>): ChainableCommander
- acl(subcommand: "GENPASS", bits: string | number, callback?: Callback<string>): ChainableCommander
- acl(subcommand: "GETUSER", username: string | Buffer, callback?: Callback<string[]>): ChainableCommander
- acl(subcommand: "HELP", callback?: Callback<unknown>): ChainableCommander
- acl(subcommand: "LIST", callback?: Callback<string[]>): ChainableCommander
- acl(subcommand: "LOAD", callback?: Callback<"OK">): ChainableCommander
- acl(subcommand: "LOG", callback?: Callback<unknown>): ChainableCommander
- acl(subcommand: "LOG", count: string | number, callback?: Callback<unknown>): ChainableCommander
- acl(subcommand: "LOG", reset: "RESET", callback?: Callback<unknown>): ChainableCommander
- acl(subcommand: "SAVE", callback?: Callback<"OK">): ChainableCommander
- acl(subcommand: "SETUSER", username: string | Buffer, callback?: Callback<"OK">): ChainableCommander
- acl(...args: [subcommand: "SETUSER", username: string | Buffer, ...rules: (string | Buffer)[], callback: Callback<"OK">]): ChainableCommander
- acl(...args: [subcommand: "SETUSER", username: string | Buffer, ...rules: (string | Buffer)[]]): ChainableCommander
- acl(subcommand: "USERS", callback?: Callback<string[]>): ChainableCommander
- acl(subcommand: "WHOAMI", callback?: Callback<string>): ChainableCommander
- \n
List the ACL categories or the commands inside a category
\n- \n
- group: server \n
- complexity: O(1) since the categories and commands are a fixed set. \n
- since: 6.0.0 \n
Parameters
subcommand: "CAT"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "CAT"
categoryname: string | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Remove the specified ACL users and the associated rules
\n- \n
- group: server \n
- complexity: O(1) amortized time considering the typical user. \n
- since: 6.0.0 \n
Parameters
Rest ...args: [subcommand: "DELUSER", ...usernames: (string | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "DELUSER", ...usernames: (string | Buffer)[]]
Returns ChainableCommander
- \n
Returns whether the user can execute the given command without executing the command.
\n- \n
- group: server \n
- complexity: O(1). \n
- since: 7.0.0 \n
Parameters
subcommand: "DRYRUN"
username: string | Buffer
command: string | Buffer
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[]]
Returns ChainableCommander
- \n
Generate a pseudorandom secure password to use for ACL users
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 6.0.0 \n
Parameters
subcommand: "GENPASS"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
subcommand: "GENPASS"
bits: string | number
Optional callback: Callback<string>
Returns ChainableCommander
- \n
Get the rules for a specific ACL user
\n- \n
- group: server \n
- complexity: O(N). Where N is the number of password, command and pattern rules that the user has. \n
- since: 6.0.0 \n
Parameters
subcommand: "GETUSER"
username: string | Buffer
Optional callback: Callback<string[]>
Returns ChainableCommander
- \n
Show helpful text about the different subcommands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 6.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
List the current ACL rules in ACL config file format
\n- \n
- group: server \n
- complexity: O(N). Where N is the number of configured users. \n
- since: 6.0.0 \n
Parameters
subcommand: "LIST"
Optional callback: Callback<string[]>
Returns ChainableCommander
- \n
Reload the ACLs from the configured ACL file
\n- \n
- group: server \n
- complexity: O(N). Where N is the number of configured users. \n
- since: 6.0.0 \n
Parameters
subcommand: "LOAD"
Optional callback: Callback<"OK">
Returns ChainableCommander
- \n
List latest events denied because of ACLs in place
\n- \n
- group: server \n
- complexity: O(N) with N being the number of entries shown. \n
- since: 6.0.0 \n
Parameters
subcommand: "LOG"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "LOG"
count: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "LOG"
reset: "RESET"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Save the current ACL rules in the configured ACL file
\n- \n
- group: server \n
- complexity: O(N). Where N is the number of configured users. \n
- since: 6.0.0 \n
Parameters
subcommand: "SAVE"
Optional callback: Callback<"OK">
Returns ChainableCommander
- \n
Modify or create the rules for a specific ACL user
\n- \n
- group: server \n
- complexity: O(N). Where N is the number of rules provided. \n
- since: 6.0.0 \n
Parameters
subcommand: "SETUSER"
username: string | Buffer
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "SETUSER", username: string | Buffer, ...rules: (string | Buffer)[], callback: Callback<"OK">]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "SETUSER", username: string | Buffer, ...rules: (string | Buffer)[]]
Returns ChainableCommander
- \n
List the username of all the configured ACL rules
\n- \n
- group: server \n
- complexity: O(N). Where N is the number of configured users. \n
- since: 6.0.0 \n
Parameters
subcommand: "USERS"
Optional callback: Callback<string[]>
Returns ChainableCommander
- \n
Return the name of the user associated to the current connection
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 6.0.0 \n
Parameters
subcommand: "WHOAMI"
Optional callback: Callback<string>
Returns ChainableCommander
acl
- acl
Buffer(subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, callback?: Callback<Buffer>): ChainableCommander - acl
Buffer(...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - acl
Buffer(...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[]]): ChainableCommander - acl
Buffer(subcommand: "GENPASS", callback?: Callback<Buffer>): ChainableCommander - acl
Buffer(subcommand: "GENPASS", bits: string | number, callback?: Callback<Buffer>): ChainableCommander - acl
Buffer(subcommand: "GETUSER", username: string | Buffer, callback?: Callback<Buffer[]>): ChainableCommander - acl
Buffer(subcommand: "LIST", callback?: Callback<Buffer[]>): ChainableCommander - acl
Buffer(subcommand: "USERS", callback?: Callback<Buffer[]>): ChainableCommander - acl
Buffer(subcommand: "WHOAMI", callback?: Callback<Buffer>): ChainableCommander
Parameters
subcommand: "DRYRUN"
username: string | Buffer
command: string | Buffer
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, ...args: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
subcommand: "GENPASS"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
subcommand: "GENPASS"
bits: string | number
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
subcommand: "GETUSER"
username: string | Buffer
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
subcommand: "LIST"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
subcommand: "USERS"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
subcommand: "WHOAMI"
Optional callback: Callback<Buffer>
Returns ChainableCommander
append
- append(key: RedisKey, value: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- \n
Append a value to a key
\n- \n
- group: string \n
- complexity: O(1). The amortized time complexity is O(1) assuming the appended value is small and the already present value is of any size, since the dynamic string library used by Redis will double the free space available on every reallocation. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
value: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
asking
- asking(callback?: Callback<"OK">): ChainableCommander
- \n
Sent by cluster clients after an -ASK redirect
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns ChainableCommander
auth
- auth(password: string | Buffer, callback?: Callback<"OK">): ChainableCommander
- auth(username: string | Buffer, password: string | Buffer, callback?: Callback<"OK">): ChainableCommander
- \n
Authenticate to the server
\n- \n
- group: connection \n
- complexity: O(N) where N is the number of passwords defined for the user \n
- since: 1.0.0 \n
Parameters
password: string | Buffer
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
username: string | Buffer
password: string | Buffer
Optional callback: Callback<"OK">
Returns ChainableCommander
bgrewriteaof
- bgrewriteaof(callback?: Callback<string>): ChainableCommander
- \n
Asynchronously rewrite the append-only file
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<string>
Returns ChainableCommander
bgrewriteaof
- bgrewriteaof
Buffer(callback?: Callback<Buffer>): ChainableCommander
Parameters
Optional callback: Callback<Buffer>
Returns ChainableCommander
bgsave
- bgsave(callback?: Callback<"OK">): ChainableCommander
- bgsave(schedule: "SCHEDULE", callback?: Callback<"OK">): ChainableCommander
- \n
Asynchronously save the dataset to disk
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
schedule: "SCHEDULE"
Optional callback: Callback<"OK">
Returns ChainableCommander
bitcount
- bitcount(key: RedisKey, callback?: Callback<number>): ChainableCommander
- bitcount(key: RedisKey, start: string | number, end: string | number, callback?: Callback<number>): ChainableCommander
- bitcount(key: RedisKey, start: string | number, end: string | number, byte: "BYTE", callback?: Callback<number>): ChainableCommander
- bitcount(key: RedisKey, start: string | number, end: string | number, bit: "BIT", callback?: Callback<number>): ChainableCommander
- \n
Count set bits in a string
\n- \n
- group: bitmap \n
- complexity: O(N) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
start: string | number
end: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
start: string | number
end: string | number
byte: "BYTE"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
start: string | number
end: string | number
bit: "BIT"
Optional callback: Callback<number>
Returns ChainableCommander
bitfield
- bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: string | number, callback?: Callback<unknown>): ChainableCommander
- bitfield(key: RedisKey, encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: string | number, value: string | number, callback?: Callback<unknown>): ChainableCommander
- bitfield(key: RedisKey, encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: string | number, increment: string | number, callback?: Callback<unknown>): ChainableCommander
- bitfield(key: RedisKey, overflow: "OVERFLOW", wrap: "WRAP", encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: string | number, value: string | number, callback?: Callback<unknown>): ChainableCommander
- bitfield(key: RedisKey, overflow: "OVERFLOW", wrap: "WRAP", encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: string | number, increment: string | number, callback?: Callback<unknown>): ChainableCommander
- bitfield(key: RedisKey, overflow: "OVERFLOW", sat: "SAT", encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: string | number, value: string | number, callback?: Callback<unknown>): ChainableCommander
- bitfield(key: RedisKey, overflow: "OVERFLOW", sat: "SAT", encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: string | number, increment: string | number, callback?: Callback<unknown>): ChainableCommander
- bitfield(key: RedisKey, overflow: "OVERFLOW", fail: "FAIL", encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: string | number, value: string | number, callback?: Callback<unknown>): ChainableCommander
- bitfield(key: RedisKey, overflow: "OVERFLOW", fail: "FAIL", encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: string | number, increment: string | number, callback?: Callback<unknown>): ChainableCommander
- \n
Perform arbitrary bitfield integer operations on strings
\n- \n
- group: bitmap \n
- complexity: O(1) for each subcommand specified \n
- since: 3.2.0 \n
Parameters
key: RedisKey
encodingOffsetToken: "GET"
encoding: string | Buffer
offset: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
encodingOffsetValueToken: "SET"
encoding: string | Buffer
offset: string | number
value: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
encodingOffsetIncrementToken: "INCRBY"
encoding: string | Buffer
offset: string | number
increment: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
overflow: "OVERFLOW"
wrap: "WRAP"
encodingOffsetValueToken: "SET"
encoding: string | Buffer
offset: string | number
value: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
overflow: "OVERFLOW"
wrap: "WRAP"
encodingOffsetIncrementToken: "INCRBY"
encoding: string | Buffer
offset: string | number
increment: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
overflow: "OVERFLOW"
sat: "SAT"
encodingOffsetValueToken: "SET"
encoding: string | Buffer
offset: string | number
value: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
overflow: "OVERFLOW"
sat: "SAT"
encodingOffsetIncrementToken: "INCRBY"
encoding: string | Buffer
offset: string | number
increment: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
overflow: "OVERFLOW"
fail: "FAIL"
encodingOffsetValueToken: "SET"
encoding: string | Buffer
offset: string | number
value: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
overflow: "OVERFLOW"
fail: "FAIL"
encodingOffsetIncrementToken: "INCRBY"
encoding: string | Buffer
offset: string | number
increment: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
bitfield_
- bitfield_
ro(...args: [key: RedisKey, encodingOffsetToken: "GET", ...encodingOffsets: (string | number | Buffer)[], callback: Callback<unknown[]>]): ChainableCommander - bitfield_
ro(...args: [key: RedisKey, encodingOffsetToken: "GET", ...encodingOffsets: (string | number | Buffer)[]]): ChainableCommander
- \n
Perform arbitrary bitfield integer operations on strings. Read-only variant of BITFIELD
\n- \n
- group: bitmap \n
- complexity: O(1) for each subcommand specified \n
- since: 6.0.0 \n
Parameters
Rest ...args: [key: RedisKey, encodingOffsetToken: "GET", ...encodingOffsets: (string | number | Buffer)[], callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, encodingOffsetToken: "GET", ...encodingOffsets: (string | number | Buffer)[]]
Returns ChainableCommander
bitop
- bitop(...args: [operation: string | Buffer, destkey: RedisKey, ...keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- bitop(...args: [operation: string | Buffer, destkey: RedisKey, keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- bitop(...args: [operation: string | Buffer, destkey: RedisKey, ...keys: RedisKey[]]): ChainableCommander
- bitop(...args: [operation: string | Buffer, destkey: RedisKey, keys: RedisKey[]]): ChainableCommander
- \n
Perform bitwise operations between strings
\n- \n
- group: bitmap \n
- complexity: O(N) \n
- since: 2.6.0 \n
Parameters
Rest ...args: [operation: string | Buffer, destkey: RedisKey, ...keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [operation: string | Buffer, destkey: RedisKey, keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
bitpos
- bitpos(key: RedisKey, bit: string | number, callback?: Callback<number>): ChainableCommander
- bitpos(key: RedisKey, bit: string | number, start: string | number, callback?: Callback<number>): ChainableCommander
- bitpos(key: RedisKey, bit: string | number, start: string | number, end: string | number, callback?: Callback<number>): ChainableCommander
- bitpos(key: RedisKey, bit: string | number, start: string | number, end: string | number, byte: "BYTE", callback?: Callback<number>): ChainableCommander
- bitpos(key: RedisKey, bit: string | number, start: string | number, end: string | number, bit1: "BIT", callback?: Callback<number>): ChainableCommander
- \n
Find first bit set or clear in a string
\n- \n
- group: bitmap \n
- complexity: O(N) \n
- since: 2.8.7 \n
Parameters
key: RedisKey
bit: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
bit: string | number
start: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
bit: string | number
start: string | number
end: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
bit: string | number
start: string | number
end: string | number
byte: "BYTE"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
bit: string | number
start: string | number
end: string | number
bit1: "BIT"
Optional callback: Callback<number>
Returns ChainableCommander
blmove
- blmove(source: RedisKey, destination: RedisKey, left: "LEFT", left1: "LEFT", timeout: string | number, callback?: Callback<string>): ChainableCommander
- blmove(source: RedisKey, destination: RedisKey, left: "LEFT", right: "RIGHT", timeout: string | number, callback?: Callback<string>): ChainableCommander
- blmove(source: RedisKey, destination: RedisKey, right: "RIGHT", left: "LEFT", timeout: string | number, callback?: Callback<string>): ChainableCommander
- blmove(source: RedisKey, destination: RedisKey, right: "RIGHT", right1: "RIGHT", timeout: string | number, callback?: Callback<string>): ChainableCommander
- \n
Pop an element from a list, push it to another list and return it; or block until one is available
\n- \n
- group: list \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
source: RedisKey
destination: RedisKey
left: "LEFT"
left1: "LEFT"
timeout: string | number
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
source: RedisKey
destination: RedisKey
left: "LEFT"
right: "RIGHT"
timeout: string | number
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
source: RedisKey
destination: RedisKey
right: "RIGHT"
left: "LEFT"
timeout: string | number
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
source: RedisKey
destination: RedisKey
right: "RIGHT"
right1: "RIGHT"
timeout: string | number
Optional callback: Callback<string>
Returns ChainableCommander
blmove
- blmove
Buffer(source: RedisKey, destination: RedisKey, left: "LEFT", left1: "LEFT", timeout: string | number, callback?: Callback<Buffer>): ChainableCommander - blmove
Buffer(source: RedisKey, destination: RedisKey, left: "LEFT", right: "RIGHT", timeout: string | number, callback?: Callback<Buffer>): ChainableCommander - blmove
Buffer(source: RedisKey, destination: RedisKey, right: "RIGHT", left: "LEFT", timeout: string | number, callback?: Callback<Buffer>): ChainableCommander - blmove
Buffer(source: RedisKey, destination: RedisKey, right: "RIGHT", right1: "RIGHT", timeout: string | number, callback?: Callback<Buffer>): ChainableCommander
Parameters
source: RedisKey
destination: RedisKey
left: "LEFT"
left1: "LEFT"
timeout: string | number
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
source: RedisKey
destination: RedisKey
left: "LEFT"
right: "RIGHT"
timeout: string | number
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
source: RedisKey
destination: RedisKey
right: "RIGHT"
left: "LEFT"
timeout: string | number
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
source: RedisKey
destination: RedisKey
right: "RIGHT"
right1: "RIGHT"
timeout: string | number
Optional callback: Callback<Buffer>
Returns ChainableCommander
blmpop
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]): ChainableCommander
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]): ChainableCommander
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]): ChainableCommander
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT"]): ChainableCommander
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): ChainableCommander
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): ChainableCommander
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): ChainableCommander
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): ChainableCommander
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]): ChainableCommander
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]): ChainableCommander
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]): ChainableCommander
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT"]): ChainableCommander
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): ChainableCommander
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): ChainableCommander
- blmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): ChainableCommander
- blmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): ChainableCommander
- \n
Pop elements from a list, or block until one is available
\n- \n
- group: list \n
- complexity: O(N+M) where N is the number of provided keys and M is the number of elements returned. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT"]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT"]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns ChainableCommander
blmpop
- blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]): ChainableCommander - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]): ChainableCommander - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]): ChainableCommander - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT"]): ChainableCommander - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): ChainableCommander - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): ChainableCommander - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): ChainableCommander - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): ChainableCommander - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]): ChainableCommander - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]): ChainableCommander - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]): ChainableCommander - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT"]): ChainableCommander - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): ChainableCommander - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): ChainableCommander - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): ChainableCommander - blmpop
Buffer(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT"]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT"]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns ChainableCommander
blpop
- blpop(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]): ChainableCommander
- blpop(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]): ChainableCommander
- blpop(...args: [...keys: RedisKey[], timeout: string | number]): ChainableCommander
- blpop(...args: [keys: RedisKey[], timeout: string | number]): ChainableCommander
- \n
Remove and get the first element in a list, or block until one is available
\n- \n
- group: list \n
- complexity: O(N) where N is the number of provided keys. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]
Returns ChainableCommander
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns ChainableCommander
blpop
- blpop
Buffer(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]): ChainableCommander - blpop
Buffer(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]): ChainableCommander - blpop
Buffer(...args: [...keys: RedisKey[], timeout: string | number]): ChainableCommander - blpop
Buffer(...args: [keys: RedisKey[], timeout: string | number]): ChainableCommander
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]
Returns ChainableCommander
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns ChainableCommander
brpop
- brpop(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]): ChainableCommander
- brpop(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]): ChainableCommander
- brpop(...args: [...keys: RedisKey[], timeout: string | number]): ChainableCommander
- brpop(...args: [keys: RedisKey[], timeout: string | number]): ChainableCommander
- \n
Remove and get the last element in a list, or block until one is available
\n- \n
- group: list \n
- complexity: O(N) where N is the number of provided keys. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[string, string]>]
Returns ChainableCommander
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns ChainableCommander
brpop
- brpop
Buffer(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]): ChainableCommander - brpop
Buffer(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]): ChainableCommander - brpop
Buffer(...args: [...keys: RedisKey[], timeout: string | number]): ChainableCommander - brpop
Buffer(...args: [keys: RedisKey[], timeout: string | number]): ChainableCommander
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[Buffer, Buffer]>]
Returns ChainableCommander
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns ChainableCommander
brpoplpush
- brpoplpush(source: RedisKey, destination: RedisKey, timeout: string | number, callback?: Callback<string>): ChainableCommander
- \n
Pop an element from a list, push it to another list and return it; or block until one is available
\n- \n
- group: list \n
- complexity: O(1) \n
- since: 2.2.0 \n
Parameters
Returns ChainableCommander
brpoplpush
- brpoplpush
Buffer(source: RedisKey, destination: RedisKey, timeout: string | number, callback?: Callback<Buffer>): ChainableCommander
Parameters
Returns ChainableCommander
bzmpop
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN", callback: Callback<unknown>]): ChainableCommander
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN", callback: Callback<unknown>]): ChainableCommander
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN"]): ChainableCommander
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN"]): ChainableCommander
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): ChainableCommander
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): ChainableCommander
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]): ChainableCommander
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]): ChainableCommander
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX", callback: Callback<unknown>]): ChainableCommander
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX", callback: Callback<unknown>]): ChainableCommander
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX"]): ChainableCommander
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX"]): ChainableCommander
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): ChainableCommander
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): ChainableCommander
- bzmpop(...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]): ChainableCommander
- bzmpop(...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]): ChainableCommander
- \n
Remove and return members with scores in a sorted set or block until one is available
\n- \n
- group: sorted-set \n
- complexity: O(K) + O(N*log(M)) where K is the number of provided keys, N being the number of elements in the sorted set, and M being the number of elements popped. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [timeout: string | number, numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]
Returns ChainableCommander
bzpopmax
- bzpopmax(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]): ChainableCommander
- bzpopmax(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]): ChainableCommander
- bzpopmax(...args: [...keys: RedisKey[], timeout: string | number]): ChainableCommander
- bzpopmax(...args: [keys: RedisKey[], timeout: string | number]): ChainableCommander
- \n
Remove and return the member with the highest score from one or more sorted sets, or block until one is available
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) with N being the number of elements in the sorted set. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]
Returns ChainableCommander
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns ChainableCommander
bzpopmax
- bzpopmax
Buffer(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]): ChainableCommander - bzpopmax
Buffer(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]): ChainableCommander - bzpopmax
Buffer(...args: [...keys: RedisKey[], timeout: string | number]): ChainableCommander - bzpopmax
Buffer(...args: [keys: RedisKey[], timeout: string | number]): ChainableCommander
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]
Returns ChainableCommander
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns ChainableCommander
bzpopmin
- bzpopmin(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]): ChainableCommander
- bzpopmin(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]): ChainableCommander
- bzpopmin(...args: [...keys: RedisKey[], timeout: string | number]): ChainableCommander
- bzpopmin(...args: [keys: RedisKey[], timeout: string | number]): ChainableCommander
- \n
Remove and return the member with the lowest score from one or more sorted sets, or block until one is available
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) with N being the number of elements in the sorted set. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: string, member: string, score: string]>]
Returns ChainableCommander
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns ChainableCommander
bzpopmin
- bzpopmin
Buffer(...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]): ChainableCommander - bzpopmin
Buffer(...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]): ChainableCommander - bzpopmin
Buffer(...args: [...keys: RedisKey[], timeout: string | number]): ChainableCommander - bzpopmin
Buffer(...args: [keys: RedisKey[], timeout: string | number]): ChainableCommander
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number, callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>]
Returns ChainableCommander
Parameters
Rest ...args: [...keys: RedisKey[], timeout: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], timeout: string | number]
Returns ChainableCommander
call
- call(command: string, callback?: Callback<unknown>): ChainableCommander
- call(command: string, args: (string | number | Buffer)[], callback?: Callback<unknown>): ChainableCommander
- call(...args: [command: string, ...args: (string | number | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- call(...args: [command: string, ...args: (string | number | Buffer)[]]): ChainableCommander
- \n
Call arbitrary commands.
\n
\nredis.call('set', 'foo', 'bar')is the same asredis.set('foo', 'bar'),\nso the only case you need to use this method is when the command is not\nsupported by ioredis.
\nredis.call('set', 'foo', 'bar');
redis.call('get', 'foo', (err, value) => {
// value === 'bar'
});\nParameters
command: string
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
command: string
args: (string | number | Buffer)[]
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [command: string, ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [command: string, ...args: (string | number | Buffer)[]]
Returns ChainableCommander
call
- call
Buffer(command: string, callback?: Callback<unknown>): ChainableCommander - call
Buffer(command: string, args: (string | number | Buffer)[], callback?: Callback<unknown>): ChainableCommander - call
Buffer(...args: [command: string, ...args: (string | number | Buffer)[], callback: Callback<unknown>]): ChainableCommander - call
Buffer(...args: [command: string, ...args: (string | number | Buffer)[]]): ChainableCommander
Parameters
command: string
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
command: string
args: (string | number | Buffer)[]
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [command: string, ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [command: string, ...args: (string | number | Buffer)[]]
Returns ChainableCommander
client
- client(subcommand: "CACHING", yes: "YES", callback?: Callback<"OK">): ChainableCommander
- client(subcommand: "CACHING", no: "NO", callback?: Callback<"OK">): ChainableCommander
- client(subcommand: "GETNAME", callback?: Callback<string>): ChainableCommander
- client(subcommand: "GETREDIR", callback?: Callback<number>): ChainableCommander
- client(subcommand: "HELP", callback?: Callback<unknown>): ChainableCommander
- client(subcommand: "ID", callback?: Callback<number>): ChainableCommander
- client(subcommand: "INFO", callback?: Callback<string>): ChainableCommander
- client(...args: [subcommand: "KILL", ...args: RedisValue[], callback: Callback<unknown>]): ChainableCommander
- client(...args: [subcommand: "KILL", ...args: RedisValue[]]): ChainableCommander
- client(subcommand: "LIST", callback?: Callback<unknown>): ChainableCommander
- client(...args: [subcommand: "LIST", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]): ChainableCommander
- client(...args: [subcommand: "LIST", idToken: "ID", ...clientIds: (string | number)[]]): ChainableCommander
- client(subcommand: "LIST", type: "TYPE", normal: "NORMAL", callback?: Callback<unknown>): ChainableCommander
- client(...args: [subcommand: "LIST", type: "TYPE", normal: "NORMAL", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]): ChainableCommander
- client(...args: [subcommand: "LIST", type: "TYPE", normal: "NORMAL", idToken: "ID", ...clientIds: (string | number)[]]): ChainableCommander
- client(subcommand: "LIST", type: "TYPE", master: "MASTER", callback?: Callback<unknown>): ChainableCommander
- client(...args: [subcommand: "LIST", type: "TYPE", master: "MASTER", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]): ChainableCommander
- client(...args: [subcommand: "LIST", type: "TYPE", master: "MASTER", idToken: "ID", ...clientIds: (string | number)[]]): ChainableCommander
- client(subcommand: "LIST", type: "TYPE", replica: "REPLICA", callback?: Callback<unknown>): ChainableCommander
- client(...args: [subcommand: "LIST", type: "TYPE", replica: "REPLICA", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]): ChainableCommander
- client(...args: [subcommand: "LIST", type: "TYPE", replica: "REPLICA", idToken: "ID", ...clientIds: (string | number)[]]): ChainableCommander
- client(subcommand: "LIST", type: "TYPE", pubsub: "PUBSUB", callback?: Callback<unknown>): ChainableCommander
- client(...args: [subcommand: "LIST", type: "TYPE", pubsub: "PUBSUB", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]): ChainableCommander
- client(...args: [subcommand: "LIST", type: "TYPE", pubsub: "PUBSUB", idToken: "ID", ...clientIds: (string | number)[]]): ChainableCommander
- client(subcommand: "NO-EVICT", on: "ON", callback?: Callback<unknown>): ChainableCommander
- client(subcommand: "NO-EVICT", off: "OFF", callback?: Callback<unknown>): ChainableCommander
- client(subcommand: "PAUSE", timeout: string | number, callback?: Callback<"OK">): ChainableCommander
- client(subcommand: "PAUSE", timeout: string | number, write: "WRITE", callback?: Callback<"OK">): ChainableCommander
- client(subcommand: "PAUSE", timeout: string | number, all: "ALL", callback?: Callback<"OK">): ChainableCommander
- client(subcommand: "REPLY", on: "ON", callback?: Callback<unknown>): ChainableCommander
- client(subcommand: "REPLY", off: "OFF", callback?: Callback<unknown>): ChainableCommander
- client(subcommand: "REPLY", skip: "SKIP", callback?: Callback<unknown>): ChainableCommander
- client(subcommand: "SETNAME", connectionName: string | Buffer, callback?: Callback<"OK">): ChainableCommander
- client(...args: [subcommand: "TRACKING", ...args: RedisValue[], callback: Callback<unknown>]): ChainableCommander
- client(...args: [subcommand: "TRACKING", ...args: RedisValue[]]): ChainableCommander
- client(subcommand: "TRACKINGINFO", callback?: Callback<string>): ChainableCommander
- client(subcommand: "UNBLOCK", clientId: string | number, callback?: Callback<unknown>): ChainableCommander
- client(subcommand: "UNBLOCK", clientId: string | number, timeout: "TIMEOUT", callback?: Callback<unknown>): ChainableCommander
- client(subcommand: "UNBLOCK", clientId: string | number, error: "ERROR", callback?: Callback<unknown>): ChainableCommander
- client(subcommand: "UNPAUSE", callback?: Callback<"OK">): ChainableCommander
- \n
Instruct the server about tracking or not keys in the next request
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 6.0.0 \n
Parameters
subcommand: "CACHING"
yes: "YES"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
subcommand: "CACHING"
no: "NO"
Optional callback: Callback<"OK">
Returns ChainableCommander
- \n
Get the current connection name
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 2.6.9 \n
Parameters
subcommand: "GETNAME"
Optional callback: Callback<string>
Returns ChainableCommander
- \n
Get tracking notifications redirection client ID if any
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 6.0.0 \n
Parameters
subcommand: "GETREDIR"
Optional callback: Callback<number>
Returns ChainableCommander
- \n
Show helpful text about the different subcommands
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Returns the client ID for the current connection
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "ID"
Optional callback: Callback<number>
Returns ChainableCommander
- \n
Returns information about the current client connection.
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
subcommand: "INFO"
Optional callback: Callback<string>
Returns ChainableCommander
- \n
Kill the connection of a client
\n- \n
- group: connection \n
- complexity: O(N) where N is the number of client connections \n
- since: 2.4.0 \n
Parameters
Rest ...args: [subcommand: "KILL", ...args: RedisValue[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "KILL", ...args: RedisValue[]]
Returns ChainableCommander
- \n
Get the list of client connections
\n- \n
- group: connection \n
- complexity: O(N) where N is the number of client connections \n
- since: 2.4.0 \n
Parameters
subcommand: "LIST"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "LIST", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "LIST", idToken: "ID", ...clientIds: (string | number)[]]
Returns ChainableCommander
Parameters
subcommand: "LIST"
type: "TYPE"
normal: "NORMAL"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", normal: "NORMAL", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", normal: "NORMAL", idToken: "ID", ...clientIds: (string | number)[]]
Returns ChainableCommander
Parameters
subcommand: "LIST"
type: "TYPE"
master: "MASTER"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", master: "MASTER", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", master: "MASTER", idToken: "ID", ...clientIds: (string | number)[]]
Returns ChainableCommander
Parameters
subcommand: "LIST"
type: "TYPE"
replica: "REPLICA"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", replica: "REPLICA", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", replica: "REPLICA", idToken: "ID", ...clientIds: (string | number)[]]
Returns ChainableCommander
Parameters
subcommand: "LIST"
type: "TYPE"
pubsub: "PUBSUB"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", pubsub: "PUBSUB", idToken: "ID", ...clientIds: (string | number)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "LIST", type: "TYPE", pubsub: "PUBSUB", idToken: "ID", ...clientIds: (string | number)[]]
Returns ChainableCommander
- \n
Set client eviction mode for the current connection
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
subcommand: "NO-EVICT"
on: "ON"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "NO-EVICT"
off: "OFF"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Stop processing commands from clients for some time
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 2.9.50 \n
Parameters
subcommand: "PAUSE"
timeout: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
subcommand: "PAUSE"
timeout: string | number
write: "WRITE"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
subcommand: "PAUSE"
timeout: string | number
all: "ALL"
Optional callback: Callback<"OK">
Returns ChainableCommander
- \n
Instruct the server whether to reply to commands
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 3.2.0 \n
Parameters
subcommand: "REPLY"
on: "ON"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "REPLY"
off: "OFF"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "REPLY"
skip: "SKIP"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Set the current connection name
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 2.6.9 \n
Parameters
subcommand: "SETNAME"
connectionName: string | Buffer
Optional callback: Callback<"OK">
Returns ChainableCommander
- \n
Enable or disable server assisted client side caching support
\n- \n
- group: connection \n
- complexity: O(1). Some options may introduce additional complexity. \n
- since: 6.0.0 \n
Parameters
Rest ...args: [subcommand: "TRACKING", ...args: RedisValue[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "TRACKING", ...args: RedisValue[]]
Returns ChainableCommander
- \n
Return information about server assisted client side caching for the current connection
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
subcommand: "TRACKINGINFO"
Optional callback: Callback<string>
Returns ChainableCommander
- \n
Unblock a client blocked in a blocking command from a different connection
\n- \n
- group: connection \n
- complexity: O(log N) where N is the number of client connections \n
- since: 5.0.0 \n
Parameters
subcommand: "UNBLOCK"
clientId: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "UNBLOCK"
clientId: string | number
timeout: "TIMEOUT"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "UNBLOCK"
clientId: string | number
error: "ERROR"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Resume processing of clients that were paused
\n- \n
- group: connection \n
- complexity: O(N) Where N is the number of paused clients \n
- since: 6.2.0 \n
Parameters
subcommand: "UNPAUSE"
Optional callback: Callback<"OK">
Returns ChainableCommander
client
- client
Buffer(subcommand: "GETNAME", callback?: Callback<Buffer>): ChainableCommander - client
Buffer(subcommand: "INFO", callback?: Callback<Buffer>): ChainableCommander - client
Buffer(subcommand: "TRACKINGINFO", callback?: Callback<Buffer>): ChainableCommander
Parameters
subcommand: "GETNAME"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
subcommand: "INFO"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
subcommand: "TRACKINGINFO"
Optional callback: Callback<Buffer>
Returns ChainableCommander
cluster
- cluster(...args: [subcommand: "ADDSLOTS", ...slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]): ChainableCommander
- cluster(...args: [subcommand: "ADDSLOTS", slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]): ChainableCommander
- cluster(...args: [subcommand: "ADDSLOTS", ...slots: (string | number)[]]): ChainableCommander
- cluster(...args: [subcommand: "ADDSLOTS", slots: (string | number)[]]): ChainableCommander
- cluster(...args: [subcommand: "ADDSLOTSRANGE", ...startSlotEndSlots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]): ChainableCommander
- cluster(...args: [subcommand: "ADDSLOTSRANGE", ...startSlotEndSlots: (string | number)[]]): ChainableCommander
- cluster(subcommand: "BUMPEPOCH", callback?: Callback<"BUMPED" | "STILL">): ChainableCommander
- cluster(subcommand: "COUNT-FAILURE-REPORTS", nodeId: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- cluster(subcommand: "COUNTKEYSINSLOT", slot: string | number, callback?: Callback<number>): ChainableCommander
- cluster(...args: [subcommand: "DELSLOTS", ...slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]): ChainableCommander
- cluster(...args: [subcommand: "DELSLOTS", slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]): ChainableCommander
- cluster(...args: [subcommand: "DELSLOTS", ...slots: (string | number)[]]): ChainableCommander
- cluster(...args: [subcommand: "DELSLOTS", slots: (string | number)[]]): ChainableCommander
- cluster(...args: [subcommand: "DELSLOTSRANGE", ...startSlotEndSlots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]): ChainableCommander
- cluster(...args: [subcommand: "DELSLOTSRANGE", ...startSlotEndSlots: (string | number)[]]): ChainableCommander
- cluster(subcommand: "FAILOVER", callback?: Callback<"OK">): ChainableCommander
- cluster(subcommand: "FAILOVER", force: "FORCE", callback?: Callback<"OK">): ChainableCommander
- cluster(subcommand: "FAILOVER", takeover: "TAKEOVER", callback?: Callback<"OK">): ChainableCommander
- cluster(subcommand: "FLUSHSLOTS", callback?: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>): ChainableCommander
- cluster(subcommand: "FORGET", nodeId: string | number | Buffer, callback?: Callback<"OK">): ChainableCommander
- cluster(subcommand: "GETKEYSINSLOT", slot: string | number, count: string | number, callback?: Callback<string[]>): ChainableCommander
- cluster(subcommand: "HELP", callback?: Callback<unknown>): ChainableCommander
- cluster(subcommand: "INFO", callback?: Callback<string>): ChainableCommander
- cluster(subcommand: "KEYSLOT", key: string | Buffer, callback?: Callback<number>): ChainableCommander
- cluster(subcommand: "LINKS", callback?: Callback<unknown[]>): ChainableCommander
- cluster(subcommand: "MEET", ip: string | Buffer, port: string | number, callback?: Callback<"OK">): ChainableCommander
- cluster(subcommand: "MYID", callback?: Callback<string>): ChainableCommander
- cluster(subcommand: "NODES", callback?: Callback<unknown>): ChainableCommander
- cluster(subcommand: "REPLICAS", nodeId: string | number | Buffer, callback?: Callback<unknown>): ChainableCommander
- cluster(subcommand: "REPLICATE", nodeId: string | number | Buffer, callback?: Callback<"OK">): ChainableCommander
- cluster(subcommand: "RESET", callback?: Callback<"OK">): ChainableCommander
- cluster(subcommand: "RESET", hard: "HARD", callback?: Callback<"OK">): ChainableCommander
- cluster(subcommand: "RESET", soft: "SOFT", callback?: Callback<"OK">): ChainableCommander
- cluster(subcommand: "SAVECONFIG", callback?: Callback<"OK">): ChainableCommander
- cluster(subcommand: "SET-CONFIG-EPOCH", configEpoch: string | number, callback?: Callback<"OK">): ChainableCommander
- cluster(subcommand: "SETSLOT", slot: string | number, nodeIdToken: "IMPORTING", nodeId: string | number | Buffer, callback?: Callback<"OK">): ChainableCommander
- cluster(subcommand: "SETSLOT", slot: string | number, nodeIdToken: "MIGRATING", nodeId: string | number | Buffer, callback?: Callback<"OK">): ChainableCommander
- cluster(subcommand: "SETSLOT", slot: string | number, nodeIdToken: "NODE", nodeId: string | number | Buffer, callback?: Callback<"OK">): ChainableCommander
- cluster(subcommand: "SETSLOT", slot: string | number, stable: "STABLE", callback?: Callback<"OK">): ChainableCommander
- cluster(subcommand: "SHARDS", callback?: Callback<unknown>): ChainableCommander
- cluster(subcommand: "SLAVES", nodeId: string | number | Buffer, callback?: Callback<unknown>): ChainableCommander
- cluster(subcommand: "SLOTS", callback?: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>): ChainableCommander
- \n
Assign new hash slots to receiving node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of hash slot arguments \n
- since: 3.0.0 \n
Parameters
Rest ...args: [subcommand: "ADDSLOTS", ...slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "ADDSLOTS", slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "ADDSLOTS", ...slots: (string | number)[]]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "ADDSLOTS", slots: (string | number)[]]
Returns ChainableCommander
- \n
Assign new hash slots to receiving node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of the slots between the start slot and end slot arguments. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [subcommand: "ADDSLOTSRANGE", ...startSlotEndSlots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "ADDSLOTSRANGE", ...startSlotEndSlots: (string | number)[]]
Returns ChainableCommander
- \n
Advance the cluster config epoch
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "BUMPEPOCH"
Optional callback: Callback<"BUMPED" | "STILL">
Returns ChainableCommander
- \n
Return the number of failure reports active for a given node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the number of failure reports \n
- since: 3.0.0 \n
Parameters
subcommand: "COUNT-FAILURE-REPORTS"
nodeId: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
- \n
Return the number of local keys in the specified hash slot
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "COUNTKEYSINSLOT"
slot: string | number
Optional callback: Callback<number>
Returns ChainableCommander
- \n
Set hash slots as unbound in receiving node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of hash slot arguments \n
- since: 3.0.0 \n
Parameters
Rest ...args: [subcommand: "DELSLOTS", ...slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "DELSLOTS", slots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "DELSLOTS", ...slots: (string | number)[]]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "DELSLOTS", slots: (string | number)[]]
Returns ChainableCommander
- \n
Set hash slots as unbound in receiving node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of the slots between the start slot and end slot arguments. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [subcommand: "DELSLOTSRANGE", ...startSlotEndSlots: (string | number)[], callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "DELSLOTSRANGE", ...startSlotEndSlots: (string | number)[]]
Returns ChainableCommander
- \n
Forces a replica to perform a manual failover of its master.
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "FAILOVER"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
subcommand: "FAILOVER"
force: "FORCE"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
subcommand: "FAILOVER"
takeover: "TAKEOVER"
Optional callback: Callback<"OK">
Returns ChainableCommander
- \n
Delete a node's own slots information
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "FLUSHSLOTS"
Optional callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Returns ChainableCommander
- \n
Remove a node from the nodes table
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "FORGET"
nodeId: string | number | Buffer
Optional callback: Callback<"OK">
Returns ChainableCommander
- \n
Return local key names in the specified hash slot
\n- \n
- group: cluster \n
- complexity: O(log(N)) where N is the number of requested keys \n
- since: 3.0.0 \n
Parameters
subcommand: "GETKEYSINSLOT"
slot: string | number
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
- \n
Show helpful text about the different subcommands
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Provides info about Redis Cluster node state
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "INFO"
Optional callback: Callback<string>
Returns ChainableCommander
- \n
Returns the hash slot of the specified key
\n- \n
- group: cluster \n
- complexity: O(N) where N is the number of bytes in the key \n
- since: 3.0.0 \n
Parameters
subcommand: "KEYSLOT"
key: string | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
- \n
Returns a list of all TCP links to and from peer nodes in cluster
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of Cluster nodes \n
- since: 7.0.0 \n
Parameters
subcommand: "LINKS"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
- \n
Force a node cluster to handshake with another node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "MEET"
ip: string | Buffer
port: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
- \n
Return the node id
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "MYID"
Optional callback: Callback<string>
Returns ChainableCommander
- \n
Get Cluster config for the node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of Cluster nodes \n
- since: 3.0.0 \n
Parameters
subcommand: "NODES"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
List replica nodes of the specified master node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "REPLICAS"
nodeId: string | number | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Reconfigure a node as a replica of the specified master node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "REPLICATE"
nodeId: string | number | Buffer
Optional callback: Callback<"OK">
Returns ChainableCommander
- \n
Reset a Redis Cluster node
\n- \n
- group: cluster \n
- complexity: O(N) where N is the number of known nodes. The command may execute a FLUSHALL as a side effect. \n
- since: 3.0.0 \n
Parameters
subcommand: "RESET"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
subcommand: "RESET"
hard: "HARD"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
subcommand: "RESET"
soft: "SOFT"
Optional callback: Callback<"OK">
Returns ChainableCommander
- \n
Forces the node to save cluster state on disk
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "SAVECONFIG"
Optional callback: Callback<"OK">
Returns ChainableCommander
- \n
Set the configuration epoch in a new node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "SET-CONFIG-EPOCH"
configEpoch: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
- \n
Bind a hash slot to a specific node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "SETSLOT"
slot: string | number
nodeIdToken: "IMPORTING"
nodeId: string | number | Buffer
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
subcommand: "SETSLOT"
slot: string | number
nodeIdToken: "MIGRATING"
nodeId: string | number | Buffer
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
subcommand: "SETSLOT"
slot: string | number
nodeIdToken: "NODE"
nodeId: string | number | Buffer
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
subcommand: "SETSLOT"
slot: string | number
stable: "STABLE"
Optional callback: Callback<"OK">
Returns ChainableCommander
- \n
Get array of cluster slots to node mappings
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of cluster nodes \n
- since: 7.0.0 \n
Parameters
subcommand: "SHARDS"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
List replica nodes of the specified master node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
subcommand: "SLAVES"
nodeId: string | number | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Get array of Cluster slot to node mappings
\n- \n
- group: cluster \n
- complexity: O(N) where N is the total number of Cluster nodes \n
- since: 3.0.0 \n
Parameters
subcommand: "SLOTS"
Optional callback: Callback<[startSlotRange: number, endSlotRange: number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>
Returns ChainableCommander
command
- command(subcommand: "COUNT", callback?: Callback<unknown[]>): ChainableCommander
- command(subcommand: "DOCS", callback?: Callback<unknown[]>): ChainableCommander
- command(...args: [subcommand: "DOCS", ...commandNames: (string | Buffer)[], callback: Callback<unknown[]>]): ChainableCommander
- command(...args: [subcommand: "DOCS", ...commandNames: (string | Buffer)[]]): ChainableCommander
- command(subcommand: "GETKEYS", callback?: Callback<unknown[]>): ChainableCommander
- command(subcommand: "GETKEYSANDFLAGS", callback?: Callback<unknown[]>): ChainableCommander
- command(subcommand: "HELP", callback?: Callback<unknown[]>): ChainableCommander
- command(subcommand: "INFO", callback?: Callback<unknown[]>): ChainableCommander
- command(...args: [subcommand: "INFO", ...commandNames: (string | Buffer)[], callback: Callback<unknown[]>]): ChainableCommander
- command(...args: [subcommand: "INFO", ...commandNames: (string | Buffer)[]]): ChainableCommander
- command(subcommand: "LIST", callback?: Callback<unknown[]>): ChainableCommander
- command(subcommand: "LIST", filterby: "FILTERBY", moduleNameToken: "MODULE", moduleName: string | Buffer, callback?: Callback<unknown[]>): ChainableCommander
- command(subcommand: "LIST", filterby: "FILTERBY", categoryToken: "ACLCAT", category: string | Buffer, callback?: Callback<unknown[]>): ChainableCommander
- command(subcommand: "LIST", filterby: "FILTERBY", patternToken: "PATTERN", pattern: string, callback?: Callback<unknown[]>): ChainableCommander
- \n
Get total number of Redis commands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "COUNT"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
- \n
Get array of specific Redis command documentation
\n- \n
- group: server \n
- complexity: O(N) where N is the number of commands to look up \n
- since: 7.0.0 \n
Parameters
subcommand: "DOCS"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "DOCS", ...commandNames: (string | Buffer)[], callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "DOCS", ...commandNames: (string | Buffer)[]]
Returns ChainableCommander
- \n
Extract keys given a full Redis command
\n- \n
- group: server \n
- complexity: O(N) where N is the number of arguments to the command \n
- since: 2.8.13 \n
Parameters
subcommand: "GETKEYS"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
- \n
Extract keys and access flags given a full Redis command
\n- \n
- group: server \n
- complexity: O(N) where N is the number of arguments to the command \n
- since: 7.0.0 \n
Parameters
subcommand: "GETKEYSANDFLAGS"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
- \n
Show helpful text about the different subcommands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
- \n
Get array of specific Redis command details, or all when no argument is given.
\n- \n
- group: server \n
- complexity: O(N) where N is the number of commands to look up \n
- since: 2.8.13 \n
Parameters
subcommand: "INFO"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "INFO", ...commandNames: (string | Buffer)[], callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "INFO", ...commandNames: (string | Buffer)[]]
Returns ChainableCommander
- \n
Get an array of Redis command names
\n- \n
- group: server \n
- complexity: O(N) where N is the total number of Redis commands \n
- since: 7.0.0 \n
Parameters
subcommand: "LIST"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
subcommand: "LIST"
filterby: "FILTERBY"
moduleNameToken: "MODULE"
moduleName: string | Buffer
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
subcommand: "LIST"
filterby: "FILTERBY"
categoryToken: "ACLCAT"
category: string | Buffer
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
subcommand: "LIST"
filterby: "FILTERBY"
patternToken: "PATTERN"
pattern: string
Optional callback: Callback<unknown[]>
Returns ChainableCommander
config
- config(...args: [subcommand: "GET", ...parameters: (string | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- config(...args: [subcommand: "GET", ...parameters: (string | Buffer)[]]): ChainableCommander
- config(subcommand: "HELP", callback?: Callback<unknown>): ChainableCommander
- config(subcommand: "RESETSTAT", callback?: Callback<unknown>): ChainableCommander
- config(subcommand: "REWRITE", callback?: Callback<unknown>): ChainableCommander
- config(...args: [subcommand: "SET", ...parameterValues: (string | number | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- config(...args: [subcommand: "SET", ...parameterValues: (string | number | Buffer)[]]): ChainableCommander
- \n
Get the values of configuration parameters
\n- \n
- group: server \n
- complexity: O(N) when N is the number of configuration parameters provided \n
- since: 2.0.0 \n
Parameters
Rest ...args: [subcommand: "GET", ...parameters: (string | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "GET", ...parameters: (string | Buffer)[]]
Returns ChainableCommander
- \n
Show helpful text about the different subcommands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Reset the stats returned by INFO
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
subcommand: "RESETSTAT"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Rewrite the configuration file with the in memory configuration
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.0 \n
Parameters
subcommand: "REWRITE"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Set configuration parameters to the given values
\n- \n
- group: server \n
- complexity: O(N) when N is the number of configuration parameters provided \n
- since: 2.0.0 \n
Parameters
Rest ...args: [subcommand: "SET", ...parameterValues: (string | number | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "SET", ...parameterValues: (string | number | Buffer)[]]
Returns ChainableCommander
copy
- copy(source: RedisKey, destination: RedisKey, callback?: Callback<number>): ChainableCommander
- copy(source: RedisKey, destination: RedisKey, replace: "REPLACE", callback?: Callback<number>): ChainableCommander
- copy(source: RedisKey, destination: RedisKey, destinationDbToken: "DB", destinationDb: string | number, callback?: Callback<number>): ChainableCommander
- copy(source: RedisKey, destination: RedisKey, destinationDbToken: "DB", destinationDb: string | number, replace: "REPLACE", callback?: Callback<number>): ChainableCommander
- \n
Copy a key
\n- \n
- group: generic \n
- complexity: O(N) worst case for collections, where N is the number of nested items. O(1) for string values. \n
- since: 6.2.0 \n
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
source: RedisKey
destination: RedisKey
destinationDbToken: "DB"
destinationDb: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
source: RedisKey
destination: RedisKey
destinationDbToken: "DB"
destinationDb: string | number
replace: "REPLACE"
Optional callback: Callback<number>
Returns ChainableCommander
dbsize
- dbsize(callback?: Callback<number>): ChainableCommander
- \n
Return the number of keys in the selected database
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<number>
Returns ChainableCommander
debug
- debug(subcommand: string, callback?: Callback<unknown>): ChainableCommander
- debug(...args: [subcommand: string, ...args: (string | number | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- debug(...args: [subcommand: string, ...args: (string | number | Buffer)[]]): ChainableCommander
- \n
A container for debugging commands
\n- \n
- group: server \n
- complexity: Depends on subcommand. \n
- since: 1.0.0 \n
Parameters
subcommand: string
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: string, ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: string, ...args: (string | number | Buffer)[]]
Returns ChainableCommander
decr
- decr(key: RedisKey, callback?: Callback<number>): ChainableCommander
- \n
Decrement the integer value of a key by one
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns ChainableCommander
decrby
- decrby(key: RedisKey, decrement: string | number, callback?: Callback<number>): ChainableCommander
- \n
Decrement the integer value of a key by the given number
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
decrement: string | number
Optional callback: Callback<number>
Returns ChainableCommander
del
- del(...args: [...keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- del(...args: [keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- del(...args: RedisKey[]): ChainableCommander
- del(...args: [keys: RedisKey[]]): ChainableCommander
- \n
Delete a key
\n- \n
- group: generic \n
- complexity: O(N) where N is the number of keys that will be removed. When a key to remove holds a value other than a string, the individual complexity for this key is O(M) where M is the number of elements in the list, set, sorted set or hash. Removing a single key that holds a string value is O(1). \n
- since: 1.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: RedisKey[]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[]]
Returns ChainableCommander
discard
- discard(callback?: Callback<"OK">): ChainableCommander
- \n
Discard all commands issued after MULTI
\n- \n
- group: transactions \n
- complexity: O(N), when N is the number of queued commands \n
- since: 2.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns ChainableCommander
dump
- dump(key: RedisKey, callback?: Callback<string>): ChainableCommander
- \n
Return a serialized version of the value stored at the specified key.
\n- \n
- group: generic \n
- complexity: O(1) to access the key and additional O(NM) to serialize it, where N is the number of Redis objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1M) where M is small, so simply O(1). \n
- since: 2.6.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns ChainableCommander
dump
- dump
Buffer(key: RedisKey, callback?: Callback<Buffer>): ChainableCommander
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns ChainableCommander
echo
- echo(message: string | Buffer, callback?: Callback<string>): ChainableCommander
- \n
Echo the given string
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
message: string | Buffer
Optional callback: Callback<string>
Returns ChainableCommander
echo
- echo
Buffer(message: string | Buffer, callback?: Callback<Buffer>): ChainableCommander
Parameters
message: string | Buffer
Optional callback: Callback<Buffer>
Returns ChainableCommander
eval
- eval(script: string | Buffer, numkeys: string | number, callback?: Callback<unknown>): ChainableCommander
- eval(...args: [script: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- eval(...args: [script: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[]]): ChainableCommander
- eval(...args: [script: string | Buffer, numkeys: string | number, ...keys: RedisKey[], callback: Callback<unknown>]): ChainableCommander
- eval(...args: [script: string | Buffer, numkeys: string | number, keys: RedisKey[], callback: Callback<unknown>]): ChainableCommander
- eval(...args: [script: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]): ChainableCommander
- eval(...args: [script: string | Buffer, numkeys: string | number, keys: RedisKey[]]): ChainableCommander
- eval(...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]): ChainableCommander
- eval(...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[]]): ChainableCommander
- \n
Execute a Lua script server side
\n- \n
- group: scripting \n
- complexity: Depends on the script that is executed. \n
- since: 2.6.0 \n
Parameters
script: string | Buffer
numkeys: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...keys: RedisKey[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, keys: RedisKey[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns ChainableCommander
eval_
- eval_
ro(...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]): ChainableCommander - eval_
ro(...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[]]): ChainableCommander
- \n
Execute a read-only Lua script server side
\n- \n
- group: scripting \n
- complexity: Depends on the script that is executed. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns ChainableCommander
evalsha
- evalsha(sha1: string | Buffer, numkeys: string | number, callback?: Callback<unknown>): ChainableCommander
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[]]): ChainableCommander
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, ...keys: RedisKey[], callback: Callback<unknown>]): ChainableCommander
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, keys: RedisKey[], callback: Callback<unknown>]): ChainableCommander
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]): ChainableCommander
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, keys: RedisKey[]]): ChainableCommander
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]): ChainableCommander
- evalsha(...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[]]): ChainableCommander
- \n
Execute a Lua script server side
\n- \n
- group: scripting \n
- complexity: Depends on the script that is executed. \n
- since: 2.6.0 \n
Parameters
sha1: string | Buffer
numkeys: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...args: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...keys: RedisKey[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, keys: RedisKey[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns ChainableCommander
evalsha_
- evalsha_
ro(...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]): ChainableCommander - evalsha_
ro(...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[]]): ChainableCommander
- \n
Execute a read-only Lua script server side
\n- \n
- group: scripting \n
- complexity: Depends on the script that is executed. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns ChainableCommander
exec
- exec(callback?: Callback<[error: Error, result: unknown][]>): Promise<[error: Error, result: unknown][]>
- \n
Execute all commands issued after MULTI
\n- \n
- group: transactions \n
- complexity: Depends on commands in the transaction \n
- since: 1.2.0 \n
Parameters
Optional callback: Callback<[error: Error, result: unknown][]>
Returns Promise<[error: Error, result: unknown][]>
exists
- exists(...args: [...keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- exists(...args: [keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- exists(...args: RedisKey[]): ChainableCommander
- exists(...args: [keys: RedisKey[]]): ChainableCommander
- \n
Determine if a key exists
\n- \n
- group: generic \n
- complexity: O(N) where N is the number of keys to check. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: RedisKey[]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[]]
Returns ChainableCommander
expire
- expire(key: RedisKey, seconds: string | number, callback?: Callback<number>): ChainableCommander
- expire(key: RedisKey, seconds: string | number, nx: "NX", callback?: Callback<number>): ChainableCommander
- expire(key: RedisKey, seconds: string | number, xx: "XX", callback?: Callback<number>): ChainableCommander
- expire(key: RedisKey, seconds: string | number, gt: "GT", callback?: Callback<number>): ChainableCommander
- expire(key: RedisKey, seconds: string | number, lt: "LT", callback?: Callback<number>): ChainableCommander
- \n
Set a key's time to live in seconds
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
seconds: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
seconds: string | number
nx: "NX"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
seconds: string | number
xx: "XX"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
seconds: string | number
gt: "GT"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
seconds: string | number
lt: "LT"
Optional callback: Callback<number>
Returns ChainableCommander
expireat
- expireat(key: RedisKey, unixTimeSeconds: string | number, callback?: Callback<number>): ChainableCommander
- expireat(key: RedisKey, unixTimeSeconds: string | number, nx: "NX", callback?: Callback<number>): ChainableCommander
- expireat(key: RedisKey, unixTimeSeconds: string | number, xx: "XX", callback?: Callback<number>): ChainableCommander
- expireat(key: RedisKey, unixTimeSeconds: string | number, gt: "GT", callback?: Callback<number>): ChainableCommander
- expireat(key: RedisKey, unixTimeSeconds: string | number, lt: "LT", callback?: Callback<number>): ChainableCommander
- \n
Set the expiration for a key as a UNIX timestamp
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.2.0 \n
Parameters
key: RedisKey
unixTimeSeconds: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
unixTimeSeconds: string | number
nx: "NX"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
unixTimeSeconds: string | number
xx: "XX"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
unixTimeSeconds: string | number
gt: "GT"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
unixTimeSeconds: string | number
lt: "LT"
Optional callback: Callback<number>
Returns ChainableCommander
expiretime
- expiretime(key: RedisKey, callback?: Callback<number>): ChainableCommander
- \n
Get the expiration Unix timestamp for a key
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns ChainableCommander
failover
- failover(callback?: Callback<"OK">): ChainableCommander
- failover(millisecondsToken: "TIMEOUT", milliseconds: string | number, callback?: Callback<"OK">): ChainableCommander
- failover(abort: "ABORT", callback?: Callback<"OK">): ChainableCommander
- failover(abort: "ABORT", millisecondsToken: "TIMEOUT", milliseconds: string | number, callback?: Callback<"OK">): ChainableCommander
- failover(targetToken: "TO", host: string | Buffer, port: string | number, callback?: Callback<"OK">): ChainableCommander
- failover(targetToken: "TO", host: string | Buffer, port: string | number, millisecondsToken: "TIMEOUT", milliseconds: string | number, callback?: Callback<"OK">): ChainableCommander
- failover(targetToken: "TO", host: string | Buffer, port: string | number, abort: "ABORT", callback?: Callback<"OK">): ChainableCommander
- failover(targetToken: "TO", host: string | Buffer, port: string | number, abort: "ABORT", millisecondsToken: "TIMEOUT", milliseconds: string | number, callback?: Callback<"OK">): ChainableCommander
- failover(targetToken: "TO", host: string | Buffer, port: string | number, force: "FORCE", callback?: Callback<"OK">): ChainableCommander
- failover(targetToken: "TO", host: string | Buffer, port: string | number, force: "FORCE", millisecondsToken: "TIMEOUT", milliseconds: string | number, callback?: Callback<"OK">): ChainableCommander
- failover(targetToken: "TO", host: string | Buffer, port: string | number, force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): ChainableCommander
- failover(targetToken: "TO", host: string | Buffer, port: string | number, force: "FORCE", abort: "ABORT", millisecondsToken: "TIMEOUT", milliseconds: string | number, callback?: Callback<"OK">): ChainableCommander
- \n
Start a coordinated failover between this server and one of its replicas.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
millisecondsToken: "TIMEOUT"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
abort: "ABORT"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
abort: "ABORT"
millisecondsToken: "TIMEOUT"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
millisecondsToken: "TIMEOUT"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
abort: "ABORT"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
abort: "ABORT"
millisecondsToken: "TIMEOUT"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
force: "FORCE"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
force: "FORCE"
millisecondsToken: "TIMEOUT"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
targetToken: "TO"
host: string | Buffer
port: string | number
force: "FORCE"
abort: "ABORT"
millisecondsToken: "TIMEOUT"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
fcall
- fcall(...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]): ChainableCommander
- fcall(...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[]]): ChainableCommander
- \n
Invoke a function
\n- \n
- group: scripting \n
- complexity: Depends on the function that is executed. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns ChainableCommander
fcall_
- fcall_
ro(...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]): ChainableCommander - fcall_
ro(...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[]]): ChainableCommander
- \n
Invoke a read-only function
\n- \n
- group: scripting \n
- complexity: Depends on the function that is executed. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [function: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns ChainableCommander
flushall
- flushall(callback?: Callback<"OK">): ChainableCommander
- flushall(async: "ASYNC", callback?: Callback<"OK">): ChainableCommander
- flushall(sync: "SYNC", callback?: Callback<"OK">): ChainableCommander
- \n
Remove all keys from all databases
\n- \n
- group: server \n
- complexity: O(N) where N is the total number of keys in all databases \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
async: "ASYNC"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
sync: "SYNC"
Optional callback: Callback<"OK">
Returns ChainableCommander
flushdb
- flushdb(callback?: Callback<"OK">): ChainableCommander
- flushdb(async: "ASYNC", callback?: Callback<"OK">): ChainableCommander
- flushdb(sync: "SYNC", callback?: Callback<"OK">): ChainableCommander
- \n
Remove all keys from the current database
\n- \n
- group: server \n
- complexity: O(N) where N is the number of keys in the selected database \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
async: "ASYNC"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
sync: "SYNC"
Optional callback: Callback<"OK">
Returns ChainableCommander
function
- function(subcommand: "DELETE", libraryName: string | Buffer, callback?: Callback<string>): ChainableCommander
- function(subcommand: "DUMP", callback?: Callback<string>): ChainableCommander
- function(subcommand: "FLUSH", callback?: Callback<string>): ChainableCommander
- function(subcommand: "FLUSH", async: "ASYNC", callback?: Callback<string>): ChainableCommander
- function(subcommand: "FLUSH", sync: "SYNC", callback?: Callback<string>): ChainableCommander
- function(subcommand: "HELP", callback?: Callback<unknown>): ChainableCommander
- function(subcommand: "KILL", callback?: Callback<string>): ChainableCommander
- function(subcommand: "LIST", callback?: Callback<unknown[]>): ChainableCommander
- function(subcommand: "LIST", withcode: "WITHCODE", callback?: Callback<unknown[]>): ChainableCommander
- function(subcommand: "LIST", libraryNamePatternToken: "LIBRARYNAME", libraryNamePattern: string | Buffer, callback?: Callback<unknown[]>): ChainableCommander
- function(subcommand: "LIST", libraryNamePatternToken: "LIBRARYNAME", libraryNamePattern: string | Buffer, withcode: "WITHCODE", callback?: Callback<unknown[]>): ChainableCommander
- function(subcommand: "LOAD", functionCode: string | Buffer, callback?: Callback<string>): ChainableCommander
- function(subcommand: "LOAD", replace: "REPLACE", functionCode: string | Buffer, callback?: Callback<string>): ChainableCommander
- function(subcommand: "RESTORE", serializedValue: string | number | Buffer, callback?: Callback<string>): ChainableCommander
- function(subcommand: "RESTORE", serializedValue: string | number | Buffer, flush: "FLUSH", callback?: Callback<string>): ChainableCommander
- function(subcommand: "RESTORE", serializedValue: string | number | Buffer, append: "APPEND", callback?: Callback<string>): ChainableCommander
- function(subcommand: "RESTORE", serializedValue: string | number | Buffer, replace: "REPLACE", callback?: Callback<string>): ChainableCommander
- function(subcommand: "STATS", callback?: Callback<unknown>): ChainableCommander
- \n
Delete a function by name
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
subcommand: "DELETE"
libraryName: string | Buffer
Optional callback: Callback<string>
Returns ChainableCommander
- \n
Dump all functions into a serialized binary payload
\n- \n
- group: scripting \n
- complexity: O(N) where N is the number of functions \n
- since: 7.0.0 \n
Parameters
subcommand: "DUMP"
Optional callback: Callback<string>
Returns ChainableCommander
- \n
Deleting all functions
\n- \n
- group: scripting \n
- complexity: O(N) where N is the number of functions deleted \n
- since: 7.0.0 \n
Parameters
subcommand: "FLUSH"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
subcommand: "FLUSH"
async: "ASYNC"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
subcommand: "FLUSH"
sync: "SYNC"
Optional callback: Callback<string>
Returns ChainableCommander
- \n
Show helpful text about the different subcommands
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Kill the function currently in execution.
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
subcommand: "KILL"
Optional callback: Callback<string>
Returns ChainableCommander
- \n
List information about all the functions
\n- \n
- group: scripting \n
- complexity: O(N) where N is the number of functions \n
- since: 7.0.0 \n
Parameters
subcommand: "LIST"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
subcommand: "LIST"
withcode: "WITHCODE"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
subcommand: "LIST"
libraryNamePatternToken: "LIBRARYNAME"
libraryNamePattern: string | Buffer
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
subcommand: "LIST"
libraryNamePatternToken: "LIBRARYNAME"
libraryNamePattern: string | Buffer
withcode: "WITHCODE"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
- \n
Create a function with the given arguments (name, code, description)
\n- \n
- group: scripting \n
- complexity: O(1) (considering compilation time is redundant) \n
- since: 7.0.0 \n
Parameters
subcommand: "LOAD"
functionCode: string | Buffer
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
subcommand: "LOAD"
replace: "REPLACE"
functionCode: string | Buffer
Optional callback: Callback<string>
Returns ChainableCommander
- \n
Restore all the functions on the given payload
\n- \n
- group: scripting \n
- complexity: O(N) where N is the number of functions on the payload \n
- since: 7.0.0 \n
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
flush: "FLUSH"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
append: "APPEND"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
replace: "REPLACE"
Optional callback: Callback<string>
Returns ChainableCommander
- \n
Return information about the function currently running (name, description, duration)
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
subcommand: "STATS"
Optional callback: Callback<unknown>
Returns ChainableCommander
function
- function
Buffer(subcommand: "DELETE", libraryName: string | Buffer, callback?: Callback<Buffer>): ChainableCommander - function
Buffer(subcommand: "DUMP", callback?: Callback<Buffer>): ChainableCommander - function
Buffer(subcommand: "FLUSH", callback?: Callback<Buffer>): ChainableCommander - function
Buffer(subcommand: "FLUSH", async: "ASYNC", callback?: Callback<Buffer>): ChainableCommander - function
Buffer(subcommand: "FLUSH", sync: "SYNC", callback?: Callback<Buffer>): ChainableCommander - function
Buffer(subcommand: "KILL", callback?: Callback<Buffer>): ChainableCommander - function
Buffer(subcommand: "LOAD", functionCode: string | Buffer, callback?: Callback<Buffer>): ChainableCommander - function
Buffer(subcommand: "LOAD", replace: "REPLACE", functionCode: string | Buffer, callback?: Callback<Buffer>): ChainableCommander - function
Buffer(subcommand: "RESTORE", serializedValue: string | number | Buffer, callback?: Callback<Buffer>): ChainableCommander - function
Buffer(subcommand: "RESTORE", serializedValue: string | number | Buffer, flush: "FLUSH", callback?: Callback<Buffer>): ChainableCommander - function
Buffer(subcommand: "RESTORE", serializedValue: string | number | Buffer, append: "APPEND", callback?: Callback<Buffer>): ChainableCommander - function
Buffer(subcommand: "RESTORE", serializedValue: string | number | Buffer, replace: "REPLACE", callback?: Callback<Buffer>): ChainableCommander
Parameters
subcommand: "DELETE"
libraryName: string | Buffer
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
subcommand: "DUMP"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
subcommand: "FLUSH"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
subcommand: "FLUSH"
async: "ASYNC"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
subcommand: "FLUSH"
sync: "SYNC"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
subcommand: "KILL"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
subcommand: "LOAD"
functionCode: string | Buffer
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
subcommand: "LOAD"
replace: "REPLACE"
functionCode: string | Buffer
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
flush: "FLUSH"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
append: "APPEND"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
subcommand: "RESTORE"
serializedValue: string | number | Buffer
replace: "REPLACE"
Optional callback: Callback<Buffer>
Returns ChainableCommander
geoadd
- geoadd(...args: [key: RedisKey, ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- geoadd(...args: [key: RedisKey, ...longitudeLatitudeMembers: (string | number | Buffer)[]]): ChainableCommander
- geoadd(...args: [key: RedisKey, ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- geoadd(...args: [key: RedisKey, ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[]]): ChainableCommander
- geoadd(...args: [key: RedisKey, nx: "NX", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- geoadd(...args: [key: RedisKey, nx: "NX", ...longitudeLatitudeMembers: (string | number | Buffer)[]]): ChainableCommander
- geoadd(...args: [key: RedisKey, nx: "NX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- geoadd(...args: [key: RedisKey, nx: "NX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[]]): ChainableCommander
- geoadd(...args: [key: RedisKey, xx: "XX", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- geoadd(...args: [key: RedisKey, xx: "XX", ...longitudeLatitudeMembers: (string | number | Buffer)[]]): ChainableCommander
- geoadd(...args: [key: RedisKey, xx: "XX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- geoadd(...args: [key: RedisKey, xx: "XX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[]]): ChainableCommander
- \n
Add one or more geospatial items in the geospatial index represented using a sorted set
\n- \n
- group: geo \n
- complexity: O(log(N)) for each item added, where N is the number of elements in the sorted set. \n
- since: 3.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...longitudeLatitudeMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ...longitudeLatitudeMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ...longitudeLatitudeMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", ...longitudeLatitudeMembers: (string | number | Buffer)[]]
Returns ChainableCommander
geodist
- geodist(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, callback?: Callback<string>): ChainableCommander
- geodist(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, m: "M", callback?: Callback<string>): ChainableCommander
- geodist(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, km: "KM", callback?: Callback<string>): ChainableCommander
- geodist(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, ft: "FT", callback?: Callback<string>): ChainableCommander
- geodist(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, mi: "MI", callback?: Callback<string>): ChainableCommander
- \n
Returns the distance between two members of a geospatial index
\n- \n
- group: geo \n
- complexity: O(log(N)) \n
- since: 3.2.0 \n
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
m: "M"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
km: "KM"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
ft: "FT"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
mi: "MI"
Optional callback: Callback<string>
Returns ChainableCommander
geodist
- geodist
Buffer(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, callback?: Callback<Buffer>): ChainableCommander - geodist
Buffer(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, m: "M", callback?: Callback<Buffer>): ChainableCommander - geodist
Buffer(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, km: "KM", callback?: Callback<Buffer>): ChainableCommander - geodist
Buffer(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, ft: "FT", callback?: Callback<Buffer>): ChainableCommander - geodist
Buffer(key: RedisKey, member1: string | number | Buffer, member2: string | number | Buffer, mi: "MI", callback?: Callback<Buffer>): ChainableCommander
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
m: "M"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
km: "KM"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
ft: "FT"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
member1: string | number | Buffer
member2: string | number | Buffer
mi: "MI"
Optional callback: Callback<Buffer>
Returns ChainableCommander
geohash
- geohash(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<string[]>]): ChainableCommander
- geohash(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<string[]>]): ChainableCommander
- geohash(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): ChainableCommander
- geohash(...args: [key: RedisKey, members: (string | number | Buffer)[]]): ChainableCommander
- \n
Returns members of a geospatial index as standard geohash strings
\n- \n
- group: geo \n
- complexity: O(log(N)) for each member requested, where N is the number of elements in the sorted set. \n
- since: 3.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns ChainableCommander
geohash
- geohash
Buffer(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<Buffer[]>]): ChainableCommander - geohash
Buffer(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<Buffer[]>]): ChainableCommander - geohash
Buffer(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): ChainableCommander - geohash
Buffer(...args: [key: RedisKey, members: (string | number | Buffer)[]]): ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns ChainableCommander
geopos
- geopos(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<[longitude: string, latitude: string][]>]): ChainableCommander
- geopos(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<[longitude: string, latitude: string][]>]): ChainableCommander
- geopos(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): ChainableCommander
- geopos(...args: [key: RedisKey, members: (string | number | Buffer)[]]): ChainableCommander
- \n
Returns longitude and latitude of members of a geospatial index
\n- \n
- group: geo \n
- complexity: O(N) where N is the number of members requested. \n
- since: 3.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<[longitude: string, latitude: string][]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<[longitude: string, latitude: string][]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns ChainableCommander
georadius
- georadius(...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[], callback: Callback<unknown[]>]): ChainableCommander
- georadius(...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[]]): ChainableCommander
- \n
Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point
\n- \n
- group: geo \n
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index. \n
- since: 3.2.0 \n
Parameters
Rest ...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[], callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[]]
Returns ChainableCommander
georadius_
- georadius_
ro(...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[], callback: Callback<unknown>]): ChainableCommander - georadius_
ro(...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[]]): ChainableCommander
- \n
A read-only variant for GEORADIUS
\n- \n
- group: geo \n
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index. \n
- since: 3.2.10 \n
Parameters
Rest ...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, longitude: string | number, latitude: string | number, radius: string | number, ...args: RedisValue[]]
Returns ChainableCommander
georadiusbymember
- georadiusbymember(...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[], callback: Callback<unknown>]): ChainableCommander
- georadiusbymember(...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[]]): ChainableCommander
- \n
Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a member
\n- \n
- group: geo \n
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index. \n
- since: 3.2.0 \n
Parameters
Rest ...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[]]
Returns ChainableCommander
georadiusbymember_
- georadiusbymember_
ro(...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[], callback: Callback<unknown>]): ChainableCommander - georadiusbymember_
ro(...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[]]): ChainableCommander
- \n
A read-only variant for GEORADIUSBYMEMBER
\n- \n
- group: geo \n
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index. \n
- since: 3.2.10 \n
Parameters
Rest ...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, member: string | number | Buffer, radius: string | number, ...args: RedisValue[]]
Returns ChainableCommander
geosearch
- geosearch(...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<unknown[]>]): ChainableCommander
- geosearch(...args: [key: RedisKey, ...args: RedisValue[]]): ChainableCommander
- \n
Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle.
\n- \n
- group: geo \n
- complexity: O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape \n
- since: 6.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[]]
Returns ChainableCommander
geosearchstore
- geosearchstore(...args: [destination: RedisKey, source: RedisKey, ...args: RedisValue[], callback: Callback<number>]): ChainableCommander
- geosearchstore(...args: [destination: RedisKey, source: RedisKey, ...args: RedisValue[]]): ChainableCommander
- \n
Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle, and store the result in another key.
\n- \n
- group: geo \n
- complexity: O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape \n
- since: 6.2.0 \n
Parameters
Rest ...args: [destination: RedisKey, source: RedisKey, ...args: RedisValue[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, source: RedisKey, ...args: RedisValue[]]
Returns ChainableCommander
get
- get(key: RedisKey, callback?: Callback<string>): ChainableCommander
- \n
Get the value of a key
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns ChainableCommander
get
- get
Buffer(key: RedisKey, callback?: Callback<Buffer>): ChainableCommander
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns ChainableCommander
getbit
- getbit(key: RedisKey, offset: string | number, callback?: Callback<number>): ChainableCommander
- \n
Returns the bit value at offset in the string value stored at key
\n- \n
- group: bitmap \n
- complexity: O(1) \n
- since: 2.2.0 \n
Parameters
key: RedisKey
offset: string | number
Optional callback: Callback<number>
Returns ChainableCommander
getdel
- getdel(key: RedisKey, callback?: Callback<string>): ChainableCommander
- \n
Get the value of a key and delete the key
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns ChainableCommander
getdel
- getdel
Buffer(key: RedisKey, callback?: Callback<Buffer>): ChainableCommander
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns ChainableCommander
getex
- getex(key: RedisKey, callback?: Callback<string>): ChainableCommander
- getex(key: RedisKey, secondsToken: "EX", seconds: string | number, callback?: Callback<string>): ChainableCommander
- getex(key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, callback?: Callback<string>): ChainableCommander
- getex(key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, callback?: Callback<string>): ChainableCommander
- getex(key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, callback?: Callback<string>): ChainableCommander
- getex(key: RedisKey, persist: "PERSIST", callback?: Callback<string>): ChainableCommander
- \n
Get the value of a key and optionally set its expiration
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
secondsToken: "EX"
seconds: string | number
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
millisecondsToken: "PX"
milliseconds: string | number
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
persist: "PERSIST"
Optional callback: Callback<string>
Returns ChainableCommander
getex
- getex
Buffer(key: RedisKey, callback?: Callback<Buffer>): ChainableCommander - getex
Buffer(key: RedisKey, secondsToken: "EX", seconds: string | number, callback?: Callback<Buffer>): ChainableCommander - getex
Buffer(key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, callback?: Callback<Buffer>): ChainableCommander - getex
Buffer(key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, callback?: Callback<Buffer>): ChainableCommander - getex
Buffer(key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, callback?: Callback<Buffer>): ChainableCommander - getex
Buffer(key: RedisKey, persist: "PERSIST", callback?: Callback<Buffer>): ChainableCommander
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
secondsToken: "EX"
seconds: string | number
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
millisecondsToken: "PX"
milliseconds: string | number
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
persist: "PERSIST"
Optional callback: Callback<Buffer>
Returns ChainableCommander
getrange
- getrange(key: RedisKey, start: string | number, end: string | number, callback?: Callback<string>): ChainableCommander
- \n
Get a substring of the string stored at a key
\n- \n
- group: string \n
- complexity: O(N) where N is the length of the returned string. The complexity is ultimately determined by the returned length, but because creating a substring from an existing string is very cheap, it can be considered O(1) for small strings. \n
- since: 2.4.0 \n
Parameters
key: RedisKey
start: string | number
end: string | number
Optional callback: Callback<string>
Returns ChainableCommander
getrange
- getrange
Buffer(key: RedisKey, start: string | number, end: string | number, callback?: Callback<Buffer>): ChainableCommander
Parameters
key: RedisKey
start: string | number
end: string | number
Optional callback: Callback<Buffer>
Returns ChainableCommander
getset
- getset(key: RedisKey, value: string | number | Buffer, callback?: Callback<string>): ChainableCommander
- \n
Set the string value of a key and return its old value
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
value: string | number | Buffer
Optional callback: Callback<string>
Returns ChainableCommander
getset
- getset
Buffer(key: RedisKey, value: string | number | Buffer, callback?: Callback<Buffer>): ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
Optional callback: Callback<Buffer>
Returns ChainableCommander
hdel
- hdel(...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<number>]): ChainableCommander
- hdel(...args: [key: RedisKey, ...fields: (string | Buffer)[]]): ChainableCommander
- \n
Delete one or more hash fields
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of fields to be removed. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...fields: (string | Buffer)[]]
Returns ChainableCommander
hello
- hello(callback?: Callback<unknown[]>): ChainableCommander
- hello(protover: string | number, callback?: Callback<unknown[]>): ChainableCommander
- hello(protover: string | number, clientnameToken: "SETNAME", clientname: string | Buffer, callback?: Callback<unknown[]>): ChainableCommander
- hello(protover: string | number, usernamePasswordToken: "AUTH", username: string | Buffer, password: string | Buffer, callback?: Callback<unknown[]>): ChainableCommander
- hello(protover: string | number, usernamePasswordToken: "AUTH", username: string | Buffer, password: string | Buffer, clientnameToken: "SETNAME", clientname: string | Buffer, callback?: Callback<unknown[]>): ChainableCommander
- \n
Handshake with Redis
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 6.0.0 \n
Parameters
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
protover: string | number
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
protover: string | number
clientnameToken: "SETNAME"
clientname: string | Buffer
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
protover: string | number
usernamePasswordToken: "AUTH"
username: string | Buffer
password: string | Buffer
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
protover: string | number
usernamePasswordToken: "AUTH"
username: string | Buffer
password: string | Buffer
clientnameToken: "SETNAME"
clientname: string | Buffer
Optional callback: Callback<unknown[]>
Returns ChainableCommander
hexists
- hexists(key: RedisKey, field: string | Buffer, callback?: Callback<number>): ChainableCommander
- \n
Determine if a hash field exists
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
field: string | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
hexpire
- hexpire(...args: [key: RedisKey, seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hexpire(...args: [key: RedisKey, seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hexpire(...args: [key: RedisKey, seconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hexpire(...args: [key: RedisKey, seconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hexpire(...args: [key: RedisKey, seconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hexpire(...args: [key: RedisKey, seconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hexpire(...args: [key: RedisKey, seconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hexpire(...args: [key: RedisKey, seconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hexpire(...args: [key: RedisKey, seconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hexpire(...args: [key: RedisKey, seconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- \n
Set expiry for hash field using relative time to expire (seconds)
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, seconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
hexpireat
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hexpireat(...args: [key: RedisKey, unixTimeSeconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- \n
Set expiry for hash field using an absolute Unix timestamp (seconds)
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeSeconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
hexpiretime
- hexpiretime(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hexpiretime(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- \n
Returns the expiration time of a hash field as a Unix timestamp, in seconds.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
hget
- hget(key: RedisKey, field: string | Buffer, callback?: Callback<string>): ChainableCommander
- \n
Get the value of a hash field
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
field: string | Buffer
Optional callback: Callback<string>
Returns ChainableCommander
hget
- hget
Buffer(key: RedisKey, field: string | Buffer, callback?: Callback<Buffer>): ChainableCommander
Parameters
key: RedisKey
field: string | Buffer
Optional callback: Callback<Buffer>
Returns ChainableCommander
hgetall
- hgetall(key: RedisKey, callback?: Callback<Record<string, string>>): ChainableCommander
- \n
Get all the fields and values in a hash
\n- \n
- group: hash \n
- complexity: O(N) where N is the size of the hash. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<Record<string, string>>
Returns ChainableCommander
hgetall
- hgetall
Buffer(key: RedisKey, callback?: Callback<Record<string, Buffer>>): ChainableCommander
Parameters
key: RedisKey
Optional callback: Callback<Record<string, Buffer>>
Returns ChainableCommander
hgetdel
- hgetdel(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): ChainableCommander
- hgetdel(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- \n
Returns the value of a field and deletes it from the hash.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 8.0.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
hgetdel
- hgetdel
Buffer(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): ChainableCommander - hgetdel
Buffer(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
hgetex
- hgetex(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): ChainableCommander
- hgetex(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hgetex(...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): ChainableCommander
- hgetex(...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hgetex(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): ChainableCommander
- hgetex(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hgetex(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): ChainableCommander
- hgetex(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hgetex(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): ChainableCommander
- hgetex(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hgetex(...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]): ChainableCommander
- hgetex(...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- \n
Get the value of one or more fields of a given hash key, and optionally set their expiration.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 8.0.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
hgetex
- hgetex
Buffer(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): ChainableCommander - hgetex
Buffer(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander - hgetex
Buffer(...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): ChainableCommander - hgetex
Buffer(...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander - hgetex
Buffer(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): ChainableCommander - hgetex
Buffer(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander - hgetex
Buffer(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): ChainableCommander - hgetex
Buffer(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander - hgetex
Buffer(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): ChainableCommander - hgetex
Buffer(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander - hgetex
Buffer(...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): ChainableCommander - hgetex
Buffer(...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
hincrby
- hincrby(key: RedisKey, field: string | Buffer, increment: string | number, callback?: Callback<number>): ChainableCommander
- \n
Increment the integer value of a hash field by the given number
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
field: string | Buffer
increment: string | number
Optional callback: Callback<number>
Returns ChainableCommander
hincrbyfloat
- hincrbyfloat(key: RedisKey, field: string | Buffer, increment: string | number, callback?: Callback<string>): ChainableCommander
- \n
Increment the float value of a hash field by the given amount
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
field: string | Buffer
increment: string | number
Optional callback: Callback<string>
Returns ChainableCommander
hincrbyfloat
- hincrbyfloat
Buffer(key: RedisKey, field: string | Buffer, increment: string | number, callback?: Callback<Buffer>): ChainableCommander
Parameters
key: RedisKey
field: string | Buffer
increment: string | number
Optional callback: Callback<Buffer>
Returns ChainableCommander
hkeys
- hkeys(key: RedisKey, callback?: Callback<string[]>): ChainableCommander
- \n
Get all the fields in a hash
\n- \n
- group: hash \n
- complexity: O(N) where N is the size of the hash. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string[]>
Returns ChainableCommander
hkeys
- hkeys
Buffer(key: RedisKey, callback?: Callback<Buffer[]>): ChainableCommander
Parameters
key: RedisKey
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
hlen
- hlen(key: RedisKey, callback?: Callback<number>): ChainableCommander
- \n
Get the number of fields in a hash
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns ChainableCommander
hmget
- hmget(...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<string[]>]): ChainableCommander
- hmget(...args: [key: RedisKey, ...fields: (string | Buffer)[]]): ChainableCommander
- \n
Get the values of all the given hash fields
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of fields being requested. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...fields: (string | Buffer)[]]
Returns ChainableCommander
hmget
- hmget
Buffer(...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]): ChainableCommander - hmget
Buffer(...args: [key: RedisKey, ...fields: (string | Buffer)[]]): ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...fields: (string | Buffer)[]]
Returns ChainableCommander
hmset
- hmset(key: RedisKey, object: object, callback?: Callback<"OK">): ChainableCommander
- hmset(key: RedisKey, map: Map<string | number | Buffer, string | number | Buffer>, callback?: Callback<"OK">): ChainableCommander
- hmset(...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[], callback: Callback<"OK">]): ChainableCommander
- hmset(...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[]]): ChainableCommander
- \n
Set multiple hash fields to multiple values
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of fields being set. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
object: object
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
map: Map<string | number | Buffer, string | number | Buffer>
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[], callback: Callback<"OK">]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[]]
Returns ChainableCommander
hpersist
- hpersist(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hpersist(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- \n
Removes the expiration time for each specified field
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
hpexpire
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hpexpire(...args: [key: RedisKey, milliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- \n
Set expiry for hash field using relative time to expire (milliseconds)
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, milliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
hpexpireat
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- \n
Set expiry for hash field using an absolute Unix timestamp (milliseconds)
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, nx: "NX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, xx: "XX", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, gt: "GT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeMilliseconds: string | number, lt: "LT", fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
hpexpiretime
- hpexpiretime(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hpexpiretime(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- \n
Returns the expiration time of a hash field as a Unix timestamp, in msec.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
hpttl
- hpttl(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- hpttl(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- \n
Returns the TTL in milliseconds of a hash field.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
hrandfield
- hrandfield(key: RedisKey, callback?: Callback<string | unknown[]>): ChainableCommander
- hrandfield(key: RedisKey, count: string | number, callback?: Callback<string | unknown[]>): ChainableCommander
- hrandfield(key: RedisKey, count: string | number, withvalues: "WITHVALUES", callback?: Callback<string | unknown[]>): ChainableCommander
- \n
Get one or multiple random fields from a hash
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of fields returned \n
- since: 6.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string | unknown[]>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string | unknown[]>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
withvalues: "WITHVALUES"
Optional callback: Callback<string | unknown[]>
Returns ChainableCommander
hrandfield
- hrandfield
Buffer(key: RedisKey, callback?: Callback<unknown[] | Buffer>): ChainableCommander - hrandfield
Buffer(key: RedisKey, count: string | number, callback?: Callback<unknown[] | Buffer>): ChainableCommander - hrandfield
Buffer(key: RedisKey, count: string | number, withvalues: "WITHVALUES", callback?: Callback<unknown[] | Buffer>): ChainableCommander
Parameters
key: RedisKey
Optional callback: Callback<unknown[] | Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<unknown[] | Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
withvalues: "WITHVALUES"
Optional callback: Callback<unknown[] | Buffer>
Returns ChainableCommander
hscan
- hscan(key: RedisKey, cursor: string | number, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- hscan(key: RedisKey, cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- hscan(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- hscan(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- \n
Incrementally iterate hash fields and associated values
\n- \n
- group: hash \n
- complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.. \n
- since: 2.8.0 \n
Parameters
key: RedisKey
cursor: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
Parameters
key: RedisKey
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
hscan
- hscan
Buffer(key: RedisKey, cursor: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander - hscan
Buffer(key: RedisKey, cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander - hscan
Buffer(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander - hscan
Buffer(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander
Parameters
key: RedisKey
cursor: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
Parameters
key: RedisKey
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
hset
- hset(key: RedisKey, object: object, callback?: Callback<number>): ChainableCommander
- hset(key: RedisKey, map: Map<string | number | Buffer, string | number | Buffer>, callback?: Callback<number>): ChainableCommander
- hset(...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hset(...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[]]): ChainableCommander
- \n
Set the string value of a hash field
\n- \n
- group: hash \n
- complexity: O(1) for each field/value pair added, so O(N) to add N field/value pairs when the command is called with multiple field/value pairs. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
object: object
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
map: Map<string | number | Buffer, string | number | Buffer>
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...fieldValues: (string | number | Buffer)[]]
Returns ChainableCommander
hsetex
- hsetex(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hsetex(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): ChainableCommander
- hsetex(...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hsetex(...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): ChainableCommander
- hsetex(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hsetex(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): ChainableCommander
- hsetex(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hsetex(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): ChainableCommander
- hsetex(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hsetex(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): ChainableCommander
- hsetex(...args: [key: RedisKey, keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hsetex(...args: [key: RedisKey, keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): ChainableCommander
- hsetex(...args: [key: RedisKey, fnx: "FNX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hsetex(...args: [key: RedisKey, fnx: "FNX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): ChainableCommander
- hsetex(...args: [key: RedisKey, fnx: "FNX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hsetex(...args: [key: RedisKey, fnx: "FNX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): ChainableCommander
- hsetex(...args: [key: RedisKey, fnx: "FNX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hsetex(...args: [key: RedisKey, fnx: "FNX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): ChainableCommander
- hsetex(...args: [key: RedisKey, fnx: "FNX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hsetex(...args: [key: RedisKey, fnx: "FNX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): ChainableCommander
- hsetex(...args: [key: RedisKey, fnx: "FNX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hsetex(...args: [key: RedisKey, fnx: "FNX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): ChainableCommander
- hsetex(...args: [key: RedisKey, fnx: "FNX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hsetex(...args: [key: RedisKey, fnx: "FNX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): ChainableCommander
- hsetex(...args: [key: RedisKey, fxx: "FXX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hsetex(...args: [key: RedisKey, fxx: "FXX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): ChainableCommander
- hsetex(...args: [key: RedisKey, fxx: "FXX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hsetex(...args: [key: RedisKey, fxx: "FXX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): ChainableCommander
- hsetex(...args: [key: RedisKey, fxx: "FXX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hsetex(...args: [key: RedisKey, fxx: "FXX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): ChainableCommander
- hsetex(...args: [key: RedisKey, fxx: "FXX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hsetex(...args: [key: RedisKey, fxx: "FXX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): ChainableCommander
- hsetex(...args: [key: RedisKey, fxx: "FXX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hsetex(...args: [key: RedisKey, fxx: "FXX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): ChainableCommander
- hsetex(...args: [key: RedisKey, fxx: "FXX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- hsetex(...args: [key: RedisKey, fxx: "FXX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]): ChainableCommander
- \n
Set the value of one or more fields of a given hash key, and optionally set their expiration.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of fields being set. \n
- since: 8.0.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fnx: "FNX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", secondsToken: "EX", seconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", millisecondsToken: "PX", milliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fxx: "FXX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: string | number, ...data: (string | number | Buffer)[]]
Returns ChainableCommander
hsetnx
- hsetnx(key: RedisKey, field: string | Buffer, value: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- \n
Set the value of a hash field, only if the field does not exist
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
field: string | Buffer
value: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
hstrlen
- hstrlen(key: RedisKey, field: string | Buffer, callback?: Callback<number>): ChainableCommander
- \n
Get the length of the value of a hash field
\n- \n
- group: hash \n
- complexity: O(1) \n
- since: 3.2.0 \n
Parameters
key: RedisKey
field: string | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
httl
- httl(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- httl(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]): ChainableCommander
- \n
Returns the TTL in seconds of a hash field.
\n- \n
- group: hash \n
- complexity: O(N) where N is the number of specified fields \n
- since: 7.4.0 \n
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: string | number, ...fields: (string | Buffer)[]]
Returns ChainableCommander
hvals
- hvals(key: RedisKey, callback?: Callback<string[]>): ChainableCommander
- \n
Get all the values in a hash
\n- \n
- group: hash \n
- complexity: O(N) where N is the size of the hash. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string[]>
Returns ChainableCommander
hvals
- hvals
Buffer(key: RedisKey, callback?: Callback<Buffer[]>): ChainableCommander
Parameters
key: RedisKey
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
incr
- incr(key: RedisKey, callback?: Callback<number>): ChainableCommander
- \n
Increment the integer value of a key by one
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns ChainableCommander
incrby
- incrby(key: RedisKey, increment: string | number, callback?: Callback<number>): ChainableCommander
- \n
Increment the integer value of a key by the given amount
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
increment: string | number
Optional callback: Callback<number>
Returns ChainableCommander
incrbyfloat
- incrbyfloat(key: RedisKey, increment: string | number, callback?: Callback<string>): ChainableCommander
- \n
Increment the float value of a key by the given amount
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
increment: string | number
Optional callback: Callback<string>
Returns ChainableCommander
info
- info(callback?: Callback<string>): ChainableCommander
- info(...args: [...sections: (string | Buffer)[], callback: Callback<string>]): ChainableCommander
- info(...args: (string | Buffer)[]): ChainableCommander
- \n
Get information and statistics about the server
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
Rest ...args: [...sections: (string | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: (string | Buffer)[]
Returns ChainableCommander
keys
- keys(pattern: string, callback?: Callback<string[]>): ChainableCommander
- \n
Find all keys matching the given pattern
\n- \n
- group: generic \n
- complexity: O(N) with N being the number of keys in the database, under the assumption that the key names in the database and the given pattern have limited length. \n
- since: 1.0.0 \n
Parameters
pattern: string
Optional callback: Callback<string[]>
Returns ChainableCommander
keys
- keys
Buffer(pattern: string, callback?: Callback<Buffer[]>): ChainableCommander
Parameters
pattern: string
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
lastsave
- lastsave(callback?: Callback<number>): ChainableCommander
- \n
Get the UNIX time stamp of the last successful save to disk
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<number>
Returns ChainableCommander
latency
- latency(subcommand: "DOCTOR", callback?: Callback<string>): ChainableCommander
- latency(subcommand: "GRAPH", event: string | Buffer, callback?: Callback<string>): ChainableCommander
- latency(subcommand: "HELP", callback?: Callback<unknown[]>): ChainableCommander
- latency(subcommand: "HISTOGRAM", callback?: Callback<unknown>): ChainableCommander
- latency(...args: [subcommand: "HISTOGRAM", ...commands: (string | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- latency(...args: [subcommand: "HISTOGRAM", ...commands: (string | Buffer)[]]): ChainableCommander
- latency(subcommand: "HISTORY", event: string | Buffer, callback?: Callback<unknown[]>): ChainableCommander
- latency(subcommand: "LATEST", callback?: Callback<unknown[]>): ChainableCommander
- latency(subcommand: "RESET", callback?: Callback<number>): ChainableCommander
- latency(...args: [subcommand: "RESET", ...events: (string | Buffer)[], callback: Callback<number>]): ChainableCommander
- latency(...args: [subcommand: "RESET", ...events: (string | Buffer)[]]): ChainableCommander
- \n
Return a human readable latency analysis report.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "DOCTOR"
Optional callback: Callback<string>
Returns ChainableCommander
- \n
Return a latency graph for the event.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "GRAPH"
event: string | Buffer
Optional callback: Callback<string>
Returns ChainableCommander
- \n
Show helpful text about the different subcommands.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
- \n
Return the cumulative distribution of latencies of a subset of commands or all.
\n- \n
- group: server \n
- complexity: O(N) where N is the number of commands with latency information being retrieved. \n
- since: 7.0.0 \n
Parameters
subcommand: "HISTOGRAM"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "HISTOGRAM", ...commands: (string | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "HISTOGRAM", ...commands: (string | Buffer)[]]
Returns ChainableCommander
- \n
Return timestamp-latency samples for the event.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "HISTORY"
event: string | Buffer
Optional callback: Callback<unknown[]>
Returns ChainableCommander
- \n
Return the latest latency samples for all events.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "LATEST"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
- \n
Reset latency data for one or more events.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.13 \n
Parameters
subcommand: "RESET"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "RESET", ...events: (string | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "RESET", ...events: (string | Buffer)[]]
Returns ChainableCommander
lcs
- lcs(key1: RedisKey, key2: RedisKey, callback?: Callback<unknown>): ChainableCommander
- lcs(key1: RedisKey, key2: RedisKey, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): ChainableCommander
- lcs(key1: RedisKey, key2: RedisKey, lenToken: "MINMATCHLEN", len: string | number, callback?: Callback<unknown>): ChainableCommander
- lcs(key1: RedisKey, key2: RedisKey, lenToken: "MINMATCHLEN", len: string | number, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): ChainableCommander
- lcs(key1: RedisKey, key2: RedisKey, idx: "IDX", callback?: Callback<unknown>): ChainableCommander
- lcs(key1: RedisKey, key2: RedisKey, idx: "IDX", withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): ChainableCommander
- lcs(key1: RedisKey, key2: RedisKey, idx: "IDX", lenToken: "MINMATCHLEN", len: string | number, callback?: Callback<unknown>): ChainableCommander
- lcs(key1: RedisKey, key2: RedisKey, idx: "IDX", lenToken: "MINMATCHLEN", len: string | number, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): ChainableCommander
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", callback?: Callback<unknown>): ChainableCommander
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): ChainableCommander
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", lenToken: "MINMATCHLEN", len1: string | number, callback?: Callback<unknown>): ChainableCommander
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", lenToken: "MINMATCHLEN", len1: string | number, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): ChainableCommander
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", idx: "IDX", callback?: Callback<unknown>): ChainableCommander
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", idx: "IDX", withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): ChainableCommander
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", idx: "IDX", lenToken: "MINMATCHLEN", len1: string | number, callback?: Callback<unknown>): ChainableCommander
- lcs(key1: RedisKey, key2: RedisKey, len: "LEN", idx: "IDX", lenToken: "MINMATCHLEN", len1: string | number, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): ChainableCommander
- \n
Find longest common substring
\n- \n
- group: string \n
- complexity: O(N*M) where N and M are the lengths of s1 and s2, respectively \n
- since: 7.0.0 \n
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
key1: RedisKey
key2: RedisKey
lenToken: "MINMATCHLEN"
len: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key1: RedisKey
key2: RedisKey
lenToken: "MINMATCHLEN"
len: string | number
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
key1: RedisKey
key2: RedisKey
idx: "IDX"
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key1: RedisKey
key2: RedisKey
idx: "IDX"
lenToken: "MINMATCHLEN"
len: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key1: RedisKey
key2: RedisKey
idx: "IDX"
lenToken: "MINMATCHLEN"
len: string | number
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
key1: RedisKey
key2: RedisKey
len: "LEN"
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key1: RedisKey
key2: RedisKey
len: "LEN"
lenToken: "MINMATCHLEN"
len1: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key1: RedisKey
key2: RedisKey
len: "LEN"
lenToken: "MINMATCHLEN"
len1: string | number
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
key1: RedisKey
key2: RedisKey
len: "LEN"
idx: "IDX"
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key1: RedisKey
key2: RedisKey
len: "LEN"
idx: "IDX"
lenToken: "MINMATCHLEN"
len1: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key1: RedisKey
key2: RedisKey
len: "LEN"
idx: "IDX"
lenToken: "MINMATCHLEN"
len1: string | number
withmatchlen: "WITHMATCHLEN"
Optional callback: Callback<unknown>
Returns ChainableCommander
lindex
- lindex(key: RedisKey, index: string | number, callback?: Callback<string>): ChainableCommander
- \n
Get an element from a list by its index
\n- \n
- group: list \n
- complexity: O(N) where N is the number of elements to traverse to get to the element at index. This makes asking for the first or the last element of the list O(1). \n
- since: 1.0.0 \n
Parameters
key: RedisKey
index: string | number
Optional callback: Callback<string>
Returns ChainableCommander
lindex
- lindex
Buffer(key: RedisKey, index: string | number, callback?: Callback<Buffer>): ChainableCommander
Parameters
key: RedisKey
index: string | number
Optional callback: Callback<Buffer>
Returns ChainableCommander
linsert
- linsert(key: RedisKey, before: "BEFORE", pivot: string | number | Buffer, element: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- linsert(key: RedisKey, after: "AFTER", pivot: string | number | Buffer, element: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- \n
Insert an element before or after another element in a list
\n- \n
- group: list \n
- complexity: O(N) where N is the number of elements to traverse before seeing the value pivot. This means that inserting somewhere on the left end on the list (head) can be considered O(1) and inserting somewhere on the right end (tail) is O(N). \n
- since: 2.2.0 \n
Parameters
key: RedisKey
before: "BEFORE"
pivot: string | number | Buffer
element: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
after: "AFTER"
pivot: string | number | Buffer
element: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
llen
- llen(key: RedisKey, callback?: Callback<number>): ChainableCommander
- \n
Get the length of a list
\n- \n
- group: list \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns ChainableCommander
lmove
- lmove(source: RedisKey, destination: RedisKey, left: "LEFT", left1: "LEFT", callback?: Callback<string>): ChainableCommander
- lmove(source: RedisKey, destination: RedisKey, left: "LEFT", right: "RIGHT", callback?: Callback<string>): ChainableCommander
- lmove(source: RedisKey, destination: RedisKey, right: "RIGHT", left: "LEFT", callback?: Callback<string>): ChainableCommander
- lmove(source: RedisKey, destination: RedisKey, right: "RIGHT", right1: "RIGHT", callback?: Callback<string>): ChainableCommander
- \n
Pop an element from a list, push it to another list and return it
\n- \n
- group: list \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
source: RedisKey
destination: RedisKey
right: "RIGHT"
right1: "RIGHT"
Optional callback: Callback<string>
Returns ChainableCommander
lmove
- lmove
Buffer(source: RedisKey, destination: RedisKey, left: "LEFT", left1: "LEFT", callback?: Callback<Buffer>): ChainableCommander - lmove
Buffer(source: RedisKey, destination: RedisKey, left: "LEFT", right: "RIGHT", callback?: Callback<Buffer>): ChainableCommander - lmove
Buffer(source: RedisKey, destination: RedisKey, right: "RIGHT", left: "LEFT", callback?: Callback<Buffer>): ChainableCommander - lmove
Buffer(source: RedisKey, destination: RedisKey, right: "RIGHT", right1: "RIGHT", callback?: Callback<Buffer>): ChainableCommander
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
source: RedisKey
destination: RedisKey
right: "RIGHT"
right1: "RIGHT"
Optional callback: Callback<Buffer>
Returns ChainableCommander
lmpop
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]): ChainableCommander
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]): ChainableCommander
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]): ChainableCommander
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT"]): ChainableCommander
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): ChainableCommander
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): ChainableCommander
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): ChainableCommander
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): ChainableCommander
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]): ChainableCommander
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]): ChainableCommander
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]): ChainableCommander
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT"]): ChainableCommander
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): ChainableCommander
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]): ChainableCommander
- lmpop(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): ChainableCommander
- lmpop(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): ChainableCommander
- \n
Pop elements from a list
\n- \n
- group: list \n
- complexity: O(N+M) where N is the number of provided keys and M is the number of elements returned. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: string, members: string[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: string, members: string[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: string, members: string[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns ChainableCommander
lmpop
- lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]): ChainableCommander - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]): ChainableCommander - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]): ChainableCommander - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT"]): ChainableCommander - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): ChainableCommander - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): ChainableCommander - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): ChainableCommander - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]): ChainableCommander - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]): ChainableCommander - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]): ChainableCommander - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]): ChainableCommander - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT"]): ChainableCommander - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): ChainableCommander - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]): ChainableCommander - lmpop
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): ChainableCommander - lmpop
Buffer(...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]): ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT", countToken: "COUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number, callback: Callback<[key: Buffer, members: Buffer[]]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT", countToken: "COUNT", count: string | number]
Returns ChainableCommander
lolwut
- lolwut(callback?: Callback<string>): ChainableCommander
- lolwut(versionToken: "VERSION", version: string | number, callback?: Callback<string>): ChainableCommander
- \n
Display some computer art and the Redis version
\n- \n
- group: server \n
- complexity: undefined \n
- since: 5.0.0 \n
Parameters
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
versionToken: "VERSION"
version: string | number
Optional callback: Callback<string>
Returns ChainableCommander
lpop
- lpop(key: RedisKey, callback?: Callback<string>): ChainableCommander
- lpop(key: RedisKey, count: string | number, callback?: Callback<string[]>): ChainableCommander
- \n
Remove and get the first elements in a list
\n- \n
- group: list \n
- complexity: O(N) where N is the number of elements returned \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
lpop
- lpop
Buffer(key: RedisKey, callback?: Callback<Buffer>): ChainableCommander - lpop
Buffer(key: RedisKey, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
lpos
- lpos(key: RedisKey, element: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- lpos(key: RedisKey, element: string | number | Buffer, lenToken: "MAXLEN", len: string | number, callback?: Callback<number>): ChainableCommander
- lpos(key: RedisKey, element: string | number | Buffer, numMatchesToken: "COUNT", numMatches: string | number, callback?: Callback<number[]>): ChainableCommander
- lpos(key: RedisKey, element: string | number | Buffer, numMatchesToken: "COUNT", numMatches: string | number, lenToken: "MAXLEN", len: string | number, callback?: Callback<number[]>): ChainableCommander
- lpos(key: RedisKey, element: string | number | Buffer, rankToken: "RANK", rank: string | number, callback?: Callback<number>): ChainableCommander
- lpos(key: RedisKey, element: string | number | Buffer, rankToken: "RANK", rank: string | number, lenToken: "MAXLEN", len: string | number, callback?: Callback<number>): ChainableCommander
- lpos(key: RedisKey, element: string | number | Buffer, rankToken: "RANK", rank: string | number, numMatchesToken: "COUNT", numMatches: string | number, callback?: Callback<number[]>): ChainableCommander
- lpos(key: RedisKey, element: string | number | Buffer, rankToken: "RANK", rank: string | number, numMatchesToken: "COUNT", numMatches: string | number, lenToken: "MAXLEN", len: string | number, callback?: Callback<number[]>): ChainableCommander
- \n
Return the index of matching elements on a list
\n- \n
- group: list \n
- complexity: O(N) where N is the number of elements in the list, for the average case. When searching for elements near the head or the tail of the list, or when the MAXLEN option is provided, the command may run in constant time. \n
- since: 6.0.6 \n
Parameters
key: RedisKey
element: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
element: string | number | Buffer
lenToken: "MAXLEN"
len: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
element: string | number | Buffer
numMatchesToken: "COUNT"
numMatches: string | number
Optional callback: Callback<number[]>
Returns ChainableCommander
Parameters
key: RedisKey
element: string | number | Buffer
numMatchesToken: "COUNT"
numMatches: string | number
lenToken: "MAXLEN"
len: string | number
Optional callback: Callback<number[]>
Returns ChainableCommander
Parameters
key: RedisKey
element: string | number | Buffer
rankToken: "RANK"
rank: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
element: string | number | Buffer
rankToken: "RANK"
rank: string | number
lenToken: "MAXLEN"
len: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
element: string | number | Buffer
rankToken: "RANK"
rank: string | number
numMatchesToken: "COUNT"
numMatches: string | number
Optional callback: Callback<number[]>
Returns ChainableCommander
Parameters
key: RedisKey
element: string | number | Buffer
rankToken: "RANK"
rank: string | number
numMatchesToken: "COUNT"
numMatches: string | number
lenToken: "MAXLEN"
len: string | number
Optional callback: Callback<number[]>
Returns ChainableCommander
lpush
- lpush(...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- lpush(...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]): ChainableCommander
- \n
Prepend one or multiple elements to a list
\n- \n
- group: list \n
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns ChainableCommander
lpushx
- lpushx(...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- lpushx(...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]): ChainableCommander
- \n
Prepend an element to a list, only if the list exists
\n- \n
- group: list \n
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments. \n
- since: 2.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns ChainableCommander
lrange
- lrange(key: RedisKey, start: string | number, stop: string | number, callback?: Callback<string[]>): ChainableCommander
- \n
Get a range of elements from a list
\n- \n
- group: list \n
- complexity: O(S+N) where S is the distance of start offset from HEAD for small lists, from nearest end (HEAD or TAIL) for large lists; and N is the number of elements in the specified range. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
start: string | number
stop: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
lrange
- lrange
Buffer(key: RedisKey, start: string | number, stop: string | number, callback?: Callback<Buffer[]>): ChainableCommander
Parameters
key: RedisKey
start: string | number
stop: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
lrem
- lrem(key: RedisKey, count: string | number, element: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- \n
Remove elements from a list
\n- \n
- group: list \n
- complexity: O(N+M) where N is the length of the list and M is the number of elements removed. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
count: string | number
element: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
lset
- lset(key: RedisKey, index: string | number, element: string | number | Buffer, callback?: Callback<"OK">): ChainableCommander
- \n
Set the value of an element in a list by its index
\n- \n
- group: list \n
- complexity: O(N) where N is the length of the list. Setting either the first or the last element of the list is O(1). \n
- since: 1.0.0 \n
Parameters
key: RedisKey
index: string | number
element: string | number | Buffer
Optional callback: Callback<"OK">
Returns ChainableCommander
ltrim
- ltrim(key: RedisKey, start: string | number, stop: string | number, callback?: Callback<"OK">): ChainableCommander
- \n
Trim a list to the specified range
\n- \n
- group: list \n
- complexity: O(N) where N is the number of elements to be removed by the operation. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
start: string | number
stop: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
memory
- memory(subcommand: "DOCTOR", callback?: Callback<string>): ChainableCommander
- memory(subcommand: "HELP", callback?: Callback<unknown[]>): ChainableCommander
- memory(subcommand: "MALLOC-STATS", callback?: Callback<string>): ChainableCommander
- memory(subcommand: "PURGE", callback?: Callback<"OK">): ChainableCommander
- memory(subcommand: "STATS", callback?: Callback<unknown[]>): ChainableCommander
- memory(subcommand: "USAGE", key: RedisKey, callback?: Callback<number>): ChainableCommander
- memory(subcommand: "USAGE", key: RedisKey, countToken: "SAMPLES", count: string | number, callback?: Callback<number>): ChainableCommander
- \n
Outputs memory problems report
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 4.0.0 \n
Parameters
subcommand: "DOCTOR"
Optional callback: Callback<string>
Returns ChainableCommander
- \n
Show helpful text about the different subcommands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 4.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
- \n
Show allocator internal stats
\n- \n
- group: server \n
- complexity: Depends on how much memory is allocated, could be slow \n
- since: 4.0.0 \n
Parameters
subcommand: "MALLOC-STATS"
Optional callback: Callback<string>
Returns ChainableCommander
- \n
Ask the allocator to release memory
\n- \n
- group: server \n
- complexity: Depends on how much memory is allocated, could be slow \n
- since: 4.0.0 \n
Parameters
subcommand: "PURGE"
Optional callback: Callback<"OK">
Returns ChainableCommander
- \n
Show memory usage details
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 4.0.0 \n
Parameters
subcommand: "STATS"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
- \n
Estimate the memory usage of a key
\n- \n
- group: server \n
- complexity: O(N) where N is the number of samples. \n
- since: 4.0.0 \n
Parameters
subcommand: "USAGE"
key: RedisKey
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
subcommand: "USAGE"
key: RedisKey
countToken: "SAMPLES"
count: string | number
Optional callback: Callback<number>
Returns ChainableCommander
mget
- mget(...args: [...keys: RedisKey[], callback: Callback<string[]>]): ChainableCommander
- mget(...args: [keys: RedisKey[], callback: Callback<string[]>]): ChainableCommander
- mget(...args: RedisKey[]): ChainableCommander
- mget(...args: [keys: RedisKey[]]): ChainableCommander
- \n
Get the values of all the given keys
\n- \n
- group: string \n
- complexity: O(N) where N is the number of keys to retrieve. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: RedisKey[]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[]]
Returns ChainableCommander
mget
- mget
Buffer(...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]): ChainableCommander - mget
Buffer(...args: [keys: RedisKey[], callback: Callback<Buffer[]>]): ChainableCommander - mget
Buffer(...args: RedisKey[]): ChainableCommander - mget
Buffer(...args: [keys: RedisKey[]]): ChainableCommander
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: RedisKey[]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[]]
Returns ChainableCommander
migrate
- migrate(...args: [host: string | Buffer, port: string | number, ...args: RedisValue[], callback: Callback<"OK">]): ChainableCommander
- migrate(...args: [host: string | Buffer, port: string | number, ...args: RedisValue[]]): ChainableCommander
- \n
Atomically transfer a key from a Redis instance to another one.
\n- \n
- group: generic \n
- complexity: This command actually executes a DUMP+DEL in the source instance, and a RESTORE in the target instance. See the pages of these commands for time complexity. Also an O(N) data transfer between the two instances is performed. \n
- since: 2.6.0 \n
Parameters
Rest ...args: [host: string | Buffer, port: string | number, ...args: RedisValue[], callback: Callback<"OK">]
Returns ChainableCommander
Parameters
Rest ...args: [host: string | Buffer, port: string | number, ...args: RedisValue[]]
Returns ChainableCommander
module
- module(subcommand: "HELP", callback?: Callback<unknown>): ChainableCommander
- module(subcommand: "LIST", callback?: Callback<unknown>): ChainableCommander
- module(subcommand: "LOAD", path: string | Buffer, callback?: Callback<unknown>): ChainableCommander
- module(...args: [subcommand: "LOAD", path: string | Buffer, ...args: (string | number | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- module(...args: [subcommand: "LOAD", path: string | Buffer, ...args: (string | number | Buffer)[]]): ChainableCommander
- module(subcommand: "LOADEX", path: string | Buffer, callback?: Callback<unknown>): ChainableCommander
- module(...args: [subcommand: "LOADEX", path: string | Buffer, argsToken: "ARGS", ...args: (string | number | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- module(...args: [subcommand: "LOADEX", path: string | Buffer, argsToken: "ARGS", ...args: (string | number | Buffer)[]]): ChainableCommander
- module(...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...configs: (string | number | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- module(...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...configs: (string | number | Buffer)[]]): ChainableCommander
- module(...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...args: RedisValue[], callback: Callback<unknown>]): ChainableCommander
- module(...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...args: RedisValue[]]): ChainableCommander
- module(subcommand: "UNLOAD", name: string | Buffer, callback?: Callback<unknown>): ChainableCommander
- \n
Show helpful text about the different subcommands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
List all modules loaded by the server
\n- \n
- group: server \n
- complexity: O(N) where N is the number of loaded modules. \n
- since: 4.0.0 \n
Parameters
subcommand: "LIST"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Load a module
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 4.0.0 \n
Parameters
subcommand: "LOAD"
path: string | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "LOAD", path: string | Buffer, ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "LOAD", path: string | Buffer, ...args: (string | number | Buffer)[]]
Returns ChainableCommander
- \n
Load a module with extended parameters
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
subcommand: "LOADEX"
path: string | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "LOADEX", path: string | Buffer, argsToken: "ARGS", ...args: (string | number | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "LOADEX", path: string | Buffer, argsToken: "ARGS", ...args: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...configs: (string | number | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...configs: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...args: RedisValue[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "LOADEX", path: string | Buffer, configsToken: "CONFIG", ...args: RedisValue[]]
Returns ChainableCommander
- \n
Unload a module
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 4.0.0 \n
Parameters
subcommand: "UNLOAD"
name: string | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
move
- move(key: RedisKey, db: string | number, callback?: Callback<number>): ChainableCommander
- \n
Move a key to another database
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
db: string | number
Optional callback: Callback<number>
Returns ChainableCommander
mset
- mset(object: object, callback?: Callback<"OK">): ChainableCommander
- mset(map: Map<string | number | Buffer, string | number | Buffer>, callback?: Callback<"OK">): ChainableCommander
- mset(...args: [...keyValues: (number | RedisKey)[], callback: Callback<"OK">]): ChainableCommander
- mset(...args: (number | RedisKey)[]): ChainableCommander
- \n
Set multiple keys to multiple values
\n- \n
- group: string \n
- complexity: O(N) where N is the number of keys to set. \n
- since: 1.0.1 \n
Parameters
object: object
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
map: Map<string | number | Buffer, string | number | Buffer>
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
Rest ...args: [...keyValues: (number | RedisKey)[], callback: Callback<"OK">]
Returns ChainableCommander
Parameters
Rest ...args: (number | RedisKey)[]
Returns ChainableCommander
msetnx
- msetnx(object: object, callback?: Callback<"OK">): ChainableCommander
- msetnx(map: Map<string | number | Buffer, string | number | Buffer>, callback?: Callback<"OK">): ChainableCommander
- msetnx(...args: [...keyValues: (number | RedisKey)[], callback: Callback<number>]): ChainableCommander
- msetnx(...args: (number | RedisKey)[]): ChainableCommander
- \n
Set multiple keys to multiple values, only if none of the keys exist
\n- \n
- group: string \n
- complexity: O(N) where N is the number of keys to set. \n
- since: 1.0.1 \n
Parameters
object: object
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
map: Map<string | number | Buffer, string | number | Buffer>
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
Rest ...args: [...keyValues: (number | RedisKey)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: (number | RedisKey)[]
Returns ChainableCommander
object
- object(subcommand: "ENCODING", key: RedisKey, callback?: Callback<unknown>): ChainableCommander
- object(subcommand: "FREQ", key: RedisKey, callback?: Callback<unknown>): ChainableCommander
- object(subcommand: "HELP", callback?: Callback<unknown>): ChainableCommander
- object(subcommand: "IDLETIME", key: RedisKey, callback?: Callback<unknown>): ChainableCommander
- object(subcommand: "REFCOUNT", key: RedisKey, callback?: Callback<unknown>): ChainableCommander
- \n
Inspect the internal encoding of a Redis object
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.2.3 \n
Parameters
subcommand: "ENCODING"
key: RedisKey
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Get the logarithmic access frequency counter of a Redis object
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 4.0.0 \n
Parameters
subcommand: "FREQ"
key: RedisKey
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Show helpful text about the different subcommands
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Get the time since a Redis object was last accessed
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.2.3 \n
Parameters
subcommand: "IDLETIME"
key: RedisKey
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Get the number of references to the value of the key
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.2.3 \n
Parameters
subcommand: "REFCOUNT"
key: RedisKey
Optional callback: Callback<unknown>
Returns ChainableCommander
persist
- persist(key: RedisKey, callback?: Callback<number>): ChainableCommander
- \n
Remove the expiration from a key
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns ChainableCommander
pexpire
- pexpire(key: RedisKey, milliseconds: string | number, callback?: Callback<number>): ChainableCommander
- pexpire(key: RedisKey, milliseconds: string | number, nx: "NX", callback?: Callback<number>): ChainableCommander
- pexpire(key: RedisKey, milliseconds: string | number, xx: "XX", callback?: Callback<number>): ChainableCommander
- pexpire(key: RedisKey, milliseconds: string | number, gt: "GT", callback?: Callback<number>): ChainableCommander
- pexpire(key: RedisKey, milliseconds: string | number, lt: "LT", callback?: Callback<number>): ChainableCommander
- \n
Set a key's time to live in milliseconds
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
milliseconds: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
milliseconds: string | number
nx: "NX"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
milliseconds: string | number
xx: "XX"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
milliseconds: string | number
gt: "GT"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
milliseconds: string | number
lt: "LT"
Optional callback: Callback<number>
Returns ChainableCommander
pexpireat
- pexpireat(key: RedisKey, unixTimeMilliseconds: string | number, callback?: Callback<number>): ChainableCommander
- pexpireat(key: RedisKey, unixTimeMilliseconds: string | number, nx: "NX", callback?: Callback<number>): ChainableCommander
- pexpireat(key: RedisKey, unixTimeMilliseconds: string | number, xx: "XX", callback?: Callback<number>): ChainableCommander
- pexpireat(key: RedisKey, unixTimeMilliseconds: string | number, gt: "GT", callback?: Callback<number>): ChainableCommander
- pexpireat(key: RedisKey, unixTimeMilliseconds: string | number, lt: "LT", callback?: Callback<number>): ChainableCommander
- \n
Set the expiration for a key as a UNIX timestamp specified in milliseconds
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
unixTimeMilliseconds: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
unixTimeMilliseconds: string | number
nx: "NX"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
unixTimeMilliseconds: string | number
xx: "XX"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
unixTimeMilliseconds: string | number
gt: "GT"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
unixTimeMilliseconds: string | number
lt: "LT"
Optional callback: Callback<number>
Returns ChainableCommander
pexpiretime
- pexpiretime(key: RedisKey, callback?: Callback<number>): ChainableCommander
- \n
Get the expiration Unix timestamp for a key in milliseconds
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 7.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns ChainableCommander
pfadd
- pfadd(key: RedisKey, callback?: Callback<number>): ChainableCommander
- pfadd(...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- pfadd(...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]): ChainableCommander
- \n
Adds the specified elements to the specified HyperLogLog.
\n- \n
- group: hyperloglog \n
- complexity: O(1) to add every element. \n
- since: 2.8.9 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns ChainableCommander
pfcount
- pfcount(...args: [...keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- pfcount(...args: [keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- pfcount(...args: RedisKey[]): ChainableCommander
- pfcount(...args: [keys: RedisKey[]]): ChainableCommander
- \n
Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s).
\n- \n
- group: hyperloglog \n
- complexity: O(1) with a very small average constant time when called with a single key. O(N) with N being the number of keys, and much bigger constant times, when called with multiple keys. \n
- since: 2.8.9 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: RedisKey[]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[]]
Returns ChainableCommander
pfdebug
- pfdebug(subcommand: string | Buffer, key: RedisKey, callback?: Callback<unknown>): ChainableCommander
- \n
Internal commands for debugging HyperLogLog values
\n- \n
- group: hyperloglog \n
- complexity: N/A \n
- since: 2.8.9 \n
Parameters
subcommand: string | Buffer
key: RedisKey
Optional callback: Callback<unknown>
Returns ChainableCommander
pfmerge
- pfmerge(...args: [destkey: RedisKey, ...sourcekeys: RedisKey[], callback: Callback<"OK">]): ChainableCommander
- pfmerge(...args: [destkey: RedisKey, sourcekeys: RedisKey[], callback: Callback<"OK">]): ChainableCommander
- pfmerge(...args: [destkey: RedisKey, ...sourcekeys: RedisKey[]]): ChainableCommander
- pfmerge(...args: [destkey: RedisKey, sourcekeys: RedisKey[]]): ChainableCommander
- \n
Merge N different HyperLogLogs into a single one.
\n- \n
- group: hyperloglog \n
- complexity: O(N) to merge N HyperLogLogs, but with high constant times. \n
- since: 2.8.9 \n
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
pfselftest
- pfselftest(callback?: Callback<unknown>): ChainableCommander
- \n
An internal command for testing HyperLogLog values
\n- \n
- group: hyperloglog \n
- complexity: N/A \n
- since: 2.8.9 \n
Parameters
Optional callback: Callback<unknown>
Returns ChainableCommander
ping
- ping(callback?: Callback<"PONG">): ChainableCommander
- ping(message: string | Buffer, callback?: Callback<string>): ChainableCommander
- \n
Ping the server
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"PONG">
Returns ChainableCommander
Parameters
message: string | Buffer
Optional callback: Callback<string>
Returns ChainableCommander
ping
- ping
Buffer(message: string | Buffer, callback?: Callback<Buffer>): ChainableCommander
Parameters
message: string | Buffer
Optional callback: Callback<Buffer>
Returns ChainableCommander
psetex
- psetex(key: RedisKey, milliseconds: string | number, value: string | number | Buffer, callback?: Callback<unknown>): ChainableCommander
- \n
Set the value and expiration in milliseconds of a key
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
milliseconds: string | number
value: string | number | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
psubscribe
- psubscribe(...args: [...patterns: string[], callback: Callback<unknown>]): ChainableCommander
- psubscribe(...args: string[]): ChainableCommander
- \n
Listen for messages published to channels matching the given patterns
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of patterns the client is already subscribed to. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [...patterns: string[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: string[]
Returns ChainableCommander
psync
- psync(replicationid: string | number | Buffer, offset: string | number, callback?: Callback<unknown>): ChainableCommander
- \n
Internal command used for replication
\n- \n
- group: server \n
- complexity: undefined \n
- since: 2.8.0 \n
Parameters
replicationid: string | number | Buffer
offset: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
pttl
- pttl(key: RedisKey, callback?: Callback<number>): ChainableCommander
- \n
Get the time to live for a key in milliseconds
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns ChainableCommander
publish
- publish(channel: string | Buffer, message: string | Buffer, callback?: Callback<number>): ChainableCommander
- \n
Post a message to a channel
\n- \n
- group: pubsub \n
- complexity: O(N+M) where N is the number of clients subscribed to the receiving channel and M is the total number of subscribed patterns (by any client). \n
- since: 2.0.0 \n
Parameters
channel: string | Buffer
message: string | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
pubsub
- pubsub(subcommand: "CHANNELS", callback?: Callback<unknown[]>): ChainableCommander
- pubsub(subcommand: "CHANNELS", pattern: string, callback?: Callback<unknown[]>): ChainableCommander
- pubsub(subcommand: "HELP", callback?: Callback<unknown[]>): ChainableCommander
- pubsub(subcommand: "NUMPAT", callback?: Callback<unknown[]>): ChainableCommander
- pubsub(subcommand: "NUMSUB", callback?: Callback<unknown[]>): ChainableCommander
- pubsub(...args: [subcommand: "NUMSUB", ...channels: (string | Buffer)[], callback: Callback<unknown[]>]): ChainableCommander
- pubsub(...args: [subcommand: "NUMSUB", ...channels: (string | Buffer)[]]): ChainableCommander
- pubsub(subcommand: "SHARDCHANNELS", callback?: Callback<unknown[]>): ChainableCommander
- pubsub(subcommand: "SHARDCHANNELS", pattern: string, callback?: Callback<unknown[]>): ChainableCommander
- pubsub(subcommand: "SHARDNUMSUB", callback?: Callback<unknown[]>): ChainableCommander
- pubsub(...args: [subcommand: "SHARDNUMSUB", ...shardchannels: (string | Buffer)[], callback: Callback<unknown[]>]): ChainableCommander
- pubsub(...args: [subcommand: "SHARDNUMSUB", ...shardchannels: (string | Buffer)[]]): ChainableCommander
- \n
List active channels
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of active channels, and assuming constant time pattern matching (relatively short channels and patterns) \n
- since: 2.8.0 \n
Parameters
subcommand: "CHANNELS"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
subcommand: "CHANNELS"
pattern: string
Optional callback: Callback<unknown[]>
Returns ChainableCommander
- \n
Show helpful text about the different subcommands
\n- \n
- group: pubsub \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
- \n
Get the count of unique patterns pattern subscriptions
\n- \n
- group: pubsub \n
- complexity: O(1) \n
- since: 2.8.0 \n
Parameters
subcommand: "NUMPAT"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
- \n
Get the count of subscribers for channels
\n- \n
- group: pubsub \n
- complexity: O(N) for the NUMSUB subcommand, where N is the number of requested channels \n
- since: 2.8.0 \n
Parameters
subcommand: "NUMSUB"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "NUMSUB", ...channels: (string | Buffer)[], callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "NUMSUB", ...channels: (string | Buffer)[]]
Returns ChainableCommander
- \n
List active shard channels
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of active shard channels, and assuming constant time pattern matching (relatively short shard channels). \n
- since: 7.0.0 \n
Parameters
subcommand: "SHARDCHANNELS"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
subcommand: "SHARDCHANNELS"
pattern: string
Optional callback: Callback<unknown[]>
Returns ChainableCommander
- \n
Get the count of subscribers for shard channels
\n- \n
- group: pubsub \n
- complexity: O(N) for the SHARDNUMSUB subcommand, where N is the number of requested shard channels \n
- since: 7.0.0 \n
Parameters
subcommand: "SHARDNUMSUB"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "SHARDNUMSUB", ...shardchannels: (string | Buffer)[], callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "SHARDNUMSUB", ...shardchannels: (string | Buffer)[]]
Returns ChainableCommander
punsubscribe
- punsubscribe(callback?: Callback<unknown>): ChainableCommander
- punsubscribe(...args: [...patterns: string[], callback: Callback<unknown>]): ChainableCommander
- punsubscribe(...args: string[]): ChainableCommander
- \n
Stop listening for messages posted to channels matching the given patterns
\n- \n
- group: pubsub \n
- complexity: O(N+M) where N is the number of patterns the client is already subscribed and M is the number of total patterns subscribed in the system (by any client). \n
- since: 2.0.0 \n
Parameters
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [...patterns: string[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: string[]
Returns ChainableCommander
quit
- quit(callback?: Callback<"OK">): ChainableCommander
- \n
Close the connection
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns ChainableCommander
randomkey
- randomkey(callback?: Callback<string>): ChainableCommander
- \n
Return a random key from the keyspace
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<string>
Returns ChainableCommander
randomkey
- randomkey
Buffer(callback?: Callback<Buffer>): ChainableCommander
Parameters
Optional callback: Callback<Buffer>
Returns ChainableCommander
readonly
- readonly(callback?: Callback<"OK">): ChainableCommander
- \n
Enables read queries for a connection to a cluster replica node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns ChainableCommander
readwrite
- readwrite(callback?: Callback<"OK">): ChainableCommander
- \n
Disables read queries for a connection to a cluster replica node
\n- \n
- group: cluster \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns ChainableCommander
rename
- rename(key: RedisKey, newkey: RedisKey, callback?: Callback<"OK">): ChainableCommander
- \n
Rename a key
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Returns ChainableCommander
renamenx
- renamenx(key: RedisKey, newkey: RedisKey, callback?: Callback<number>): ChainableCommander
- \n
Rename a key, only if the new key does not exist
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
Returns ChainableCommander
replconf
- replconf(callback?: Callback<unknown>): ChainableCommander
- \n
An internal command for configuring the replication stream
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
Optional callback: Callback<unknown>
Returns ChainableCommander
replicaof
- replicaof(host: string | Buffer, port: string | number, callback?: Callback<"OK">): ChainableCommander
- \n
Make the server a replica of another instance, or promote it as master.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
host: string | Buffer
port: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
reset
- reset(callback?: Callback<"OK">): ChainableCommander
- \n
Reset the connection
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
Optional callback: Callback<"OK">
Returns ChainableCommander
restore
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, callback?: Callback<"OK">): ChainableCommander
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): ChainableCommander
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<"OK">): ChainableCommander
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): ChainableCommander
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", callback?: Callback<"OK">): ChainableCommander
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): ChainableCommander
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<"OK">): ChainableCommander
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): ChainableCommander
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", callback?: Callback<"OK">): ChainableCommander
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): ChainableCommander
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<"OK">): ChainableCommander
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): ChainableCommander
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", callback?: Callback<"OK">): ChainableCommander
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): ChainableCommander
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<"OK">): ChainableCommander
- restore(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<"OK">): ChainableCommander
- \n
Create a key using the provided serialized value, previously obtained using DUMP.
\n- \n
- group: generic \n
- complexity: O(1) to create the new key and additional O(NM) to reconstruct the serialized value, where N is the number of Redis objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1M) where M is small, so simply O(1). However for sorted set values the complexity is O(NMlog(N)) because inserting values into sorted sets is O(log(N)). \n
- since: 2.6.0 \n
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
restore-
- restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, callback?: Callback<unknown>): ChainableCommander - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): ChainableCommander - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<unknown>): ChainableCommander - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): ChainableCommander - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", callback?: Callback<unknown>): ChainableCommander - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): ChainableCommander - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<unknown>): ChainableCommander - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): ChainableCommander - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", callback?: Callback<unknown>): ChainableCommander - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): ChainableCommander - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<unknown>): ChainableCommander - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): ChainableCommander - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", callback?: Callback<unknown>): ChainableCommander - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): ChainableCommander - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, callback?: Callback<unknown>): ChainableCommander - restore-
asking(key: RedisKey, ttl: string | number, serializedValue: string | number | Buffer, replace: "REPLACE", absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: string | number, frequencyToken: "FREQ", frequency: string | number, callback?: Callback<unknown>): ChainableCommander
- \n
An internal command for migrating keys in a cluster
\n- \n
- group: server \n
- complexity: O(1) to create the new key and additional O(NM) to reconstruct the serialized value, where N is the number of Redis objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1M) where M is small, so simply O(1). However for sorted set values the complexity is O(NMlog(N)) because inserting values into sorted sets is O(log(N)). \n
- since: 3.0.0 \n
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
ttl: string | number
serializedValue: string | number | Buffer
replace: "REPLACE"
absttl: "ABSTTL"
secondsToken: "IDLETIME"
seconds: string | number
frequencyToken: "FREQ"
frequency: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
role
- role(callback?: Callback<unknown[]>): ChainableCommander
- \n
Return the role of the instance in the context of replication
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.8.12 \n
Parameters
Optional callback: Callback<unknown[]>
Returns ChainableCommander
rpop
- rpop(key: RedisKey, callback?: Callback<string>): ChainableCommander
- rpop(key: RedisKey, count: string | number, callback?: Callback<string[]>): ChainableCommander
- \n
Remove and get the last elements in a list
\n- \n
- group: list \n
- complexity: O(N) where N is the number of elements returned \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
rpop
- rpop
Buffer(key: RedisKey, callback?: Callback<Buffer>): ChainableCommander - rpop
Buffer(key: RedisKey, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
rpoplpush
- rpoplpush(source: RedisKey, destination: RedisKey, callback?: Callback<string>): ChainableCommander
- \n
Remove the last element in a list, prepend it to another list and return it
\n- \n
- group: list \n
- complexity: O(1) \n
- since: 1.2.0 \n
Parameters
Returns ChainableCommander
rpoplpush
- rpoplpush
Buffer(source: RedisKey, destination: RedisKey, callback?: Callback<Buffer>): ChainableCommander
Parameters
Returns ChainableCommander
rpush
- rpush(...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- rpush(...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]): ChainableCommander
- \n
Append one or multiple elements to a list
\n- \n
- group: list \n
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns ChainableCommander
rpushx
- rpushx(...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- rpushx(...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]): ChainableCommander
- \n
Append an element to a list, only if the list exists
\n- \n
- group: list \n
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments. \n
- since: 2.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns ChainableCommander
sadd
- sadd(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- sadd(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- sadd(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): ChainableCommander
- sadd(...args: [key: RedisKey, members: (string | number | Buffer)[]]): ChainableCommander
- \n
Add one or more members to a set
\n- \n
- group: set \n
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns ChainableCommander
save
- save(callback?: Callback<"OK">): ChainableCommander
- \n
Synchronously save the dataset to disk
\n- \n
- group: server \n
- complexity: O(N) where N is the total number of keys in all databases \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns ChainableCommander
scan
- scan(cursor: string | number, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- scan(cursor: string | number, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- scan(cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- scan(cursor: string | number, countToken: "COUNT", count: string | number, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- scan(cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- scan(cursor: string | number, patternToken: "MATCH", pattern: string, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- scan(cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- scan(cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- \n
Incrementally iterate the keys space
\n- \n
- group: generic \n
- complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection. \n
- since: 2.8.0 \n
Parameters
cursor: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
Parameters
cursor: string | number
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
Parameters
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
Parameters
cursor: string | number
countToken: "COUNT"
count: string | number
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
scan
- scan
Buffer(cursor: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander - scan
Buffer(cursor: string | number, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander - scan
Buffer(cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander - scan
Buffer(cursor: string | number, countToken: "COUNT", count: string | number, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander - scan
Buffer(cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander - scan
Buffer(cursor: string | number, patternToken: "MATCH", pattern: string, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander - scan
Buffer(cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander - scan
Buffer(cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander
Parameters
cursor: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
Parameters
cursor: string | number
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
Parameters
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
Parameters
cursor: string | number
countToken: "COUNT"
count: string | number
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
Parameters
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
typeToken: "TYPE"
type: string | Buffer
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
scard
- scard(key: RedisKey, callback?: Callback<number>): ChainableCommander
- \n
Get the number of members in a set
\n- \n
- group: set \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns ChainableCommander
script
- script(subcommand: "DEBUG", yes: "YES", callback?: Callback<unknown>): ChainableCommander
- script(subcommand: "DEBUG", sync: "SYNC", callback?: Callback<unknown>): ChainableCommander
- script(subcommand: "DEBUG", no: "NO", callback?: Callback<unknown>): ChainableCommander
- script(...args: [subcommand: "EXISTS", ...sha1s: (string | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- script(...args: [subcommand: "EXISTS", ...sha1s: (string | Buffer)[]]): ChainableCommander
- script(subcommand: "FLUSH", callback?: Callback<unknown>): ChainableCommander
- script(subcommand: "FLUSH", async: "ASYNC", callback?: Callback<unknown>): ChainableCommander
- script(subcommand: "FLUSH", sync: "SYNC", callback?: Callback<unknown>): ChainableCommander
- script(subcommand: "HELP", callback?: Callback<unknown>): ChainableCommander
- script(subcommand: "KILL", callback?: Callback<unknown>): ChainableCommander
- script(subcommand: "LOAD", script: string | Buffer, callback?: Callback<unknown>): ChainableCommander
- \n
Set the debug mode for executed scripts.
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 3.2.0 \n
Parameters
subcommand: "DEBUG"
yes: "YES"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "DEBUG"
sync: "SYNC"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "DEBUG"
no: "NO"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Check existence of scripts in the script cache.
\n- \n
- group: scripting \n
- complexity: O(N) with N being the number of scripts to check (so checking a single script is an O(1) operation). \n
- since: 2.6.0 \n
Parameters
Rest ...args: [subcommand: "EXISTS", ...sha1s: (string | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [subcommand: "EXISTS", ...sha1s: (string | Buffer)[]]
Returns ChainableCommander
- \n
Remove all the scripts from the script cache.
\n- \n
- group: scripting \n
- complexity: O(N) with N being the number of scripts in cache \n
- since: 2.6.0 \n
Parameters
subcommand: "FLUSH"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "FLUSH"
async: "ASYNC"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "FLUSH"
sync: "SYNC"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Show helpful text about the different subcommands
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Kill the script currently in execution.
\n- \n
- group: scripting \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
subcommand: "KILL"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Load the specified Lua script into the script cache.
\n- \n
- group: scripting \n
- complexity: O(N) with N being the length in bytes of the script body. \n
- since: 2.6.0 \n
Parameters
subcommand: "LOAD"
script: string | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
sdiff
- sdiff(...args: [...keys: RedisKey[], callback: Callback<string[]>]): ChainableCommander
- sdiff(...args: [keys: RedisKey[], callback: Callback<string[]>]): ChainableCommander
- sdiff(...args: RedisKey[]): ChainableCommander
- sdiff(...args: [keys: RedisKey[]]): ChainableCommander
- \n
Subtract multiple sets
\n- \n
- group: set \n
- complexity: O(N) where N is the total number of elements in all given sets. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: RedisKey[]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[]]
Returns ChainableCommander
sdiff
- sdiff
Buffer(...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]): ChainableCommander - sdiff
Buffer(...args: [keys: RedisKey[], callback: Callback<Buffer[]>]): ChainableCommander - sdiff
Buffer(...args: RedisKey[]): ChainableCommander - sdiff
Buffer(...args: [keys: RedisKey[]]): ChainableCommander
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: RedisKey[]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[]]
Returns ChainableCommander
sdiffstore
- sdiffstore(...args: [destination: RedisKey, ...keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- sdiffstore(...args: [destination: RedisKey, keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- sdiffstore(...args: [destination: RedisKey, ...keys: RedisKey[]]): ChainableCommander
- sdiffstore(...args: [destination: RedisKey, keys: RedisKey[]]): ChainableCommander
- \n
Subtract multiple sets and store the resulting set in a key
\n- \n
- group: set \n
- complexity: O(N) where N is the total number of elements in all given sets. \n
- since: 1.0.0 \n
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
select
- select(index: string | number, callback?: Callback<"OK">): ChainableCommander
- \n
Change the selected database for the current connection
\n- \n
- group: connection \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
index: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
set
- set(key: RedisKey, value: string | number | Buffer, callback?: Callback<"OK">): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, get: "GET", callback?: Callback<string>): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, nx: "NX", callback?: Callback<"OK">): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, nx: "NX", get: "GET", callback?: Callback<string>): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, xx: "XX", callback?: Callback<"OK">): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, xx: "XX", get: "GET", callback?: Callback<string>): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, callback?: Callback<"OK">): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, get: "GET", callback?: Callback<string>): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, nx: "NX", callback?: Callback<"OK">): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, nx: "NX", get: "GET", callback?: Callback<string>): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, xx: "XX", callback?: Callback<"OK">): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, xx: "XX", get: "GET", callback?: Callback<string>): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, callback?: Callback<"OK">): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, get: "GET", callback?: Callback<string>): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, nx: "NX", callback?: Callback<"OK">): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, nx: "NX", get: "GET", callback?: Callback<string>): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, xx: "XX", callback?: Callback<"OK">): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, xx: "XX", get: "GET", callback?: Callback<string>): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, callback?: Callback<"OK">): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, get: "GET", callback?: Callback<string>): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, nx: "NX", callback?: Callback<"OK">): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, nx: "NX", get: "GET", callback?: Callback<string>): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, xx: "XX", callback?: Callback<"OK">): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, xx: "XX", get: "GET", callback?: Callback<string>): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, callback?: Callback<"OK">): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, get: "GET", callback?: Callback<string>): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, nx: "NX", callback?: Callback<"OK">): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, nx: "NX", get: "GET", callback?: Callback<string>): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, xx: "XX", callback?: Callback<"OK">): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, xx: "XX", get: "GET", callback?: Callback<string>): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", callback?: Callback<"OK">): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", get: "GET", callback?: Callback<string>): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", nx: "NX", callback?: Callback<"OK">): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", nx: "NX", get: "GET", callback?: Callback<string>): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", xx: "XX", callback?: Callback<"OK">): ChainableCommander
- set(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", xx: "XX", get: "GET", callback?: Callback<string>): ChainableCommander
- \n
Set the string value of a key
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
value: string | number | Buffer
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
get: "GET"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
nx: "NX"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
nx: "NX"
get: "GET"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
xx: "XX"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
xx: "XX"
get: "GET"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
get: "GET"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
nx: "NX"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
xx: "XX"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
get: "GET"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
nx: "NX"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
xx: "XX"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
get: "GET"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
nx: "NX"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
xx: "XX"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
get: "GET"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
nx: "NX"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
xx: "XX"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
get: "GET"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
nx: "NX"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
nx: "NX"
get: "GET"
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
xx: "XX"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
xx: "XX"
get: "GET"
Optional callback: Callback<string>
Returns ChainableCommander
set
- set
Buffer(key: RedisKey, value: string | number | Buffer, get: "GET", callback?: Callback<Buffer>): ChainableCommander - set
Buffer(key: RedisKey, value: string | number | Buffer, nx: "NX", get: "GET", callback?: Callback<Buffer>): ChainableCommander - set
Buffer(key: RedisKey, value: string | number | Buffer, xx: "XX", get: "GET", callback?: Callback<Buffer>): ChainableCommander - set
Buffer(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, get: "GET", callback?: Callback<Buffer>): ChainableCommander - set
Buffer(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, nx: "NX", get: "GET", callback?: Callback<Buffer>): ChainableCommander - set
Buffer(key: RedisKey, value: string | number | Buffer, secondsToken: "EX", seconds: string | number, xx: "XX", get: "GET", callback?: Callback<Buffer>): ChainableCommander - set
Buffer(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, get: "GET", callback?: Callback<Buffer>): ChainableCommander - set
Buffer(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, nx: "NX", get: "GET", callback?: Callback<Buffer>): ChainableCommander - set
Buffer(key: RedisKey, value: string | number | Buffer, millisecondsToken: "PX", milliseconds: string | number, xx: "XX", get: "GET", callback?: Callback<Buffer>): ChainableCommander - set
Buffer(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, get: "GET", callback?: Callback<Buffer>): ChainableCommander - set
Buffer(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, nx: "NX", get: "GET", callback?: Callback<Buffer>): ChainableCommander - set
Buffer(key: RedisKey, value: string | number | Buffer, unixTimeSecondsToken: "EXAT", unixTimeSeconds: string | number, xx: "XX", get: "GET", callback?: Callback<Buffer>): ChainableCommander - set
Buffer(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, get: "GET", callback?: Callback<Buffer>): ChainableCommander - set
Buffer(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, nx: "NX", get: "GET", callback?: Callback<Buffer>): ChainableCommander - set
Buffer(key: RedisKey, value: string | number | Buffer, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: string | number, xx: "XX", get: "GET", callback?: Callback<Buffer>): ChainableCommander - set
Buffer(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", get: "GET", callback?: Callback<Buffer>): ChainableCommander - set
Buffer(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", nx: "NX", get: "GET", callback?: Callback<Buffer>): ChainableCommander - set
Buffer(key: RedisKey, value: string | number | Buffer, keepttl: "KEEPTTL", xx: "XX", get: "GET", callback?: Callback<Buffer>): ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
get: "GET"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
nx: "NX"
get: "GET"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
xx: "XX"
get: "GET"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
get: "GET"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
secondsToken: "EX"
seconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
get: "GET"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
millisecondsToken: "PX"
milliseconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
get: "GET"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeSecondsToken: "EXAT"
unixTimeSeconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
get: "GET"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
nx: "NX"
get: "GET"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
unixTimeMillisecondsToken: "PXAT"
unixTimeMilliseconds: string | number
xx: "XX"
get: "GET"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
get: "GET"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
nx: "NX"
get: "GET"
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
value: string | number | Buffer
keepttl: "KEEPTTL"
xx: "XX"
get: "GET"
Optional callback: Callback<Buffer>
Returns ChainableCommander
setbit
- setbit(key: RedisKey, offset: string | number, value: string | number, callback?: Callback<number>): ChainableCommander
- \n
Sets or clears the bit at offset in the string value stored at key
\n- \n
- group: bitmap \n
- complexity: O(1) \n
- since: 2.2.0 \n
Parameters
key: RedisKey
offset: string | number
value: string | number
Optional callback: Callback<number>
Returns ChainableCommander
setex
- setex(key: RedisKey, seconds: string | number, value: string | number | Buffer, callback?: Callback<"OK">): ChainableCommander
- \n
Set the value and expiration of a key
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
seconds: string | number
value: string | number | Buffer
Optional callback: Callback<"OK">
Returns ChainableCommander
setnx
- setnx(key: RedisKey, value: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- \n
Set the value of a key, only if the key does not exist
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
value: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
setrange
- setrange(key: RedisKey, offset: string | number, value: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- \n
Overwrite part of a string at key starting at the specified offset
\n- \n
- group: string \n
- complexity: O(1), not counting the time taken to copy the new string in place. Usually, this string is very small so the amortized complexity is O(1). Otherwise, complexity is O(M) with M being the length of the value argument. \n
- since: 2.2.0 \n
Parameters
key: RedisKey
offset: string | number
value: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
shutdown
- shutdown(callback?: Callback<"OK">): ChainableCommander
- shutdown(abort: "ABORT", callback?: Callback<"OK">): ChainableCommander
- shutdown(force: "FORCE", callback?: Callback<"OK">): ChainableCommander
- shutdown(force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): ChainableCommander
- shutdown(now: "NOW", callback?: Callback<"OK">): ChainableCommander
- shutdown(now: "NOW", abort: "ABORT", callback?: Callback<"OK">): ChainableCommander
- shutdown(now: "NOW", force: "FORCE", callback?: Callback<"OK">): ChainableCommander
- shutdown(now: "NOW", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): ChainableCommander
- shutdown(nosave: "NOSAVE", callback?: Callback<"OK">): ChainableCommander
- shutdown(nosave: "NOSAVE", abort: "ABORT", callback?: Callback<"OK">): ChainableCommander
- shutdown(nosave: "NOSAVE", force: "FORCE", callback?: Callback<"OK">): ChainableCommander
- shutdown(nosave: "NOSAVE", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): ChainableCommander
- shutdown(nosave: "NOSAVE", now: "NOW", callback?: Callback<"OK">): ChainableCommander
- shutdown(nosave: "NOSAVE", now: "NOW", abort: "ABORT", callback?: Callback<"OK">): ChainableCommander
- shutdown(nosave: "NOSAVE", now: "NOW", force: "FORCE", callback?: Callback<"OK">): ChainableCommander
- shutdown(nosave: "NOSAVE", now: "NOW", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): ChainableCommander
- shutdown(save: "SAVE", callback?: Callback<"OK">): ChainableCommander
- shutdown(save: "SAVE", abort: "ABORT", callback?: Callback<"OK">): ChainableCommander
- shutdown(save: "SAVE", force: "FORCE", callback?: Callback<"OK">): ChainableCommander
- shutdown(save: "SAVE", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): ChainableCommander
- shutdown(save: "SAVE", now: "NOW", callback?: Callback<"OK">): ChainableCommander
- shutdown(save: "SAVE", now: "NOW", abort: "ABORT", callback?: Callback<"OK">): ChainableCommander
- shutdown(save: "SAVE", now: "NOW", force: "FORCE", callback?: Callback<"OK">): ChainableCommander
- shutdown(save: "SAVE", now: "NOW", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): ChainableCommander
- \n
Synchronously save the dataset to disk and then shut down the server
\n- \n
- group: server \n
- complexity: O(N) when saving, where N is the total number of keys in all databases when saving data, otherwise O(1) \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
abort: "ABORT"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
force: "FORCE"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
now: "NOW"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
now: "NOW"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
now: "NOW"
force: "FORCE"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
now: "NOW"
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
nosave: "NOSAVE"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
nosave: "NOSAVE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
nosave: "NOSAVE"
force: "FORCE"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
nosave: "NOSAVE"
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
nosave: "NOSAVE"
now: "NOW"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
nosave: "NOSAVE"
now: "NOW"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
nosave: "NOSAVE"
now: "NOW"
force: "FORCE"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
nosave: "NOSAVE"
now: "NOW"
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
save: "SAVE"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
save: "SAVE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
save: "SAVE"
force: "FORCE"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
save: "SAVE"
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
save: "SAVE"
now: "NOW"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
save: "SAVE"
now: "NOW"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
save: "SAVE"
now: "NOW"
force: "FORCE"
Optional callback: Callback<"OK">
Returns ChainableCommander
Parameters
save: "SAVE"
now: "NOW"
force: "FORCE"
abort: "ABORT"
Optional callback: Callback<"OK">
Returns ChainableCommander
sinter
- sinter(...args: [...keys: RedisKey[], callback: Callback<string[]>]): ChainableCommander
- sinter(...args: [keys: RedisKey[], callback: Callback<string[]>]): ChainableCommander
- sinter(...args: RedisKey[]): ChainableCommander
- sinter(...args: [keys: RedisKey[]]): ChainableCommander
- \n
Intersect multiple sets
\n- \n
- group: set \n
- complexity: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: RedisKey[]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[]]
Returns ChainableCommander
sinter
- sinter
Buffer(...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]): ChainableCommander - sinter
Buffer(...args: [keys: RedisKey[], callback: Callback<Buffer[]>]): ChainableCommander - sinter
Buffer(...args: RedisKey[]): ChainableCommander - sinter
Buffer(...args: [keys: RedisKey[]]): ChainableCommander
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: RedisKey[]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[]]
Returns ChainableCommander
sintercard
- sintercard(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- sintercard(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- sintercard(...args: [numkeys: string | number, ...keys: RedisKey[]]): ChainableCommander
- sintercard(...args: [numkeys: string | number, keys: RedisKey[]]): ChainableCommander
- sintercard(...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]): ChainableCommander
- sintercard(...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]): ChainableCommander
- sintercard(...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number]): ChainableCommander
- sintercard(...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number]): ChainableCommander
- \n
Intersect multiple sets and return the cardinality of the result
\n- \n
- group: set \n
- complexity: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number]
Returns ChainableCommander
sinterstore
- sinterstore(...args: [destination: RedisKey, ...keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- sinterstore(...args: [destination: RedisKey, keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- sinterstore(...args: [destination: RedisKey, ...keys: RedisKey[]]): ChainableCommander
- sinterstore(...args: [destination: RedisKey, keys: RedisKey[]]): ChainableCommander
- \n
Intersect multiple sets and store the resulting set in a key
\n- \n
- group: set \n
- complexity: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets. \n
- since: 1.0.0 \n
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
sismember
- sismember(key: RedisKey, member: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- \n
Determine if a given value is a member of a set
\n- \n
- group: set \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
member: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
slaveof
- slaveof(host: string | Buffer, port: string | number, callback?: Callback<"OK">): ChainableCommander
- \n
Make the server a replica of another instance, or promote it as master.
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
host: string | Buffer
port: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
slowlog
- slowlog(subcommand: "GET", callback?: Callback<unknown>): ChainableCommander
- slowlog(subcommand: "GET", count: string | number, callback?: Callback<unknown>): ChainableCommander
- slowlog(subcommand: "HELP", callback?: Callback<unknown>): ChainableCommander
- slowlog(subcommand: "LEN", callback?: Callback<unknown>): ChainableCommander
- slowlog(subcommand: "RESET", callback?: Callback<unknown>): ChainableCommander
- \n
Get the slow log's entries
\n- \n
- group: server \n
- complexity: O(N) where N is the number of entries returned \n
- since: 2.2.12 \n
Parameters
subcommand: "GET"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "GET"
count: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Show helpful text about the different subcommands
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Get the slow log's length
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.2.12 \n
Parameters
subcommand: "LEN"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Clear all entries from the slow log
\n- \n
- group: server \n
- complexity: O(N) where N is the number of entries in the slowlog \n
- since: 2.2.12 \n
Parameters
subcommand: "RESET"
Optional callback: Callback<unknown>
Returns ChainableCommander
smembers
- smembers(key: RedisKey, callback?: Callback<string[]>): ChainableCommander
- \n
Get all the members in a set
\n- \n
- group: set \n
- complexity: O(N) where N is the set cardinality. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string[]>
Returns ChainableCommander
smembers
- smembers
Buffer(key: RedisKey, callback?: Callback<Buffer[]>): ChainableCommander
Parameters
key: RedisKey
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
smismember
- smismember(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- smismember(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number[]>]): ChainableCommander
- smismember(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): ChainableCommander
- smismember(...args: [key: RedisKey, members: (string | number | Buffer)[]]): ChainableCommander
- \n
Returns the membership associated with the given elements for a set
\n- \n
- group: set \n
- complexity: O(N) where N is the number of elements being checked for membership \n
- since: 6.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns ChainableCommander
smove
- smove(source: RedisKey, destination: RedisKey, member: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- \n
Move a member from one set to another
\n- \n
- group: set \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
source: RedisKey
destination: RedisKey
member: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
sort
- sort(...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<unknown>]): ChainableCommander
- sort(...args: [key: RedisKey, ...args: RedisValue[]]): ChainableCommander
- \n
Sort the elements in a list, set or sorted set
\n- \n
- group: generic \n
- complexity: O(N+M*log(M)) where N is the number of elements in the list or set to sort, and M the number of returned elements. When the elements are not sorted, complexity is O(N). \n
- since: 1.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[]]
Returns ChainableCommander
sort_
- sort_
ro(key: RedisKey, callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, alpha: "ALPHA", callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, asc: "ASC", callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, asc: "ASC", alpha: "ALPHA", callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, desc: "DESC", callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, desc: "DESC", alpha: "ALPHA", callback?: Callback<unknown>): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[]]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], alpha: "ALPHA", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], alpha: "ALPHA"]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC"]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA"]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC"]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA"]): ChainableCommander - sort_
ro(key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, alpha: "ALPHA", callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, asc: "ASC", callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, asc: "ASC", alpha: "ALPHA", callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, desc: "DESC", callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, desc: "DESC", alpha: "ALPHA", callback?: Callback<unknown>): ChainableCommander - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[]]): ChainableCommander - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], alpha: "ALPHA", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], alpha: "ALPHA"]): ChainableCommander - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC"]): ChainableCommander - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA"]): ChainableCommander - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC"]): ChainableCommander - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA"]): ChainableCommander - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, alpha: "ALPHA", callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, asc: "ASC", callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, asc: "ASC", alpha: "ALPHA", callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, desc: "DESC", callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, desc: "DESC", alpha: "ALPHA", callback?: Callback<unknown>): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[]]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA"]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC"]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA"]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC"]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA"]): ChainableCommander - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, alpha: "ALPHA", callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, asc: "ASC", callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, asc: "ASC", alpha: "ALPHA", callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, desc: "DESC", callback?: Callback<unknown>): ChainableCommander - sort_
ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, desc: "DESC", alpha: "ALPHA", callback?: Callback<unknown>): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[]]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA"]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC"]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA"]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC"]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]): ChainableCommander - sort_
ro(...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA"]): ChainableCommander
- \n
Sort the elements in a list, set or sorted set. Read-only variant of SORT.
\n- \n
- group: generic \n
- complexity: O(N+M*log(M)) where N is the number of elements in the list or set to sort, and M the number of returned elements. When the elements are not sorted, complexity is O(N). \n
- since: 7.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
asc: "ASC"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
asc: "ASC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
desc: "DESC"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
desc: "DESC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], alpha: "ALPHA", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], alpha: "ALPHA"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA"]
Returns ChainableCommander
Parameters
key: RedisKey
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
asc: "ASC"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
asc: "ASC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
desc: "DESC"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
desc: "DESC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], alpha: "ALPHA", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], alpha: "ALPHA"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], asc: "ASC", alpha: "ALPHA"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken: "GET", ...patterns: string[], desc: "DESC", alpha: "ALPHA"]
Returns ChainableCommander
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
asc: "ASC"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
asc: "ASC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
desc: "DESC"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
desc: "DESC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA"]
Returns ChainableCommander
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
asc: "ASC"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
asc: "ASC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
desc: "DESC"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
patternToken: "BY"
pattern: string
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
desc: "DESC"
alpha: "ALPHA"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], alpha: "ALPHA"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], asc: "ASC", alpha: "ALPHA"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: string | number, count: string | number, patternToken1: "GET", ...pattern1s: string[], desc: "DESC", alpha: "ALPHA"]
Returns ChainableCommander
spop
- spop(key: RedisKey, callback?: Callback<string>): ChainableCommander
- spop(key: RedisKey, count: string | number, callback?: Callback<string[]>): ChainableCommander
- \n
Remove and return one or multiple random members from a set
\n- \n
- group: set \n
- complexity: Without the count argument O(1), otherwise O(N) where N is the value of the passed count. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
spop
- spop
Buffer(key: RedisKey, callback?: Callback<Buffer>): ChainableCommander - spop
Buffer(key: RedisKey, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
spublish
- spublish(shardchannel: string | Buffer, message: string | Buffer, callback?: Callback<unknown>): ChainableCommander
- \n
Post a message to a shard channel
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of clients subscribed to the receiving shard channel. \n
- since: 7.0.0 \n
Parameters
shardchannel: string | Buffer
message: string | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
srandmember
- srandmember(key: RedisKey, callback?: Callback<string>): ChainableCommander
- srandmember(key: RedisKey, count: string | number, callback?: Callback<string[]>): ChainableCommander
- \n
Get one or multiple random members from a set
\n- \n
- group: set \n
- complexity: Without the count argument O(1), otherwise O(N) where N is the absolute value of the passed count. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
srandmember
- srandmember
Buffer(key: RedisKey, callback?: Callback<Buffer>): ChainableCommander - srandmember
Buffer(key: RedisKey, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
srem
- srem(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- srem(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- srem(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): ChainableCommander
- srem(...args: [key: RedisKey, members: (string | number | Buffer)[]]): ChainableCommander
- \n
Remove one or more members from a set
\n- \n
- group: set \n
- complexity: O(N) where N is the number of members to be removed. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns ChainableCommander
sscan
- sscan(key: RedisKey, cursor: string | number, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- sscan(key: RedisKey, cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- sscan(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- sscan(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- \n
Incrementally iterate Set elements
\n- \n
- group: set \n
- complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.. \n
- since: 2.8.0 \n
Parameters
key: RedisKey
cursor: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
Parameters
key: RedisKey
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
sscan
- sscan
Buffer(key: RedisKey, cursor: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander - sscan
Buffer(key: RedisKey, cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander - sscan
Buffer(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander - sscan
Buffer(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander
Parameters
key: RedisKey
cursor: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
Parameters
key: RedisKey
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
ssubscribe
- ssubscribe(...args: [...shardchannels: (string | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- ssubscribe(...args: (string | Buffer)[]): ChainableCommander
- \n
Listen for messages published to the given shard channels
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of shard channels to subscribe to. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [...shardchannels: (string | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: (string | Buffer)[]
Returns ChainableCommander
strlen
- strlen(key: RedisKey, callback?: Callback<number>): ChainableCommander
- \n
Get the length of the value stored in a key
\n- \n
- group: string \n
- complexity: O(1) \n
- since: 2.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns ChainableCommander
subscribe
- subscribe(...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- subscribe(...args: (string | Buffer)[]): ChainableCommander
- \n
Listen for messages published to the given channels
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of channels to subscribe to. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: (string | Buffer)[]
Returns ChainableCommander
substr
- substr(key: RedisKey, start: string | number, end: string | number, callback?: Callback<unknown>): ChainableCommander
- \n
Get a substring of the string stored at a key
\n- \n
- group: string \n
- complexity: O(N) where N is the length of the returned string. The complexity is ultimately determined by the returned length, but because creating a substring from an existing string is very cheap, it can be considered O(1) for small strings. \n
- since: 1.0.0 \n
Parameters
key: RedisKey
start: string | number
end: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
sunion
- sunion(...args: [...keys: RedisKey[], callback: Callback<string[]>]): ChainableCommander
- sunion(...args: [keys: RedisKey[], callback: Callback<string[]>]): ChainableCommander
- sunion(...args: RedisKey[]): ChainableCommander
- sunion(...args: [keys: RedisKey[]]): ChainableCommander
- \n
Add multiple sets
\n- \n
- group: set \n
- complexity: O(N) where N is the total number of elements in all given sets. \n
- since: 1.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: RedisKey[]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[]]
Returns ChainableCommander
sunion
- sunion
Buffer(...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]): ChainableCommander - sunion
Buffer(...args: [keys: RedisKey[], callback: Callback<Buffer[]>]): ChainableCommander - sunion
Buffer(...args: RedisKey[]): ChainableCommander - sunion
Buffer(...args: [keys: RedisKey[]]): ChainableCommander
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: RedisKey[]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[]]
Returns ChainableCommander
sunionstore
- sunionstore(...args: [destination: RedisKey, ...keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- sunionstore(...args: [destination: RedisKey, keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- sunionstore(...args: [destination: RedisKey, ...keys: RedisKey[]]): ChainableCommander
- sunionstore(...args: [destination: RedisKey, keys: RedisKey[]]): ChainableCommander
- \n
Add multiple sets and store the resulting set in a key
\n- \n
- group: set \n
- complexity: O(N) where N is the total number of elements in all given sets. \n
- since: 1.0.0 \n
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
sunsubscribe
- sunsubscribe(callback?: Callback<unknown>): ChainableCommander
- sunsubscribe(...args: [...shardchannels: (string | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- sunsubscribe(...args: (string | Buffer)[]): ChainableCommander
- \n
Stop listening for messages posted to the given shard channels
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of clients already subscribed to a shard channel. \n
- since: 7.0.0 \n
Parameters
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [...shardchannels: (string | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: (string | Buffer)[]
Returns ChainableCommander
swapdb
- swapdb(index1: string | number, index2: string | number, callback?: Callback<"OK">): ChainableCommander
- \n
Swaps two Redis databases
\n- \n
- group: server \n
- complexity: O(N) where N is the count of clients watching or blocking on keys from both databases. \n
- since: 4.0.0 \n
Parameters
index1: string | number
index2: string | number
Optional callback: Callback<"OK">
Returns ChainableCommander
sync
- sync(callback?: Callback<unknown>): ChainableCommander
- \n
Internal command used for replication
\n- \n
- group: server \n
- complexity: undefined \n
- since: 1.0.0 \n
Parameters
Optional callback: Callback<unknown>
Returns ChainableCommander
time
- time(callback?: Callback<number[]>): ChainableCommander
- \n
Return the current server time
\n- \n
- group: server \n
- complexity: O(1) \n
- since: 2.6.0 \n
Parameters
Optional callback: Callback<number[]>
Returns ChainableCommander
touch
- touch(...args: [...keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- touch(...args: [keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- touch(...args: RedisKey[]): ChainableCommander
- touch(...args: [keys: RedisKey[]]): ChainableCommander
- \n
Alters the last access time of a key(s). Returns the number of existing keys specified.
\n- \n
- group: generic \n
- complexity: O(N) where N is the number of keys that will be touched. \n
- since: 3.2.1 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: RedisKey[]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[]]
Returns ChainableCommander
ttl
- ttl(key: RedisKey, callback?: Callback<number>): ChainableCommander
- \n
Get the time to live for a key in seconds
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns ChainableCommander
type
- type(key: RedisKey, callback?: Callback<string>): ChainableCommander
- \n
Determine the type stored at key
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 1.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns ChainableCommander
unlink
- unlink(...args: [...keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- unlink(...args: [keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- unlink(...args: RedisKey[]): ChainableCommander
- unlink(...args: [keys: RedisKey[]]): ChainableCommander
- \n
Delete a key asynchronously in another thread. Otherwise it is just as DEL, but non blocking.
\n- \n
- group: generic \n
- complexity: O(1) for each key removed regardless of its size. Then the command does O(N) work in a different thread in order to reclaim memory, where N is the number of allocations the deleted objects where composed of. \n
- since: 4.0.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: RedisKey[]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[]]
Returns ChainableCommander
unsubscribe
- unsubscribe(callback?: Callback<unknown>): ChainableCommander
- unsubscribe(...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- unsubscribe(...args: (string | Buffer)[]): ChainableCommander
- \n
Stop listening for messages posted to the given channels
\n- \n
- group: pubsub \n
- complexity: O(N) where N is the number of clients already subscribed to a channel. \n
- since: 2.0.0 \n
Parameters
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
Rest ...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: (string | Buffer)[]
Returns ChainableCommander
unwatch
- unwatch(callback?: Callback<"OK">): ChainableCommander
- \n
Forget about all watched keys
\n- \n
- group: transactions \n
- complexity: O(1) \n
- since: 2.2.0 \n
Parameters
Optional callback: Callback<"OK">
Returns ChainableCommander
wait
- wait(numreplicas: string | number, timeout: string | number, callback?: Callback<number>): ChainableCommander
- \n
Wait for the synchronous replication of all the write commands sent in the context of the current connection
\n- \n
- group: generic \n
- complexity: O(1) \n
- since: 3.0.0 \n
Parameters
numreplicas: string | number
timeout: string | number
Optional callback: Callback<number>
Returns ChainableCommander
watch
- watch(...args: [...keys: RedisKey[], callback: Callback<"OK">]): ChainableCommander
- watch(...args: [keys: RedisKey[], callback: Callback<"OK">]): ChainableCommander
- watch(...args: RedisKey[]): ChainableCommander
- watch(...args: [keys: RedisKey[]]): ChainableCommander
- \n
Watch the given keys to determine execution of the MULTI/EXEC block
\n- \n
- group: transactions \n
- complexity: O(1) for every key. \n
- since: 2.2.0 \n
Parameters
Rest ...args: [...keys: RedisKey[], callback: Callback<"OK">]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[], callback: Callback<"OK">]
Returns ChainableCommander
Parameters
Rest ...args: RedisKey[]
Returns ChainableCommander
Parameters
Rest ...args: [keys: RedisKey[]]
Returns ChainableCommander
xack
- xack(...args: [key: RedisKey, group: string | Buffer, ...ids: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- xack(...args: [key: RedisKey, group: string | Buffer, ...ids: (string | number | Buffer)[]]): ChainableCommander
- \n
Marks a pending message as correctly processed, effectively removing it from the pending entries list of the consumer group. Return value of the command is the number of messages successfully acknowledged, that is, the IDs we were actually able to resolve in the PEL.
\n- \n
- group: stream \n
- complexity: O(1) for each message ID processed. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, ...ids: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, ...ids: (string | number | Buffer)[]]
Returns ChainableCommander
xadd
- xadd(...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<string>]): ChainableCommander
- xadd(...args: [key: RedisKey, ...args: RedisValue[]]): ChainableCommander
- \n
Appends a new entry to a stream
\n- \n
- group: stream \n
- complexity: O(1) when adding a new entry, O(N) when trimming where N being the number of entries evicted. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[]]
Returns ChainableCommander
xadd
- xadd
Buffer(...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<Buffer>]): ChainableCommander - xadd
Buffer(...args: [key: RedisKey, ...args: RedisValue[]]): ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...args: RedisValue[]]
Returns ChainableCommander
xautoclaim
- xautoclaim(key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, start: string | number | Buffer, callback?: Callback<unknown[]>): ChainableCommander
- xautoclaim(key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, start: string | number | Buffer, justid: "JUSTID", callback?: Callback<unknown[]>): ChainableCommander
- xautoclaim(key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, start: string | number | Buffer, countToken: "COUNT", count: string | number, callback?: Callback<unknown[]>): ChainableCommander
- xautoclaim(key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, start: string | number | Buffer, countToken: "COUNT", count: string | number, justid: "JUSTID", callback?: Callback<unknown[]>): ChainableCommander
- \n
Changes (or acquires) ownership of messages in a consumer group, as if the messages were delivered to the specified consumer.
\n- \n
- group: stream \n
- complexity: O(1) if COUNT is small. \n
- since: 6.2.0 \n
Parameters
key: RedisKey
group: string | Buffer
consumer: string | Buffer
minIdleTime: string | number | Buffer
start: string | number | Buffer
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
key: RedisKey
group: string | Buffer
consumer: string | Buffer
minIdleTime: string | number | Buffer
start: string | number | Buffer
justid: "JUSTID"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
key: RedisKey
group: string | Buffer
consumer: string | Buffer
minIdleTime: string | number | Buffer
start: string | number | Buffer
countToken: "COUNT"
count: string | number
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
key: RedisKey
group: string | Buffer
consumer: string | Buffer
minIdleTime: string | number | Buffer
start: string | number | Buffer
countToken: "COUNT"
count: string | number
justid: "JUSTID"
Optional callback: Callback<unknown[]>
Returns ChainableCommander
xclaim
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[]]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], justid: "JUSTID", callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], justid: "JUSTID"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE", callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE", justid: "JUSTID"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID", callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE", callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID", callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", justid: "JUSTID"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID", callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, justid: "JUSTID", callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, justid: "JUSTID"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE", callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE", justid: "JUSTID"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID", callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID", callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", callback: Callback<unknown[]>]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", justid: "JUSTID"]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): ChainableCommander
- xclaim(...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]): ChainableCommander
- \n
Changes (or acquires) ownership of a message in a consumer group, as if the message was delivered to the specified consumer.
\n- \n
- group: stream \n
- complexity: O(log N) with N being the number of messages in the PEL of the consumer group. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], justid: "JUSTID", callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], justid: "JUSTID"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE", callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], force: "FORCE", justid: "JUSTID"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID", callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE", callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID", callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", justid: "JUSTID"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID", callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, justid: "JUSTID", callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, justid: "JUSTID"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE", callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE", justid: "JUSTID", callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, force: "FORCE", justid: "JUSTID"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID", callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, justid: "JUSTID"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, countToken: "RETRYCOUNT", count: string | number, force: "FORCE", justid: "JUSTID"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID", callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, justid: "JUSTID"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, force: "FORCE", justid: "JUSTID"]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number, countToken: "RETRYCOUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | number | Buffer, ...ids: (string | number | Buffer)[], msToken: "IDLE", ms: string | number, unixTimeMillisecondsToken: "TIME", unixTimeMilliseconds: string | number]
Returns ChainableCommander
xdel
- xdel(...args: [key: RedisKey, ...ids: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- xdel(...args: [key: RedisKey, ...ids: (string | number | Buffer)[]]): ChainableCommander
- \n
Removes the specified entries from the stream. Returns the number of items actually deleted, that may be different from the number of IDs passed in case certain IDs do not exist.
\n- \n
- group: stream \n
- complexity: O(1) for each single item to delete in the stream, regardless of the stream size. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [key: RedisKey, ...ids: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...ids: (string | number | Buffer)[]]
Returns ChainableCommander
xdelex
- xdelex(...args: [key: RedisKey, idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- xdelex(...args: [key: RedisKey, idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]): ChainableCommander
- xdelex(...args: [key: RedisKey, keepref: "KEEPREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- xdelex(...args: [key: RedisKey, keepref: "KEEPREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]): ChainableCommander
- xdelex(...args: [key: RedisKey, delref: "DELREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- xdelex(...args: [key: RedisKey, delref: "DELREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]): ChainableCommander
- xdelex(...args: [key: RedisKey, acked: "ACKED", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]): ChainableCommander
- xdelex(...args: [key: RedisKey, acked: "ACKED", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]): ChainableCommander
- \n
Deletes one or multiple entries from the stream.
\n- \n
- group: stream \n
- complexity: O(1) for each single item to delete in the stream, regardless of the stream size. \n
- since: 8.2.0 \n
Parameters
Rest ...args: [key: RedisKey, idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, keepref: "KEEPREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, keepref: "KEEPREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, delref: "DELREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, delref: "DELREF", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, acked: "ACKED", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[], callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, acked: "ACKED", idsToken: "IDS", numids: string | number, ...ids: (string | number | Buffer)[]]
Returns ChainableCommander
xgroup
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, id: string | number | Buffer, callback?: Callback<unknown>): ChainableCommander
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, id: string | number | Buffer, entriesReadToken: "ENTRIESREAD", entriesRead: string | number, callback?: Callback<unknown>): ChainableCommander
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, id: string | number | Buffer, mkstream: "MKSTREAM", callback?: Callback<unknown>): ChainableCommander
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, id: string | number | Buffer, mkstream: "MKSTREAM", entriesReadToken: "ENTRIESREAD", entriesRead: string | number, callback?: Callback<unknown>): ChainableCommander
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, newId: "$", callback?: Callback<unknown>): ChainableCommander
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, newId: "$", entriesReadToken: "ENTRIESREAD", entriesRead: string | number, callback?: Callback<unknown>): ChainableCommander
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, newId: "$", mkstream: "MKSTREAM", callback?: Callback<unknown>): ChainableCommander
- xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, newId: "$", mkstream: "MKSTREAM", entriesReadToken: "ENTRIESREAD", entriesRead: string | number, callback?: Callback<unknown>): ChainableCommander
- xgroup(subcommand: "CREATECONSUMER", key: RedisKey, groupname: string | Buffer, consumername: string | Buffer, callback?: Callback<unknown>): ChainableCommander
- xgroup(subcommand: "DELCONSUMER", key: RedisKey, groupname: string | Buffer, consumername: string | Buffer, callback?: Callback<unknown>): ChainableCommander
- xgroup(subcommand: "DESTROY", key: RedisKey, groupname: string | Buffer, callback?: Callback<unknown>): ChainableCommander
- xgroup(subcommand: "HELP", callback?: Callback<unknown>): ChainableCommander
- xgroup(subcommand: "SETID", key: RedisKey, groupname: string | Buffer, id: string | number | Buffer, callback?: Callback<unknown>): ChainableCommander
- xgroup(subcommand: "SETID", key: RedisKey, groupname: string | Buffer, id: string | number | Buffer, entriesReadToken: "ENTRIESREAD", entriesRead: string | number, callback?: Callback<unknown>): ChainableCommander
- xgroup(subcommand: "SETID", key: RedisKey, groupname: string | Buffer, newId: "$", callback?: Callback<unknown>): ChainableCommander
- xgroup(subcommand: "SETID", key: RedisKey, groupname: string | Buffer, newId: "$", entriesReadToken: "ENTRIESREAD", entriesRead: string | number, callback?: Callback<unknown>): ChainableCommander
- \n
Create a consumer group.
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
id: string | number | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
id: string | number | Buffer
entriesReadToken: "ENTRIESREAD"
entriesRead: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
id: string | number | Buffer
mkstream: "MKSTREAM"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
id: string | number | Buffer
mkstream: "MKSTREAM"
entriesReadToken: "ENTRIESREAD"
entriesRead: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
newId: "$"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
newId: "$"
entriesReadToken: "ENTRIESREAD"
entriesRead: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
newId: "$"
mkstream: "MKSTREAM"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "CREATE"
key: RedisKey
groupname: string | Buffer
newId: "$"
mkstream: "MKSTREAM"
entriesReadToken: "ENTRIESREAD"
entriesRead: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Create a consumer in a consumer group.
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 6.2.0 \n
Parameters
subcommand: "CREATECONSUMER"
key: RedisKey
groupname: string | Buffer
consumername: string | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Delete a consumer from a consumer group.
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "DELCONSUMER"
key: RedisKey
groupname: string | Buffer
consumername: string | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Destroy a consumer group.
\n- \n
- group: stream \n
- complexity: O(N) where N is the number of entries in the group's pending entries list (PEL). \n
- since: 5.0.0 \n
Parameters
subcommand: "DESTROY"
key: RedisKey
groupname: string | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Show helpful text about the different subcommands
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Set a consumer group to an arbitrary last delivered ID value.
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "SETID"
key: RedisKey
groupname: string | Buffer
id: string | number | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "SETID"
key: RedisKey
groupname: string | Buffer
id: string | number | Buffer
entriesReadToken: "ENTRIESREAD"
entriesRead: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "SETID"
key: RedisKey
groupname: string | Buffer
newId: "$"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "SETID"
key: RedisKey
groupname: string | Buffer
newId: "$"
entriesReadToken: "ENTRIESREAD"
entriesRead: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
xinfo
- xinfo(subcommand: "CONSUMERS", key: RedisKey, groupname: string | Buffer, callback?: Callback<unknown>): ChainableCommander
- xinfo(subcommand: "GROUPS", key: RedisKey, callback?: Callback<unknown>): ChainableCommander
- xinfo(subcommand: "HELP", callback?: Callback<unknown>): ChainableCommander
- xinfo(subcommand: "STREAM", key: RedisKey, callback?: Callback<unknown>): ChainableCommander
- xinfo(subcommand: "STREAM", key: RedisKey, fullToken: "FULL", callback?: Callback<unknown>): ChainableCommander
- xinfo(subcommand: "STREAM", key: RedisKey, fullToken: "FULL", countToken: "COUNT", count: string | number, callback?: Callback<unknown>): ChainableCommander
- \n
List the consumers in a consumer group
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "CONSUMERS"
key: RedisKey
groupname: string | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
List the consumer groups of a stream
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "GROUPS"
key: RedisKey
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Show helpful text about the different subcommands
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "HELP"
Optional callback: Callback<unknown>
Returns ChainableCommander
- \n
Get information about a stream
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
subcommand: "STREAM"
key: RedisKey
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "STREAM"
key: RedisKey
fullToken: "FULL"
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
subcommand: "STREAM"
key: RedisKey
fullToken: "FULL"
countToken: "COUNT"
count: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
xlen
- xlen(key: RedisKey, callback?: Callback<number>): ChainableCommander
- \n
Return the number of entries in a stream
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns ChainableCommander
xpending
- xpending(key: RedisKey, group: string | Buffer, callback?: Callback<unknown[]>): ChainableCommander
- xpending(key: RedisKey, group: string | Buffer, start: string | number | Buffer, end: string | number | Buffer, count: string | number, callback?: Callback<unknown[]>): ChainableCommander
- xpending(key: RedisKey, group: string | Buffer, start: string | number | Buffer, end: string | number | Buffer, count: string | number, consumer: string | Buffer, callback?: Callback<unknown[]>): ChainableCommander
- xpending(key: RedisKey, group: string | Buffer, minIdleTimeToken: "IDLE", minIdleTime: string | number, start: string | number | Buffer, end: string | number | Buffer, count: string | number, callback?: Callback<unknown[]>): ChainableCommander
- xpending(key: RedisKey, group: string | Buffer, minIdleTimeToken: "IDLE", minIdleTime: string | number, start: string | number | Buffer, end: string | number | Buffer, count: string | number, consumer: string | Buffer, callback?: Callback<unknown[]>): ChainableCommander
- \n
Return information and entries from a stream consumer group pending entries list, that are messages fetched but never acknowledged.
\n- \n
- group: stream \n
- complexity: O(N) with N being the number of elements returned, so asking for a small fixed number of entries per call is O(1). O(M), where M is the total number of entries scanned when used with the IDLE filter. When the command returns just the summary and the list of consumers is small, it runs in O(1) time; otherwise, an additional O(N) time for iterating every consumer. \n
- since: 5.0.0 \n
Parameters
key: RedisKey
group: string | Buffer
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
key: RedisKey
group: string | Buffer
start: string | number | Buffer
end: string | number | Buffer
count: string | number
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
key: RedisKey
group: string | Buffer
start: string | number | Buffer
end: string | number | Buffer
count: string | number
consumer: string | Buffer
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
key: RedisKey
group: string | Buffer
minIdleTimeToken: "IDLE"
minIdleTime: string | number
start: string | number | Buffer
end: string | number | Buffer
count: string | number
Optional callback: Callback<unknown[]>
Returns ChainableCommander
Parameters
key: RedisKey
group: string | Buffer
minIdleTimeToken: "IDLE"
minIdleTime: string | number
start: string | number | Buffer
end: string | number | Buffer
count: string | number
consumer: string | Buffer
Optional callback: Callback<unknown[]>
Returns ChainableCommander
xrange
- xrange(key: RedisKey, start: string | number | Buffer, end: string | number | Buffer, callback?: Callback<[id: string, fields: string[]][]>): ChainableCommander
- xrange(key: RedisKey, start: string | number | Buffer, end: string | number | Buffer, countToken: "COUNT", count: string | number, callback?: Callback<[id: string, fields: string[]][]>): ChainableCommander
- \n
Return a range of elements in a stream, with IDs matching the specified IDs interval
\n- \n
- group: stream \n
- complexity: O(N) with N being the number of elements being returned. If N is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1). \n
- since: 5.0.0 \n
Parameters
key: RedisKey
start: string | number | Buffer
end: string | number | Buffer
Optional callback: Callback<[id: string, fields: string[]][]>
Returns ChainableCommander
Parameters
key: RedisKey
start: string | number | Buffer
end: string | number | Buffer
countToken: "COUNT"
count: string | number
Optional callback: Callback<[id: string, fields: string[]][]>
Returns ChainableCommander
xrange
- xrange
Buffer(key: RedisKey, start: string | number | Buffer, end: string | number | Buffer, callback?: Callback<[id: Buffer, fields: Buffer[]][]>): ChainableCommander - xrange
Buffer(key: RedisKey, start: string | number | Buffer, end: string | number | Buffer, countToken: "COUNT", count: string | number, callback?: Callback<[id: Buffer, fields: Buffer[]][]>): ChainableCommander
Parameters
key: RedisKey
start: string | number | Buffer
end: string | number | Buffer
Optional callback: Callback<[id: Buffer, fields: Buffer[]][]>
Returns ChainableCommander
Parameters
key: RedisKey
start: string | number | Buffer
end: string | number | Buffer
countToken: "COUNT"
count: string | number
Optional callback: Callback<[id: Buffer, fields: Buffer[]][]>
Returns ChainableCommander
xread
- xread(...args: [streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]): ChainableCommander
- xread(...args: [streamsToken: "STREAMS", ...args: RedisValue[]]): ChainableCommander
- xread(...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]): ChainableCommander
- xread(...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): ChainableCommander
- xread(...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]): ChainableCommander
- xread(...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): ChainableCommander
- xread(...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]): ChainableCommander
- xread(...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): ChainableCommander
- \n
Return never seen elements in multiple streams, with IDs greater than the ones reported by the caller for each stream. Can block.
\n- \n
- group: stream \n
- complexity: For each stream mentioned: O(N) with N being the number of elements being returned, it means that XREAD-ing with a fixed COUNT is O(1). Note that when the BLOCK option is used, XADD will pay O(M) time in order to serve the M clients blocked on the stream getting new data. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]
Returns ChainableCommander
Parameters
Rest ...args: [streamsToken: "STREAMS", ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]
Returns ChainableCommander
Parameters
Rest ...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]
Returns ChainableCommander
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: string, items: [id: string, fields: string[]][]][]>]
Returns ChainableCommander
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns ChainableCommander
xread
- xread
Buffer(...args: [streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]): ChainableCommander - xread
Buffer(...args: [streamsToken: "STREAMS", ...args: RedisValue[]]): ChainableCommander - xread
Buffer(...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]): ChainableCommander - xread
Buffer(...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): ChainableCommander - xread
Buffer(...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]): ChainableCommander - xread
Buffer(...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): ChainableCommander - xread
Buffer(...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]): ChainableCommander - xread
Buffer(...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): ChainableCommander
Parameters
Rest ...args: [streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]
Returns ChainableCommander
Parameters
Rest ...args: [streamsToken: "STREAMS", ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]
Returns ChainableCommander
Parameters
Rest ...args: [millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]
Returns ChainableCommander
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>]
Returns ChainableCommander
Parameters
Rest ...args: [countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns ChainableCommander
xreadgroup
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): ChainableCommander
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, streamsToken: "STREAMS", ...args: RedisValue[]]): ChainableCommander
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): ChainableCommander
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]): ChainableCommander
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): ChainableCommander
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): ChainableCommander
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): ChainableCommander
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]): ChainableCommander
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): ChainableCommander
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): ChainableCommander
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): ChainableCommander
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]): ChainableCommander
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): ChainableCommander
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]): ChainableCommander
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]): ChainableCommander
- xreadgroup(...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]): ChainableCommander
- \n
Return new entries from a stream using a consumer group, or access the history of the pending entries for a given consumer. Can block.
\n- \n
- group: stream \n
- complexity: For each stream mentioned: O(M) with M being the number of elements returned. If M is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1). On the other side when XREADGROUP blocks, XADD will pay the O(N) time in order to serve the N clients blocked on the stream getting new data. \n
- since: 5.0.0 \n
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, streamsToken: "STREAMS", ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[], callback: Callback<unknown[]>]
Returns ChainableCommander
Parameters
Rest ...args: [groupConsumerToken: "GROUP", group: string | Buffer, consumer: string | Buffer, countToken: "COUNT", count: string | number, millisecondsToken: "BLOCK", milliseconds: string | number, noack: "NOACK", streamsToken: "STREAMS", ...args: RedisValue[]]
Returns ChainableCommander
xrevrange
- xrevrange(key: RedisKey, end: string | number | Buffer, start: string | number | Buffer, callback?: Callback<[id: string, fields: string[]][]>): ChainableCommander
- xrevrange(key: RedisKey, end: string | number | Buffer, start: string | number | Buffer, countToken: "COUNT", count: string | number, callback?: Callback<[id: string, fields: string[]][]>): ChainableCommander
- \n
Return a range of elements in a stream, with IDs matching the specified IDs interval, in reverse order (from greater to smaller IDs) compared to XRANGE
\n- \n
- group: stream \n
- complexity: O(N) with N being the number of elements returned. If N is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1). \n
- since: 5.0.0 \n
Parameters
key: RedisKey
end: string | number | Buffer
start: string | number | Buffer
Optional callback: Callback<[id: string, fields: string[]][]>
Returns ChainableCommander
Parameters
key: RedisKey
end: string | number | Buffer
start: string | number | Buffer
countToken: "COUNT"
count: string | number
Optional callback: Callback<[id: string, fields: string[]][]>
Returns ChainableCommander
xrevrange
- xrevrange
Buffer(key: RedisKey, end: string | number | Buffer, start: string | number | Buffer, callback?: Callback<[id: Buffer, fields: Buffer[]][]>): ChainableCommander - xrevrange
Buffer(key: RedisKey, end: string | number | Buffer, start: string | number | Buffer, countToken: "COUNT", count: string | number, callback?: Callback<[id: Buffer, fields: Buffer[]][]>): ChainableCommander
Parameters
key: RedisKey
end: string | number | Buffer
start: string | number | Buffer
Optional callback: Callback<[id: Buffer, fields: Buffer[]][]>
Returns ChainableCommander
Parameters
key: RedisKey
end: string | number | Buffer
start: string | number | Buffer
countToken: "COUNT"
count: string | number
Optional callback: Callback<[id: Buffer, fields: Buffer[]][]>
Returns ChainableCommander
xsetid
- xsetid(key: RedisKey, lastId: string | number | Buffer, callback?: Callback<unknown>): ChainableCommander
- xsetid(key: RedisKey, lastId: string | number | Buffer, maxDeletedEntryIdToken: "MAXDELETEDID", maxDeletedEntryId: string | number | Buffer, callback?: Callback<unknown>): ChainableCommander
- xsetid(key: RedisKey, lastId: string | number | Buffer, entriesAddedToken: "ENTRIESADDED", entriesAdded: string | number, callback?: Callback<unknown>): ChainableCommander
- xsetid(key: RedisKey, lastId: string | number | Buffer, entriesAddedToken: "ENTRIESADDED", entriesAdded: string | number, maxDeletedEntryIdToken: "MAXDELETEDID", maxDeletedEntryId: string | number | Buffer, callback?: Callback<unknown>): ChainableCommander
- \n
An internal command for replicating stream values
\n- \n
- group: stream \n
- complexity: O(1) \n
- since: 5.0.0 \n
Parameters
key: RedisKey
lastId: string | number | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
lastId: string | number | Buffer
maxDeletedEntryIdToken: "MAXDELETEDID"
maxDeletedEntryId: string | number | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
lastId: string | number | Buffer
entriesAddedToken: "ENTRIESADDED"
entriesAdded: string | number
Optional callback: Callback<unknown>
Returns ChainableCommander
Parameters
key: RedisKey
lastId: string | number | Buffer
entriesAddedToken: "ENTRIESADDED"
entriesAdded: string | number
maxDeletedEntryIdToken: "MAXDELETEDID"
maxDeletedEntryId: string | number | Buffer
Optional callback: Callback<unknown>
Returns ChainableCommander
xtrim
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, keepref: "KEEPREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, delref: "DELREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, acked: "ACKED", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, keepref: "KEEPREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, delref: "DELREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, acked: "ACKED", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, keepref: "KEEPREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, delref: "DELREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, acked: "ACKED", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, keepref: "KEEPREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, delref: "DELREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, acked: "ACKED", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, keepref: "KEEPREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, delref: "DELREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, acked: "ACKED", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, keepref: "KEEPREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, delref: "DELREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, acked: "ACKED", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, keepref: "KEEPREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, delref: "DELREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, acked: "ACKED", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, keepref: "KEEPREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, delref: "DELREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, acked: "ACKED", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, keepref: "KEEPREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, delref: "DELREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, acked: "ACKED", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, keepref: "KEEPREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, delref: "DELREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, acked: "ACKED", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, keepref: "KEEPREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, delref: "DELREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, acked: "ACKED", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, keepref: "KEEPREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, delref: "DELREF", callback?: Callback<number>): ChainableCommander
- xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | number | Buffer, countToken: "LIMIT", count: string | number, acked: "ACKED", callback?: Callback<number>): ChainableCommander
- \n
Deletes messages from the beginning of a stream.
\n- \n
- group: stream \n
- complexity: O(N), with N being the number of evicted entries. Constant times are very small however, since entries are organized in macro nodes containing multiple entries that can be released with a single deallocation. \n
- since: 5.0.0 \n
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
delref: "DELREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
acked: "ACKED"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
delref: "DELREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
acked: "ACKED"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
delref: "DELREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
acked: "ACKED"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
delref: "DELREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
acked: "ACKED"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
delref: "DELREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
acked: "ACKED"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
delref: "DELREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
maxlen: "MAXLEN"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
acked: "ACKED"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
delref: "DELREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
acked: "ACKED"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
delref: "DELREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
acked: "ACKED"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
delref: "DELREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
acked: "ACKED"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
delref: "DELREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
equal: "="
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
acked: "ACKED"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
delref: "DELREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
acked: "ACKED"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
keepref: "KEEPREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
delref: "DELREF"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
key: RedisKey
minid: "MINID"
approximately: "~"
threshold: string | number | Buffer
countToken: "LIMIT"
count: string | number
acked: "ACKED"
Optional callback: Callback<number>
Returns ChainableCommander
zadd
- zadd(...args: [key: RedisKey, ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zadd(...args: [key: RedisKey, ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- zadd(...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zadd(...args: [key: RedisKey, ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- zadd(...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, gt: "GT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zadd(...args: [key: RedisKey, gt: "GT", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- zadd(...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zadd(...args: [key: RedisKey, gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- zadd(...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, lt: "LT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zadd(...args: [key: RedisKey, lt: "LT", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- zadd(...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zadd(...args: [key: RedisKey, lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- zadd(...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- zadd(...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]): ChainableCommander
- zadd(...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
- \n
Add one or more members to a sorted set, or update its score if it already exists
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) for each item added, where N is the number of elements in the sorted set. \n
- since: 1.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<string>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
zadd
- zadd
Buffer(...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]): ChainableCommander - zadd
Buffer(...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]): ChainableCommander
Parameters
Rest ...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, nx: "NX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", gt: "GT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[], callback: Callback<Buffer>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, xx: "XX", lt: "LT", ch: "CH", incr: "INCR", ...scoreMembers: (string | number | Buffer)[]]
Returns ChainableCommander
zcard
- zcard(key: RedisKey, callback?: Callback<number>): ChainableCommander
- \n
Get the number of members in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(1) \n
- since: 1.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<number>
Returns ChainableCommander
zcount
- zcount(key: RedisKey, min: string | number, max: string | number, callback?: Callback<number>): ChainableCommander
- \n
Count the members in a sorted set with scores within the given values
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) with N being the number of elements in the sorted set. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
min: string | number
max: string | number
Optional callback: Callback<number>
Returns ChainableCommander
zdiff
- zdiff(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]): ChainableCommander
- zdiff(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]): ChainableCommander
- zdiff(...args: [numkeys: string | number, ...keys: RedisKey[]]): ChainableCommander
- zdiff(...args: [numkeys: string | number, keys: RedisKey[]]): ChainableCommander
- zdiff(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zdiff(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zdiff(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]): ChainableCommander
- zdiff(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]): ChainableCommander
- \n
Subtract multiple sorted sets
\n- \n
- group: sorted-set \n
- complexity: O(L + (N-K)log(N)) worst case where L is the total number of elements in all the sets, N is the size of the first set, and K is the size of the result set. \n
- since: 6.2.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns ChainableCommander
zdiff
- zdiff
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]): ChainableCommander - zdiff
Buffer(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]): ChainableCommander - zdiff
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[]]): ChainableCommander - zdiff
Buffer(...args: [numkeys: string | number, keys: RedisKey[]]): ChainableCommander - zdiff
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zdiff
Buffer(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zdiff
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]): ChainableCommander - zdiff
Buffer(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]): ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns ChainableCommander
zdiffstore
- zdiffstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- zdiffstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- zdiffstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[]]): ChainableCommander
- zdiffstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[]]): ChainableCommander
- \n
Subtract multiple sorted sets and store the resulting sorted set in a new key
\n- \n
- group: sorted-set \n
- complexity: O(L + (N-K)log(N)) worst case where L is the total number of elements in all the sets, N is the size of the first set, and K is the size of the result set. \n
- since: 6.2.0 \n
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
zincrby
- zincrby(key: RedisKey, increment: string | number, member: string | number | Buffer, callback?: Callback<string>): ChainableCommander
- \n
Increment the score of a member in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) where N is the number of elements in the sorted set. \n
- since: 1.2.0 \n
Parameters
key: RedisKey
increment: string | number
member: string | number | Buffer
Optional callback: Callback<string>
Returns ChainableCommander
zincrby
- zincrby
Buffer(key: RedisKey, increment: string | number, member: string | number | Buffer, callback?: Callback<Buffer>): ChainableCommander
Parameters
key: RedisKey
increment: string | number
member: string | number | Buffer
Optional callback: Callback<Buffer>
Returns ChainableCommander
zinter
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[]]): ChainableCommander
- zinter(...args: [numkeys: string | number, keys: RedisKey[]]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]): ChainableCommander
- zinter(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): ChainableCommander
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): ChainableCommander
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): ChainableCommander
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): ChainableCommander
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): ChainableCommander
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): ChainableCommander
- zinter(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...args: RedisValue[]]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zinter(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): ChainableCommander
- \n
Intersect multiple sorted sets
\n- \n
- group: sorted-set \n
- complexity: O(NK)+O(Mlog(M)) worst case with N being the smallest input sorted set, K being the number of input sorted sets and M being the number of elements in the resulting sorted set. \n
- since: 6.2.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns ChainableCommander
zinter
- zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[]]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[]]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[]]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zinter
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns ChainableCommander
zintercard
- zintercard(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- zintercard(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- zintercard(...args: [numkeys: string | number, ...keys: RedisKey[]]): ChainableCommander
- zintercard(...args: [numkeys: string | number, keys: RedisKey[]]): ChainableCommander
- zintercard(...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]): ChainableCommander
- zintercard(...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]): ChainableCommander
- zintercard(...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number]): ChainableCommander
- zintercard(...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number]): ChainableCommander
- \n
Intersect multiple sorted sets and return the cardinality of the result
\n- \n
- group: sorted-set \n
- complexity: O(N*K) worst case with N being the smallest input sorted set, K being the number of input sorted sets. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number, callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], limitToken: "LIMIT", limit: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], limitToken: "LIMIT", limit: string | number]
Returns ChainableCommander
zinterstore
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[]]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[]]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], callback: Callback<number>]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[]]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]): ChainableCommander
- zinterstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]): ChainableCommander
- \n
Intersect multiple sorted sets and store the resulting sorted set in a new key
\n- \n
- group: sorted-set \n
- complexity: O(NK)+O(Mlog(M)) worst case with N being the smallest input sorted set, K being the number of input sorted sets and M being the number of elements in the resulting sorted set. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]
Returns ChainableCommander
zlexcount
- zlexcount(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- \n
Count the number of members in a sorted set between a given lexicographical range
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) with N being the number of elements in the sorted set. \n
- since: 2.8.9 \n
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
zmpop
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN", callback: Callback<unknown>]): ChainableCommander
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], min: "MIN", callback: Callback<unknown>]): ChainableCommander
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN"]): ChainableCommander
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], min: "MIN"]): ChainableCommander
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): ChainableCommander
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): ChainableCommander
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]): ChainableCommander
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]): ChainableCommander
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX", callback: Callback<unknown>]): ChainableCommander
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], max: "MAX", callback: Callback<unknown>]): ChainableCommander
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX"]): ChainableCommander
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], max: "MAX"]): ChainableCommander
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): ChainableCommander
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]): ChainableCommander
- zmpop(...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]): ChainableCommander
- zmpop(...args: [numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]): ChainableCommander
- \n
Remove and return members with scores in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(K) + O(N*log(M)) where K is the number of provided keys, N being the number of elements in the sorted set, and M being the number of elements popped. \n
- since: 7.0.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], min: "MIN", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], min: "MIN", countToken: "COUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], max: "MAX", callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number, callback: Callback<unknown>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], max: "MAX", countToken: "COUNT", count: string | number]
Returns ChainableCommander
zmscore
- zmscore(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<string[]>]): ChainableCommander
- zmscore(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<string[]>]): ChainableCommander
- zmscore(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): ChainableCommander
- zmscore(...args: [key: RedisKey, members: (string | number | Buffer)[]]): ChainableCommander
- \n
Get the score associated with the given members in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(N) where N is the number of members being requested. \n
- since: 6.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns ChainableCommander
zmscore
- zmscore
Buffer(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<Buffer[]>]): ChainableCommander - zmscore
Buffer(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<Buffer[]>]): ChainableCommander - zmscore
Buffer(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): ChainableCommander - zmscore
Buffer(...args: [key: RedisKey, members: (string | number | Buffer)[]]): ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns ChainableCommander
zpopmax
- zpopmax(key: RedisKey, callback?: Callback<string[]>): ChainableCommander
- zpopmax(key: RedisKey, count: string | number, callback?: Callback<string[]>): ChainableCommander
- \n
Remove and return members with the highest scores in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(log(N)*M) with N being the number of elements in the sorted set, and M being the number of elements popped. \n
- since: 5.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
zpopmax
- zpopmax
Buffer(key: RedisKey, callback?: Callback<Buffer[]>): ChainableCommander - zpopmax
Buffer(key: RedisKey, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander
Parameters
key: RedisKey
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
zpopmin
- zpopmin(key: RedisKey, callback?: Callback<string[]>): ChainableCommander
- zpopmin(key: RedisKey, count: string | number, callback?: Callback<string[]>): ChainableCommander
- \n
Remove and return members with the lowest scores in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(log(N)*M) with N being the number of elements in the sorted set, and M being the number of elements popped. \n
- since: 5.0.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
zpopmin
- zpopmin
Buffer(key: RedisKey, callback?: Callback<Buffer[]>): ChainableCommander - zpopmin
Buffer(key: RedisKey, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander
Parameters
key: RedisKey
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
zrandmember
- zrandmember(key: RedisKey, callback?: Callback<string>): ChainableCommander
- zrandmember(key: RedisKey, count: string | number, callback?: Callback<string[]>): ChainableCommander
- zrandmember(key: RedisKey, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): ChainableCommander
- \n
Get one or multiple random elements from a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(N) where N is the number of elements returned \n
- since: 6.2.0 \n
Parameters
key: RedisKey
Optional callback: Callback<string>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns ChainableCommander
zrandmember
- zrandmember
Buffer(key: RedisKey, callback?: Callback<Buffer>): ChainableCommander - zrandmember
Buffer(key: RedisKey, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander - zrandmember
Buffer(key: RedisKey, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): ChainableCommander
Parameters
key: RedisKey
Optional callback: Callback<Buffer>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
zrange
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, withscores: "WITHSCORES", callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", withscores: "WITHSCORES", callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", withscores: "WITHSCORES", callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", withscores: "WITHSCORES", callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", withscores: "WITHSCORES", callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", withscores: "WITHSCORES", callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): ChainableCommander
- zrange(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): ChainableCommander
- \n
Return a range of members in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements returned. \n
- since: 1.2.0 \n
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns ChainableCommander
zrange
- zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander - zrange
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
zrangebylex
- zrangebylex(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<string[]>): ChainableCommander
- zrangebylex(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): ChainableCommander
- \n
Return a range of members in a sorted set, by lexicographical range
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)). \n
- since: 2.8.9 \n
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
zrangebylex
- zrangebylex
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<Buffer[]>): ChainableCommander - zrangebylex
Buffer(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
zrangebyscore
- zrangebyscore(key: RedisKey, min: string | number, max: string | number, callback?: Callback<string[]>): ChainableCommander
- zrangebyscore(key: RedisKey, min: string | number, max: string | number, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): ChainableCommander
- zrangebyscore(key: RedisKey, min: string | number, max: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): ChainableCommander
- zrangebyscore(key: RedisKey, min: string | number, max: string | number, withscores: "WITHSCORES", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): ChainableCommander
- \n
Return a range of members in a sorted set, by score
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)). \n
- since: 1.0.5 \n
Parameters
key: RedisKey
min: string | number
max: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number
max: string | number
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number
max: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number
max: string | number
withscores: "WITHSCORES"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
zrangebyscore
- zrangebyscore
Buffer(key: RedisKey, min: string | number, max: string | number, callback?: Callback<Buffer[]>): ChainableCommander - zrangebyscore
Buffer(key: RedisKey, min: string | number, max: string | number, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander - zrangebyscore
Buffer(key: RedisKey, min: string | number, max: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): ChainableCommander - zrangebyscore
Buffer(key: RedisKey, min: string | number, max: string | number, withscores: "WITHSCORES", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander
Parameters
key: RedisKey
min: string | number
max: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number
max: string | number
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number
max: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
min: string | number
max: string | number
withscores: "WITHSCORES"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
zrangestore
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<number>): ChainableCommander
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", callback?: Callback<number>): ChainableCommander
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<number>): ChainableCommander
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", callback?: Callback<number>): ChainableCommander
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<number>): ChainableCommander
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", callback?: Callback<number>): ChainableCommander
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<number>): ChainableCommander
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", callback?: Callback<number>): ChainableCommander
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<number>): ChainableCommander
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", callback?: Callback<number>): ChainableCommander
- zrangestore(dst: RedisKey, src: RedisKey, min: string | number | Buffer, max: string | number | Buffer, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<number>): ChainableCommander
- \n
Store a range of members from sorted set into another key
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements stored into the destination key. \n
- since: 6.2.0 \n
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
byscore: "BYSCORE"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
Optional callback: Callback<number>
Returns ChainableCommander
Parameters
dst: RedisKey
src: RedisKey
min: string | number | Buffer
max: string | number | Buffer
bylex: "BYLEX"
rev: "REV"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<number>
Returns ChainableCommander
zrank
- zrank(key: RedisKey, member: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- \n
Determine the index of a member in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
member: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
zrem
- zrem(...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zrem(...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number>]): ChainableCommander
- zrem(...args: [key: RedisKey, ...members: (string | number | Buffer)[]]): ChainableCommander
- zrem(...args: [key: RedisKey, members: (string | number | Buffer)[]]): ChainableCommander
- \n
Remove one or more members from a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(M*log(N)) with N being the number of elements in the sorted set and M the number of elements to be removed. \n
- since: 1.2.0 \n
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns ChainableCommander
Parameters
Rest ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns ChainableCommander
zremrangebylex
- zremrangebylex(key: RedisKey, min: string | number | Buffer, max: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- \n
Remove all members in a sorted set between the given lexicographical range
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation. \n
- since: 2.8.9 \n
Parameters
key: RedisKey
min: string | number | Buffer
max: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
zremrangebyrank
- zremrangebyrank(key: RedisKey, start: string | number, stop: string | number, callback?: Callback<number>): ChainableCommander
- \n
Remove all members in a sorted set within the given indexes
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation. \n
- since: 2.0.0 \n
Parameters
key: RedisKey
start: string | number
stop: string | number
Optional callback: Callback<number>
Returns ChainableCommander
zremrangebyscore
- zremrangebyscore(key: RedisKey, min: string | number, max: string | number, callback?: Callback<number>): ChainableCommander
- \n
Remove all members in a sorted set within the given scores
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation. \n
- since: 1.2.0 \n
Parameters
key: RedisKey
min: string | number
max: string | number
Optional callback: Callback<number>
Returns ChainableCommander
zrevrange
- zrevrange(key: RedisKey, start: string | number, stop: string | number, callback?: Callback<string[]>): ChainableCommander
- zrevrange(key: RedisKey, start: string | number, stop: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): ChainableCommander
- \n
Return a range of members in a sorted set, by index, with scores ordered from high to low
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements returned. \n
- since: 1.2.0 \n
Parameters
key: RedisKey
start: string | number
stop: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
start: string | number
stop: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns ChainableCommander
zrevrange
- zrevrange
Buffer(key: RedisKey, start: string | number, stop: string | number, callback?: Callback<Buffer[]>): ChainableCommander - zrevrange
Buffer(key: RedisKey, start: string | number, stop: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): ChainableCommander
Parameters
key: RedisKey
start: string | number
stop: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
start: string | number
stop: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
zrevrangebylex
- zrevrangebylex(key: RedisKey, max: string | number | Buffer, min: string | number | Buffer, callback?: Callback<string[]>): ChainableCommander
- zrevrangebylex(key: RedisKey, max: string | number | Buffer, min: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): ChainableCommander
- \n
Return a range of members in a sorted set, by lexicographical range, ordered from higher to lower strings.
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)). \n
- since: 2.8.9 \n
Parameters
key: RedisKey
max: string | number | Buffer
min: string | number | Buffer
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
max: string | number | Buffer
min: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
zrevrangebylex
- zrevrangebylex
Buffer(key: RedisKey, max: string | number | Buffer, min: string | number | Buffer, callback?: Callback<Buffer[]>): ChainableCommander - zrevrangebylex
Buffer(key: RedisKey, max: string | number | Buffer, min: string | number | Buffer, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander
Parameters
key: RedisKey
max: string | number | Buffer
min: string | number | Buffer
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
max: string | number | Buffer
min: string | number | Buffer
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
zrevrangebyscore
- zrevrangebyscore(key: RedisKey, max: string | number, min: string | number, callback?: Callback<string[]>): ChainableCommander
- zrevrangebyscore(key: RedisKey, max: string | number, min: string | number, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): ChainableCommander
- zrevrangebyscore(key: RedisKey, max: string | number, min: string | number, withscores: "WITHSCORES", callback?: Callback<string[]>): ChainableCommander
- zrevrangebyscore(key: RedisKey, max: string | number, min: string | number, withscores: "WITHSCORES", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<string[]>): ChainableCommander
- \n
Return a range of members in a sorted set, by score, with scores ordered from high to low
\n- \n
- group: sorted-set \n
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)). \n
- since: 2.2.0 \n
Parameters
key: RedisKey
max: string | number
min: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
max: string | number
min: string | number
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
max: string | number
min: string | number
withscores: "WITHSCORES"
Optional callback: Callback<string[]>
Returns ChainableCommander
Parameters
key: RedisKey
max: string | number
min: string | number
withscores: "WITHSCORES"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<string[]>
Returns ChainableCommander
zrevrangebyscore
- zrevrangebyscore
Buffer(key: RedisKey, max: string | number, min: string | number, callback?: Callback<Buffer[]>): ChainableCommander - zrevrangebyscore
Buffer(key: RedisKey, max: string | number, min: string | number, offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander - zrevrangebyscore
Buffer(key: RedisKey, max: string | number, min: string | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): ChainableCommander - zrevrangebyscore
Buffer(key: RedisKey, max: string | number, min: string | number, withscores: "WITHSCORES", offsetCountToken: "LIMIT", offset: string | number, count: string | number, callback?: Callback<Buffer[]>): ChainableCommander
Parameters
key: RedisKey
max: string | number
min: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
max: string | number
min: string | number
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
max: string | number
min: string | number
withscores: "WITHSCORES"
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
Parameters
key: RedisKey
max: string | number
min: string | number
withscores: "WITHSCORES"
offsetCountToken: "LIMIT"
offset: string | number
count: string | number
Optional callback: Callback<Buffer[]>
Returns ChainableCommander
zrevrank
- zrevrank(key: RedisKey, member: string | number | Buffer, callback?: Callback<number>): ChainableCommander
- \n
Determine the index of a member in a sorted set, with scores ordered from high to low
\n- \n
- group: sorted-set \n
- complexity: O(log(N)) \n
- since: 2.0.0 \n
Parameters
key: RedisKey
member: string | number | Buffer
Optional callback: Callback<number>
Returns ChainableCommander
zscan
- zscan(key: RedisKey, cursor: string | number, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- zscan(key: RedisKey, cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- zscan(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- zscan(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: string, elements: string[]]>): ChainableCommander
- \n
Incrementally iterate sorted sets elements and associated scores
\n- \n
- group: sorted-set \n
- complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.. \n
- since: 2.8.0 \n
Parameters
key: RedisKey
cursor: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
Parameters
key: RedisKey
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: string, elements: string[]]>
Returns ChainableCommander
zscan
- zscan
Buffer(key: RedisKey, cursor: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander - zscan
Buffer(key: RedisKey, cursor: string | number, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander - zscan
Buffer(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander - zscan
Buffer(key: RedisKey, cursor: string | number, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: string | number, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): ChainableCommander
Parameters
key: RedisKey
cursor: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
Parameters
key: RedisKey
cursor: string | number
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
Parameters
key: RedisKey
cursor: string | number
patternToken: "MATCH"
pattern: string
countToken: "COUNT"
count: string | number
Optional callback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns ChainableCommander
zscore
- zscore(key: RedisKey, member: string | number | Buffer, callback?: Callback<string>): ChainableCommander
- \n
Get the score associated with the given member in a sorted set
\n- \n
- group: sorted-set \n
- complexity: O(1) \n
- since: 1.2.0 \n
Parameters
key: RedisKey
member: string | number | Buffer
Optional callback: Callback<string>
Returns ChainableCommander
zscore
- zscore
Buffer(key: RedisKey, member: string | number | Buffer, callback?: Callback<Buffer>): ChainableCommander
Parameters
key: RedisKey
member: string | number | Buffer
Optional callback: Callback<Buffer>
Returns ChainableCommander
zunion
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[]]): ChainableCommander
- zunion(...args: [numkeys: string | number, keys: RedisKey[]]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]): ChainableCommander
- zunion(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): ChainableCommander
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): ChainableCommander
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): ChainableCommander
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): ChainableCommander
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): ChainableCommander
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): ChainableCommander
- zunion(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...args: RedisValue[]]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]): ChainableCommander
- zunion(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): ChainableCommander
- \n
Add multiple sorted sets
\n- \n
- group: sorted-set \n
- complexity: O(N)+O(M*log(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set. \n
- since: 6.2.0 \n
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<string[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns ChainableCommander
zunion
- zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[]]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[]]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[]]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]): ChainableCommander - zunion
Buffer(...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]): ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", withscores: "WITHSCORES"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES", callback: Callback<Buffer[]>]
Returns ChainableCommander
Parameters
Rest ...args: [numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", withscores: "WITHSCORES"]
Returns ChainableCommander
zunionstore
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], callback: Callback<number>]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[]]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[]]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], callback: Callback<number>]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[]]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]): ChainableCommander
- zunionstore(...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]): ChainableCommander
- \n
Add multiple sorted sets and store the resulting sorted set in a new key
\n- \n
- group: sorted-set \n
- complexity: O(N)+O(M log(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set. \n
- since: 2.0.0 \n
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[]]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM", callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", sum: "SUM"]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN", callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", min: "MIN"]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX", callback: Callback<number>]
Returns ChainableCommander
Parameters
Rest ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[], aggregate: "AGGREGATE", max: "MAX"]
Returns ChainableCommander
Generated using TypeDoc
Interface ClusterOptions
\n
Options for Cluster constructor
\nHierarchy
- CommanderOptions
- ClusterOptions
Index
Properties
- auto
Pipelining Ignored Commands - cluster
Retry Strategy - dns
Lookup - enable
Auto Pipelining - enable
Offline Queue - enable
Ready Check - key
Prefix - lazy
Connect - max
Redirections - nat
Map - redis
Options - resolve
Srv - retry
Delay On Cluster Down - retry
Delay On Failover - retry
Delay On Moved - retry
Delay On Try Again - scale
Reads - scripts
- sharded
Subscribers - show
Friendly Error Stack - slots
Refresh Interval - slots
Refresh Timeout - useSRVRecords
Properties
Optional auto
auto
\n
See Redis class.
\nOptional cluster
cluster
Type declaration
- (times: number, reason?: Error): number | void
- \n
See "Quick Start" section.
\nParameters
times: number
Optional reason: Error
Returns number | void
Optional dns
\n
Hostnames will be resolved to IP addresses via this function.\nThis is needed when the addresses of startup nodes are hostnames instead\nof IPs.
\nYou may provide a custom lookup function when you want to customize\nthe cache behavior of the default function.
Optional enable
enable
\n
See Redis class.
\nOptional enable
enable
\n
See Redis class.
\nOptional enable
enable
\n
When enabled, ioredis only emits "ready" event when CLUSTER INFO\ncommand reporting the cluster is ready for handling commands.
Optional key
key
Optional lazy
lazy
\n
By default, When a new Cluster instance is created,\nit will connect to the Redis cluster automatically.\nIf you want to keep the instance disconnected until the first command is called,\nset this option to true.
Optional max
max
\n
When a MOVED or ASK error is received, client will redirect the\ncommand to another node.\nThis option limits the max redirections allowed to send a command.
\nOptional nat
Optional redis
redis
\n
Passed to the constructor of Redis
Optional resolve
\n
SRV records will be resolved via this function.
\nYou may provide a custom resolveSrv function when you want to customize\nthe cache behavior of the default function.
Optional retry
retry
\n
When a CLUSTERDOWN error is received, client will retry\nif retryDelayOnClusterDown is valid delay time (in ms).
Optional retry
retry
\n
When an error is received when sending a command (e.g.\n"Connection is closed." when the target Redis node is down), client will retry\nif retryDelayOnFailover is valid delay time (in ms).
Optional retry
retry
\n
By default, this value is 0, which means when a MOVED error is received,\nthe client will resend the command instantly to the node returned together with\nthe MOVED error. However, sometimes it takes time for a cluster to become\nstate stabilized after a failover, so adding a delay before resending can\nprevent a ping pong effect.
Optional retry
retry
\n
When a TRYAGAIN error is received, client will retry\nif retryDelayOnTryAgain is valid delay time (in ms).
Optional scale
\n
Scale reads to the node with the specified role.
\nOptional scripts
scripts?: Record<string, { lua: string; numberOfKeys?: number; readOnly?: boolean }>
\n
Custom LUA commands
\nOptional sharded
sharded
\n
Use sharded subscribers instead of a single subscriber.
\nIf sharded subscribers are used, then one additional subscriber connection per master node\nis established. If you don't plan to use SPUBLISH/SSUBSCRIBE, then this should be disabled.
\nOptional show
show
Optional slots
slots
\n
The milliseconds between every automatic slots refresh.
\nOptional slots
slots
\n
The milliseconds before a timeout occurs while refreshing\nslots from the cluster.
\nOptional useSRVRecords
useSRVRecords?: boolean
\n
Discover nodes using SRV records
\nGenerated using TypeDoc
Interface CommonRedisOptions
Hierarchy
- CommanderOptions
- CommonRedisOptions
Index
Properties
- Connector
- auto
Pipelining Ignored Commands - auto
Resend Unfulfilled Commands - auto
Resubscribe - blocking
Timeout - blocking
Timeout Grace - client
Info Tag - command
Queue - command
Timeout - connect
Timeout - connection
Name - db
- disable
Client Info - enable
Auto Pipelining - enable
Offline Queue - enable
Ready Check - keep
Alive - key
Prefix - lazy
Connect - max
Loading Retry Time - max
Retries Per Request - monitor
- no
Delay - offline
Queue - password
- read
Only - reconnect
On Error - retry
Strategy - scripts
- show
Friendly Error Stack - socket
Timeout - string
Numbers - username
Properties
Optional Connector
Connector?: ConnectorConstructor
Optional auto
auto
Optional auto
auto
\n
Whether or not to resend unfulfilled commands on reconnect.\nUnfulfilled commands are most likely to be blocking commands such as brpop or blpop.
Optional auto
auto
\n
When the client reconnects, channels subscribed in the previous connection will be\nresubscribed automatically if autoResubscribe is true.
Optional blocking
blocking
\n
Enables client-side timeout protection for blocking commands when set\nto a positive number. If blockingTimeout is undefined, 0, or\nnegative (e.g. -1), the protection is disabled and no client-side\ntimers are installed for blocking commands.
Optional blocking
blocking
\n
Grace period (ms) added to blocking command timeouts. Only used when\nblockingTimeout is a positive number. Defaults to 100ms.
Optional client
client
\n
Tag to append to the library name in CLIENT SETINFO (ioredis(tag)).
\nOptional command
command
Optional command
command
\n
If a command does not return a reply within a set number of milliseconds,\na "Command timed out" error will be thrown.
\nOptional connect
connect
\n
How long the client will wait before killing a socket due to inactivity during initial connection.
\nOptional connection
connection
\n
Set the name of the connection to make it easier to identity the connection\nin client list.
\nOptional db
db?: number
\n
Database index to use.
\nOptional disable
disable
\n
If true, skips setting library info via CLIENT SETINFO.
\nOptional enable
enable
Optional enable
enable
\n
By default, if the connection to Redis server has not been established, commands are added to a queue\nand are executed once the connection is "ready" (when enableReadyCheck is true, "ready" means\nthe Redis server has loaded the database from disk, otherwise means the connection to the Redis\nserver has been established). If this option is false, when execute the command when the connection\nisn't ready, an error will be returned.
Optional enable
enable
\n
The client will sent an INFO command to check whether the server is still loading data from the disk (\nwhich happens when the server is just launched) when the connection is established, and only wait until\nthe loading process is finished before emitting the ready event.
Optional keep
keep
\n
Enable/disable keep-alive functionality.
\nOptional key
key
Optional lazy
lazy
\n
When a Redis instance is initialized, a connection to the server is immediately established. Set this to\ntrue will delay the connection to the server until the first command is sent or redis.connect() is called\nexplicitly. When redis.connect() is called explicitly, a Promise is returned, which will be resolved\nwhen the connection is ready or rejected when it fails. The rejection should be handled by the user.
Optional max
max
Optional max
max
\n
The commands that don't get a reply due to the connection to the server is lost are\nput into a queue and will be resent on reconnect (if allowed by the retryStrategy option).\nThis option is used to configure how many reconnection attempts should be allowed before\nthe queue is flushed with a MaxRetriesPerRequestError error.\nSet this options to null instead of a number to let commands wait forever\nuntil the connection is alive again.
Optional monitor
monitor?: boolean
\n
This option is used internally when you call redis.monitor() to tell Redis\nto enter the monitor mode when the connection is established.
Optional no
no
\n
Enable/disable the use of Nagle's algorithm.
\nOptional offline
offline
Optional password
password?: string
\n
If set, client will send AUTH command with the value of this option when connected.
\nOptional read
read
Optional reconnect
reconnect
\n
Whether or not to reconnect on certain Redis errors.\nThis options by default is null, which means it should never reconnect on Redis errors.\nYou can pass a function that accepts an Redis error, and returns:
- \n
trueor1to trigger a reconnection. \nfalseor0to not reconnect. \n2to reconnect and resend the failed command (who triggered the error) after reconnection. \n
Optional retry
retry
Type declaration
- (times: number): number | void
Parameters
times: number
Returns number | void
Optional scripts
scripts?: Record<string, { lua: string; numberOfKeys?: number; readOnly?: boolean }>
Optional show
show
Optional socket
socket
\n
If the socket does not receive data within a set number of milliseconds:
\n- \n
- the socket is considered "dead" and will be destroyed \n
- the client will reject any running commands (altought they might have been processed by the server) \n
- the reconnect strategy will kick in (depending on the configuration) \n
Optional string
string
\n
When enabled, numbers returned by Redis will be converted to JavaScript strings instead of numbers.\nThis is necessary if you want to handle big numbers (above Number.MAX_SAFE_INTEGER === 2^53).
Optional username
username?: string
\n
If set, client will send AUTH command with the value of this option as the first argument when connected.\nThis is supported since Redis 6.
\nGenerated using TypeDoc
Interface SentinelAddress
Generated using TypeDoc
Interface SentinelConnectionOptions
Hierarchy
- SentinelConnectionOptions
Index
Properties
Optional connect
connect
Optional disconnect
disconnect
Optional enableTLSFor
enableTLSFor
Optional failover
failover
Optional name
name?: string
\n
Master group name of the Sentinel
\nOptional nat
Optional preferred
preferred
Optional role
role?: "master" | "slave"
Optional sentinel
sentinel
Optional sentinel
sentinel
Optional sentinel
sentinel
Optional sentinel
sentinel
Type declaration
- (retryAttempts: number): number | void
Parameters
retryAttempts: number
Returns number | void
Optional sentinel
sentinel
Type declaration
- (retryAttempts: number): number | void
Parameters
retryAttempts: number
Returns number | void
Optional sentinelTLS
sentinelTLS?: ConnectionOptions
Optional sentinel
sentinel
Optional sentinels
Optional tls
tls?: ConnectionOptions
Optional update
update
Generated using TypeDoc
Client for the official Redis Cluster
\n