Node-Redis



node-redis is a modern, high performance Redis client for Node.js.

How do I Redis?

Learn for free at Redis University

Build faster with the Redis Launchpad

Try the Redis Cloud

Dive in developer tutorials

Join the Redis community

Work at Redis

Installation

Start a redis via docker:

docker run -p 6379:6379 -d redis:8.0-rc1

To install node-redis, simply:

npm install redis

Packages

| Name | Description |
| ---------------------------------------------- | ------------------------------------------------------------------------------------------- |
| <code class="ra0-md-code">redis</code> | The client with all the "redis-stack" modules |
| <code class="ra0-md-code">@redis/client</code> | The base clients (i.e RedisClient, RedisCluster, etc.) |
| <code class="ra0-md-code">@redis/bloom</code> | Redis Bloom commands |
| <code class="ra0-md-code">@redis/json</code> | Redis JSON commands |
| <code class="ra0-md-code">@redis/search</code> | RediSearch commands |
| <code class="ra0-md-code">@redis/time-series</code> | Redis Time-Series commands |
| <code class="ra0-md-code">@redis/entraid</code> | Secure token-based authentication for Redis clients using Microsoft Entra ID |

> Looking for a high-level library to handle object mapping?
> See redis-om-node!

Usage

Basic Example

import { createClient } from "redis";

const client = await createClient()
  .on("error", (err) => console.log("Redis Client Error", err))
  .connect();

await client.set("key", "value");
const value = await client.get("key");
console.log(value); // 'value'
client.destroy();

The same example in CommonJS (for example node example.js without "type": "module" in package.json):

const { createClient } = require("redis");

async function main() {
  const client = await createClient()
    .on("error", (err) => console.log("Redis Client Error", err))
    .connect();

  await client.set("key", "value");
  const value = await client.get("key");
  console.log(value); // 'value'
  client.destroy();
}

main().catch(console.error);

The above code connects to localhost on port 6379. To connect to a different host or port, use a connection string in
the format redis[s]://[[username][:password]@][host][:port][/db-number]:

createClient({
  url: "redis://alice:foobared@awesome.redis.server:6380",
});

You can also use discrete parameters, UNIX sockets, and even TLS to connect. Details can be found in
the client configuration guide.

To check if the client is connected and ready to send commands, use client.isReady which returns a boolean.
client.isOpen is also available. This returns true when the client's underlying socket is open, and false when it
isn't (for example when the client is still connecting or reconnecting after a network error).

Redis Commands

There is built-in support for all of the out-of-the-box Redis commands. They are exposed
using the raw Redis command names (HSET, HGETALL, etc.) and a friendlier camel-cased version (hSet, hGetAll,
etc.):

// raw Redis commands
await client.HSET("key", "field", "value");
await client.HGETALL("key");

// friendly JavaScript commands
await client.hSet("key", "field", "value");
await client.hGetAll("key");

Modifiers to commands are specified using a JavaScript object:

await client.set("key", "value", {
  EX: 10,
  NX: true,
});

Replies will be transformed into useful data structures:

await client.hGetAll("key"); // { field1: 'value1', field2: 'value2' }
await client.hVals("key"); // ['value1', 'value2']

Buffers are supported as well:

const client = createClient().withTypeMapping({
  [RESP_TYPES.BLOB_STRING]: Buffer
});

await client.hSet("key", "field", Buffer.from("value")); // 'OK'
await client.hGet("key", "field"); // { field: <Buffer 76 61 6c 75 65> }

For commands that return serialized binary payloads, such as DUMP, map blob strings to Buffer before using the result with commands like RESTORE:

const binaryClient = createClient().withTypeMapping({
  [RESP_TYPES.BLOB_STRING]: Buffer
});

const dump = await binaryClient.dump("source");
await binaryClient.restore("destination", 0, dump);

Unsupported Redis Commands

If you want to run commands and/or use arguments that Node Redis doesn't know about (yet!) use .sendCommand():

await client.sendCommand(["SET", "key", "value", "NX"]); // 'OK'

await client.sendCommand(["HGETALL", "key"]); // ['key1', 'field1', 'key2', 'field2']

_Note: the API is different when using a cluster._

Transactions (Multi/Exec)

Start a transaction by calling .multi(), then chaining your commands. When
you're done, call .exec() and you'll get an array back with your results:

await client.set("another-key", "another-value");

const [setKeyReply, otherKeyValue] = await client
  .multi()
  .set("key", "value")
  .get("another-key")
  .exec(); // ['OK', 'another-value']

You can also watch keys by calling
.watch(). Your transaction will abort if any of the watched keys change.

Blocking Commands

In v4, RedisClient had the ability to create a pool of connections using an "Isolation Pool" on top of the "main"
connection. However, there was no way to use the pool without a "main" connection:

const client = await createClient()
  .on("error", (err) => console.error(err))
  .connect();

await client.ping(client.commandOptions({ isolated: true }));

In v5 we've extracted this pool logic into its own class—RedisClientPool:

const pool = await createClientPool()
  .on("error", (err) => console.error(err))
  .connect();

await pool.ping();

Pub/Sub

See the Pub/Sub overview.

Scan Iterator

<code class="ra0-md-code">SCAN</code> results can be looped over
using async iterators:

for await (const keys of client.scanIterator()) {
  console.log(keys, await client.mGet(keys));
}

This works with HSCAN, SSCAN, and ZSCAN too:

for await (const { field, value } of client.hScanIterator("hash")) {
}
for await (const member of client.sScanIterator("set")) {
}
for await (const { score, value } of client.zScanIterator("sorted-set")) {
}

You can override the default options by providing a configuration object:

client.scanIterator({
  TYPE: "string", // `SCAN` only
  MATCH: "pattern*",
  COUNT: 100,
});

Compare-and-Set/Delete (CAS/CAD)

> Note: CAS/CAD operations were introduced in Redis 8.4

// Conditionally update only if the current value matches
await client.set("key", "new-value", { condition: "IFEQ", matchValue: "old-value" });

// Conditionally delete only if the current value matches
await client.delEx("key", { condition: "IFEQ", matchValue: "expected-value" });

Local Digest

> Note: This feature requires the optional @node-rs/xxhash peer dependency.

The digest helper computes an XXH3 64-bit hash locally, matching what Redis computes via the DIGEST command. This is useful for CAS/CAD operations with large values where comparing the full value would be inefficient.

npm install @node-rs/xxhash

import { digest } from "redis";

const hash = await digest("my-value");

await client.set("key", "new-value", { condition: "IFDEQ", matchValue: hash });

Disconnecting

The QUIT command has been deprecated in Redis 7.2 and should now also be considered deprecated in Node-Redis. Instead
of sending a QUIT command to the server, the client can simply close the network connection.

client.QUIT/quit() is replaced by client.close(). and, to avoid confusion, client.disconnect() has been renamed to
client.destroy().

client.destroy();

Client Side Caching

Node Redis v5 adds support for Client Side Caching, which enables clients to cache query results locally. The Redis server will notify the client when cached results are no longer valid.

// Enable client side caching with RESP3
const client = createClient({
  RESP: 3,
  clientSideCache: {
    ttl: 0,             // Time-to-live (0 = no expiration)
    maxEntries: 0,      // Maximum entries (0 = unlimited)
    evictPolicy: "LRU"  // Eviction policy: "LRU" or "FIFO"
  }
});

See the V5 documentation for more details and advanced usage.

Auto-Pipelining

Node Redis will automatically pipeline requests that are made during the same "tick".

client.set("Tm9kZSBSZWRpcw==", "users:1");
client.sAdd("users:1:tokens", "Tm9kZSBSZWRpcw==");

Of course, if you don't do something with your Promises you're certain to
get unhandled Promise exceptions. To take
advantage of auto-pipelining and handle your Promises, use Promise.all().

await Promise.all([
  client.set("Tm9kZSBSZWRpcw==", "users:1"),
  client.sAdd("users:1:tokens", "Tm9kZSBSZWRpcw=="),
]);

Sentinel

Look at the sentinel section to figure out how to use this library with sentinels.

Programmability

See the Programmability overview.

Clustering

Check out the Clustering Guide when using Node Redis to connect to a Redis Cluster.

OpenTelemetry

OpenTelemetry Metrics Instrumentation

import { createClient, OpenTelemetry } from "redis";

OpenTelemetry.init({
  metrics: {
    enabled: true
  }
});

const client = createClient()

await client.connect();
// ... use the client as usual

Important: Initializing OpenTelemetry only enables node-redis metrics instrumentation and requires both @opentelemetry/api and an OpenTelemetry SDK configured in your application.

Important: Initialize OpenTelemetry before creating Redis clients.
For SDK/provider/exporter setup, verification, and advanced configuration, see:

• OpenTelemetry Metrics docs
• OpenTelemetry Metrics example

Diagnostics Channel

Node Redis publishes telemetry through Node.js <code class="ra0-md-code">diagnostics_channel</code>, enabling APM tools and custom instrumentation to observe commands, connections, and internal events. See the Diagnostics Channel guide for the full channel reference and usage examples.

Events

The Node Redis client class is an Nodejs EventEmitter and it emits an event each time the network status changes:

| Name | When | Listener arguments |
| ----------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------- |
| connect | Initiating a connection to the server | _No arguments_ |
| ready | Client is ready to use | _No arguments_ |
| end | Connection has been closed (via .close() or .destroy()) | _No arguments_ |
| error | An error has occurred—usually a network issue such as "Socket closed unexpectedly" | (error: Error) |
| reconnecting | Client is trying to reconnect to the server | _No arguments_ |
| sharded-channel-moved | See here | See here |
| invalidate | Client Tracking is on with emitInvalidate and a key is invalidated | (key: RedisItem | null) |

> :warning: You MUST listen to error events. If a client doesn't have at least one error listener registered and
> an error occurs, that error will be thrown and the Node.js process will exit. See the > <code class="ra0-md-code">EventEmitter</code> docs for more details.

> The client will not emit any other events beyond those listed above.

Supported Redis versions

Node Redis is supported with the following versions of Redis:

See Supported Redis Versions.

Migration

• From V3 to V4
• From V4 to V5
• V5

Contributing

If you'd like to contribute, check out the contributing guide.

Thank you to all the people who already contributed to Node Redis!


License

This repository is licensed under the "MIT" license. See LICENSE.