{
  "id": "nodejs",
  "title": "Redis pub/sub with node-redis",
  "url": "https://redis.io/docs/latest/develop/use-cases/pub-sub/nodejs/",
  "summary": "Implement Redis pub/sub messaging in Node.js with node-redis",
  "tags": [
    "docs",
    "develop",
    "stack",
    "oss",
    "rs",
    "rc"
  ],
  "last_updated": "2026-05-14T08:58:05-05:00",
  "children": [],
  "page_type": "content",
  "content_hash": "e1f1f34e7472f14484ec9dbc40767f4983f707330d9443e125737dee059d6451",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "This guide shows you how to implement a Redis-backed pub/sub broadcaster in Node.js with [`node-redis`](https://redis.io/docs/latest/develop/clients/nodejs). It includes a small local web server built with the Node.js standard `http` module so you can publish messages to named channels, add and remove subscribers live, and watch Redis fan out each message to every interested listener."
    },
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "Pub/sub lets your application broadcast events — chat messages, cache invalidation signals, presence updates, notifications — to many consumers without per-pair wiring. The publisher names a *channel*; every client currently subscribed to that channel receives the message, in publish order, with sub-millisecond fan-out.\n\nThat gives you:\n\n* Many-to-many event delivery with no message storage cost in Redis\n* Exact-match subscriptions (`SUBSCRIBE orders:new`) for known topics\n* Pattern subscriptions (`PSUBSCRIBE notifications:*`) for whole topic hierarchies\n* Live server-side introspection through `PUBSUB CHANNELS`, `PUBSUB NUMSUB`, and `PUBSUB NUMPAT`\n* At-most-once delivery: subscribers that are offline when a message is published miss it, so durable state should live in keys or a Stream, not in the pub/sub channel itself\n\nIn this example, the publisher side calls `PUBLISH` with a JSON-encoded body and counts how many subscribers Redis reported delivering to. Each in-process subscriber owns its own Redis connection (obtained via `client.duplicate()`) and a listener callback that handles every delivered message."
    },
    {
      "id": "how-it-works",
      "title": "How it works",
      "role": "content",
      "text": "The flow looks like this:\n\n1. The application calls `hub.subscribe(name, channels)` or `hub.psubscribe(name, patterns)`\n2. The helper duplicates the hub's Redis client to get a dedicated subscribe-mode connection, then binds each target to a dispatch callback via `client.subscribe(channel, listener)` or `client.pSubscribe(pattern, listener)`\n3. The application (or another process) calls `hub.publish(channel, message)`\n4. Redis fans the message out over every subscribing client's open socket\n5. Each subscriber's listener wraps the raw message as a `ReceivedMessage`, appends it to a per-subscriber ring buffer, and invokes the optional callback\n6. The publisher receives the integer subscriber count back from `PUBLISH`, which is the number of clients Redis delivered to right then\n\nPattern subscriptions match channels by glob (`*`, `?`, `[abc]`). A single message that matches both an exact subscription and a pattern subscription is delivered twice — once to the exact subscriber and once to the pattern subscriber."
    },
    {
      "id": "the-pub-sub-hub-helper",
      "title": "The pub/sub hub helper",
      "role": "content",
      "text": "The `RedisPubSubHub` class wraps the publish, subscribe, and introspection operations\n([source](https://github.com/redis/docs/blob/main/content/develop/use-cases/pub-sub/nodejs/pubsub_hub.js)):\n\n[code example]"
    },
    {
      "id": "data-model",
      "title": "Data model",
      "role": "content",
      "text": "Pub/sub has no Redis keyspace footprint of its own — channels are server-side routing entries, not stored values. The hub keeps its own bookkeeping in process memory:\n\n[code example]\n\nThe implementation uses:\n\n* [`PUBLISH`](https://redis.io/docs/latest/commands/publish) to fan a JSON-encoded message out to every subscriber of a channel\n* [`SUBSCRIBE`](https://redis.io/docs/latest/commands/subscribe) for exact-match subscribers\n* [`PSUBSCRIBE`](https://redis.io/docs/latest/commands/psubscribe) for glob-style pattern subscribers\n* [`PUBSUB CHANNELS`](https://redis.io/docs/latest/commands/pubsub-channels) to list the channels with at least one active exact-match subscriber\n* [`PUBSUB NUMSUB`](https://redis.io/docs/latest/commands/pubsub-numsub) to count subscribers per channel\n* [`PUBSUB NUMPAT`](https://redis.io/docs/latest/commands/pubsub-numpat) to count active pattern subscriptions server-wide\n* node-redis 5.x's listener-based `subscribe` / `pSubscribe` API to dispatch messages without writing a polling loop by hand"
    },
    {
      "id": "publishing-messages",
      "title": "Publishing messages",
      "role": "content",
      "text": "`publish()` JSON-encodes the message body, calls `PUBLISH`, and updates the per-channel publish counter:\n\n[code example]\n\nThe integer returned by `PUBLISH` is what Redis itself reports — the number of subscribers (direct and pattern) that received the message in that call. It's a useful sanity check that the channel name is actually being listened to: a steady stream of `0`s means you have a typo somewhere or your subscriber crashed."
    },
    {
      "id": "subscribing-to-channels",
      "title": "Subscribing to channels",
      "role": "content",
      "text": "`subscribe()` creates a named in-process `Subscription` that owns its own connection and listener:\n\n[code example]\n\nInside `Subscription._connect`, the helper duplicates the hub's client to get a dedicated connection and registers a listener for each target:\n\n[code example]\n\nA few details matter here:\n\n* **Each `Subscription` owns its own connection.** In node-redis 5.x, a client used for `subscribe` / `pSubscribe` is in subscribe-only mode for the lifetime of those bindings — regular commands (`GET`, `SET`, …) on the same client will throw. The hub keeps one regular client for `PUBLISH` and the `PUBSUB *` introspection commands; every subscription duplicates it to get a fresh socket.\n* **The listener receives `(message, channel)` already decoded as strings.** Pass `bufferMode = true` as the third argument if you need raw `Buffer`s instead — the demo doesn't.\n* **Closing one subscription doesn't affect another.** Each `Subscription.close()` unsubscribes its own connection and then `quit()`s it; the hub's regular client and every other subscription keep going."
    },
    {
      "id": "pattern-subscriptions-with-psubscribe",
      "title": "Pattern subscriptions with PSUBSCRIBE",
      "role": "content",
      "text": "`psubscribe()` works the same way but routes messages through `PSUBSCRIBE` so each binding is a glob, not a literal channel name:\n\n[code example]\n\nFor pattern subscriptions the dispatch callback needs to know both the matched channel and the originating pattern. node-redis only delivers `(message, channel)` to the listener, so the helper binds the pattern explicitly via a closure:\n\n[code example]\n\nThat distinction is useful for routing: a pattern subscriber can do one thing for the whole hierarchy (e.g., increment a counter) and dispatch on the specific channel within its callback (e.g., \"invalidate this region's cache\")."
    },
    {
      "id": "inspecting-active-subscribers",
      "title": "Inspecting active subscribers",
      "role": "content",
      "text": "Redis exposes a small set of pub/sub introspection commands that report on subscriber state without traversing any keyspace:\n\n[code example]\n\n`PUBSUB CHANNELS` only reports channels with at least one exact-match subscriber — pattern subscribers do not appear here. That's a deliberate Redis design choice: a glob like `*` would otherwise show up as a subscriber to every conceivable channel. `PUBSUB NUMPAT` covers the pattern side as a single global count."
    },
    {
      "id": "stats-and-history",
      "title": "Stats and history",
      "role": "content",
      "text": "`stats()` reports publish and receive counters plus the size of the subscription registry:\n\n[code example]\n\n`delivered_total` is what Redis itself counted; `received_total` is what this process's in-memory subscribers saw. In a single-process demo they should track each other closely — a sustained divergence usually means a listener threw, or a subscriber crashed while a publisher kept publishing. (Pub/sub is at-most-once: if your subscriber wasn't connected at publish time, the message is gone.)"
    },
    {
      "id": "prerequisites",
      "title": "Prerequisites",
      "role": "content",
      "text": "* Redis 6.2 or later running locally on the default port (6379). Earlier versions still work for plain `PUBLISH`/`SUBSCRIBE`; `PUBSUB NUMPAT` is older than that.\n* Node.js 18 or later.\n* The [`node-redis`](https://github.com/redis/node-redis) client at version 5.x. The demo's `package.json` declares `\"redis\": \"^5.0.0\"`."
    },
    {
      "id": "running-the-demo",
      "title": "Running the demo",
      "role": "content",
      "text": ""
    },
    {
      "id": "get-the-source-files",
      "title": "Get the source files",
      "role": "content",
      "text": "The demo consists of three files. Download them from the [`nodejs` source folder](https://github.com/redis/docs/tree/main/content/develop/use-cases/pub-sub/nodejs) on GitHub, or grab them with `curl`:\n\n[code example]"
    },
    {
      "id": "start-the-demo-server",
      "title": "Start the demo server",
      "role": "content",
      "text": "From that directory:\n\n[code example]\n\nYou should see:\n\n[code example]\n\nOpen [http://127.0.0.1:8096](http://127.0.0.1:8096) in a browser. You can:\n\n* Publish messages of any text to any channel name in any batch size.\n* Add named subscribers that listen on either a specific channel (`orders:new`) or a glob pattern (`notifications:*`). A single subscriber can listen on multiple targets — enter them comma-separated.\n* Watch each subscriber's incoming-message panel update every 800 ms.\n* See the server-side view: `PUBSUB CHANNELS` lists exact-match channels with subscribers, `PUBSUB NUMSUB` gives per-channel counts, and `PUBSUB NUMPAT` counts active pattern subscriptions.\n* Click **Reset** to drop every subscription, zero the counters, and re-seed the three default subscribers.\n\nIf your Redis server is running elsewhere, start the demo with `--redis-host` and `--redis-port`. Use `--port` to change the HTTP listen port."
    },
    {
      "id": "production-usage",
      "title": "Production usage",
      "role": "content",
      "text": ""
    },
    {
      "id": "pub-sub-is-at-most-once-pair-it-with-durable-state-if-you-need-replay",
      "title": "Pub/sub is at-most-once — pair it with durable state if you need replay",
      "role": "content",
      "text": "A subscriber that's offline when a message is published misses it permanently. For events you can't afford to lose, write the durable record (the order row, the cache key version, the audit log entry) to its primary store, then `PUBLISH` a notification so live consumers can pick it up immediately. On reconnect, consumers reconcile by reading the durable store, not by waiting for missed pub/sub messages. If you actually need replay or at-least-once delivery, switch to [Redis Streams](https://redis.io/docs/latest/develop/data-types/streams) with consumer groups."
    },
    {
      "id": "use-a-dedicated-connection-per-subscriber",
      "title": "Use a dedicated connection per subscriber",
      "role": "content",
      "text": "A node-redis client used for `subscribe` / `pSubscribe` is in subscribe-only mode for the lifetime of those bindings: ordinary commands (`GET`, `HSET`, …) on the same client throw. Always duplicate the client — as the helper does with `client.duplicate()` — so each subscriber has its own socket. Sharing one subscriber socket across unrelated callers couples their lifetimes (unsubscribing one drops the channel for the others) and serialises every listener on a single connection's event loop."
    },
    {
      "id": "choose-a-topic-naming-convention-up-front",
      "title": "Choose a topic naming convention up front",
      "role": "content",
      "text": "A flat namespace gets ugly fast — `email`, `email_high_priority`, `email_high_priority_billing`. Pick a colon-separated hierarchy (`notifications:billing:invoice`, `cache:invalidate:products:p-001`) so consumers can subscribe at the right level: a billing service uses `notifications:billing:*`, the audit logger uses `notifications:*`. Glob patterns are evaluated for every published message, so don't go wild with multiple wildcards on hot paths — `*:*:*` matches everything and costs more than a flat `notifications:*` would."
    },
    {
      "id": "don-t-do-heavy-work-in-the-listener-callback",
      "title": "Don't do heavy work in the listener callback",
      "role": "content",
      "text": "node-redis dispatches incoming messages on the event loop. If your listener does synchronous heavy work (big JSON parse, sync crypto, blocking computation), the next message waits behind it and the subscriber's effective throughput drops to whatever the listener's latency is. For heavier work, the listener should push the message onto a worker queue or hand it off to an async pipeline — for true durable handoff, write it onto a [Redis Streams](https://redis.io/docs/latest/develop/data-types/streams) consumer group."
    },
    {
      "id": "tune-the-subscriber-buffer-for-your-traffic-shape",
      "title": "Tune the subscriber buffer for your traffic shape",
      "role": "content",
      "text": "The demo caps each subscriber's in-memory message buffer at 50. That's right for showing the recent activity in a UI, but a real subscriber typically processes each message and discards it — the buffer is only there for human inspection. If you keep a buffer, make sure it's bounded; an unbounded array on a chatty pattern subscriber will eventually OOM the Node process."
    },
    {
      "id": "reconnection-and-listener-re-registration",
      "title": "Reconnection and listener re-registration",
      "role": "content",
      "text": "node-redis 5.x reconnects automatically and re-registers active `subscribe` / `pSubscribe` listeners after the new connection is up, so you don't have to write the recovery path by hand. What it doesn't replay is messages that arrived during the disconnect — those are gone. If your consumers can't tolerate those gaps, treat pub/sub as the live-notification layer and reconcile from a durable source on every reconnect."
    },
    {
      "id": "sharded-pub-sub-on-a-redis-cluster",
      "title": "Sharded pub/sub on a Redis Cluster",
      "role": "content",
      "text": "On a Redis Cluster, plain `PUBLISH` fans every message out to every node via the cluster bus, which becomes a hotspot at high throughput. Redis 7.0 added [sharded pub/sub](https://redis.io/docs/latest/develop/pubsub#sharded-pubsub): channels are hashed to slots, and `SPUBLISH` / `SSUBSCRIBE` only touch the shard that owns the slot. If you're scaling pub/sub on a cluster, prefer the sharded commands and pick channel names whose hash distribution matches your traffic."
    },
    {
      "id": "inspect-pub-sub-state-directly-in-redis",
      "title": "Inspect pub/sub state directly in Redis",
      "role": "content",
      "text": "Because pub/sub has no keyspace, `KEYS`/`SCAN` won't show you anything. Use the introspection commands instead:\n\n[code example]\n\n`redis-cli` in subscribe mode only exits with `Ctrl-C` — it can't issue any other commands while subscribed."
    },
    {
      "id": "learn-more",
      "title": "Learn more",
      "role": "related",
      "text": "This example uses the following Redis commands:\n\n* [`PUBLISH`](https://redis.io/docs/latest/commands/publish) to fan a message out to every subscriber of a channel.\n* [`SUBSCRIBE`](https://redis.io/docs/latest/commands/subscribe) and [`UNSUBSCRIBE`](https://redis.io/docs/latest/commands/unsubscribe) for exact-match topic subscriptions.\n* [`PSUBSCRIBE`](https://redis.io/docs/latest/commands/psubscribe) and [`PUNSUBSCRIBE`](https://redis.io/docs/latest/commands/punsubscribe) for glob-style pattern subscriptions.\n* [`PUBSUB CHANNELS`](https://redis.io/docs/latest/commands/pubsub-channels) to list channels with at least one active exact-match subscriber.\n* [`PUBSUB NUMSUB`](https://redis.io/docs/latest/commands/pubsub-numsub) to count subscribers per named channel.\n* [`PUBSUB NUMPAT`](https://redis.io/docs/latest/commands/pubsub-numpat) to count active pattern subscriptions server-wide.\n\nSee the [`node-redis` documentation](https://redis.io/docs/latest/develop/clients/nodejs) for full client reference, including the [pub/sub guide](https://github.com/redis/node-redis/blob/master/docs/pub-sub.md) covering the listener-based `subscribe` / `pSubscribe` API and reconnection behaviour."
    }
  ],
  "examples": [
    {
      "id": "the-pub-sub-hub-helper-ex0",
      "language": "javascript",
      "code": "const { createClient } = require(\"redis\");\nconst { RedisPubSubHub } = require(\"./pubsub_hub\");\n\nconst client = createClient({ url: \"redis://localhost:6379\" });\nawait client.connect();\nconst hub = new RedisPubSubHub(client);\n\n// Exact-match subscriber\nawait hub.subscribe(\"orders-listener\", [\"orders:new\"]);\n\n// Pattern subscriber covering an entire topic hierarchy\nawait hub.psubscribe(\"all-notifications\", [\"notifications:*\"]);\n\n// Publish — returns Redis' delivered count for this PUBLISH\nconst delivered = await hub.publish(\"orders:new\", { order_id: 42, total: 199.0 });\nconsole.log(`Redis delivered to ${delivered} subscriber(s)`);\n\n// Look at what each subscriber received\nfor (const sub of hub.subscriptions()) {\n  console.log(sub.name, sub.receivedTotal(), \"messages\");\n  for (const message of sub.messages(5)) {\n    console.log(\"  \", message.channel, message.payload);\n  }\n}\n\nawait hub.unsubscribe(\"orders-listener\");\nawait hub.shutdown(); // closes every remaining subscription",
      "section_id": "the-pub-sub-hub-helper"
    },
    {
      "id": "data-model-ex0",
      "language": "text",
      "code": "RedisPubSubHub                          (in-process)\n  subscriptions             Map<string, Subscription>\n  published_total           number\n  delivered_total           number\n  channel_published         Map<channel, count>\n\nSubscription                            (in-process, one per subscriber)\n  name                      string\n  targets                   string[]      (channels or patterns)\n  isPattern                 boolean\n  buffer                    ReceivedMessage[]  (capped, default 50)\n  received                  number\n  client                    RedisClient        (dedicated, subscribe-mode)",
      "section_id": "data-model"
    },
    {
      "id": "publishing-messages-ex0",
      "language": "javascript",
      "code": "async publish(channel, message) {\n  const payload = JSON.stringify(message);\n  const delivered = Number(await this.redis.publish(channel, payload));\n  this._published_total += 1;\n  this._delivered_total += delivered;\n  this._channel_published.set(\n    channel,\n    (this._channel_published.get(channel) || 0) + 1,\n  );\n  return delivered;\n}",
      "section_id": "publishing-messages"
    },
    {
      "id": "subscribing-to-channels-ex0",
      "language": "javascript",
      "code": "async subscribe(name, channels, onMessage = null) {\n  return this._register(name, channels, false, onMessage);\n}",
      "section_id": "subscribing-to-channels"
    },
    {
      "id": "subscribing-to-channels-ex1",
      "language": "javascript",
      "code": "this._client = hubClient.duplicate();\nawait this._client.connect();\nfor (const channel of this.targets) {\n  await this._client.subscribe(channel, (message, channel) =>\n    this._dispatch(message, channel),\n  );\n}",
      "section_id": "subscribing-to-channels"
    },
    {
      "id": "pattern-subscriptions-with-psubscribe-ex0",
      "language": "javascript",
      "code": "await hub.psubscribe(\"all-notifications\", [\"notifications:*\"]);\nawait hub.psubscribe(\"cache-invalidator\", [\"cache:invalidate:*\"]);",
      "section_id": "pattern-subscriptions-with-psubscribe"
    },
    {
      "id": "pattern-subscriptions-with-psubscribe-ex1",
      "language": "javascript",
      "code": "for (const pattern of this.targets) {\n  await this._client.pSubscribe(pattern, (message, channel) => {\n    this._dispatch(message, channel, pattern);\n  });\n}",
      "section_id": "pattern-subscriptions-with-psubscribe"
    },
    {
      "id": "inspecting-active-subscribers-ex0",
      "language": "javascript",
      "code": "await hub.activeChannels();                 // PUBSUB CHANNELS *\nawait hub.channelSubscriberCounts(channels); // PUBSUB NUMSUB ch1 ch2 ...\nawait hub.patternSubscriberCount();          // PUBSUB NUMPAT",
      "section_id": "inspecting-active-subscribers"
    },
    {
      "id": "stats-and-history-ex0",
      "language": "javascript",
      "code": "async stats() {\n  const subs = this.subscriptions();\n  const received_total = subs.reduce((sum, s) => sum + s.receivedTotal(), 0);\n  const channel_published = {};\n  for (const [channel, count] of this._channel_published.entries()) {\n    channel_published[channel] = count;\n  }\n  return {\n    published_total: this._published_total,\n    delivered_total: this._delivered_total,\n    received_total,\n    active_subscriptions: subs.length,\n    channel_published,\n    pattern_subscriptions: await this.patternSubscriberCount(),\n  };\n}",
      "section_id": "stats-and-history"
    },
    {
      "id": "get-the-source-files-ex0",
      "language": "bash",
      "code": "mkdir pub-sub-demo && cd pub-sub-demo\nBASE=https://raw.githubusercontent.com/redis/docs/main/content/develop/use-cases/pub-sub/nodejs\ncurl -O $BASE/package.json\ncurl -O $BASE/pubsub_hub.js\ncurl -O $BASE/demo_server.js\nnpm install",
      "section_id": "get-the-source-files"
    },
    {
      "id": "start-the-demo-server-ex0",
      "language": "bash",
      "code": "node demo_server.js",
      "section_id": "start-the-demo-server"
    },
    {
      "id": "start-the-demo-server-ex1",
      "language": "text",
      "code": "Redis pub/sub demo server listening on http://127.0.0.1:8096\nUsing Redis at localhost:6379\nSeeded 3 default subscription(s)",
      "section_id": "start-the-demo-server"
    },
    {
      "id": "inspect-pub-sub-state-directly-in-redis-ex0",
      "language": "bash",
      "code": "# Which channels currently have at least one exact-match subscriber?\nredis-cli pubsub channels '*'\n\n# How many subscribers does each channel have?\nredis-cli pubsub numsub orders:new notifications:billing chat:lobby\n\n# How many active pattern subscriptions across the whole server?\nredis-cli pubsub numpat\n\n# Subscribe interactively from the CLI to watch traffic on a pattern\nredis-cli psubscribe 'orders:*'",
      "section_id": "inspect-pub-sub-state-directly-in-redis"
    }
  ]
}