interface RedisBackplaneOptions
Since 0.2.0

Options for the 'redis' arm — Redis pub/sub.

Properties

transport: "redis"

Transport discriminant.

readonly
optional
client: IRedisBackplaneClient

The publishing client. Must be supplied together with RedisBackplaneOptions.subscriber: a Redis connection in subscriber mode refuses every other command, so one connection cannot do both jobs.

The dedicated subscriber client.

readonly
optional
url: string

Connection URL used to build both clients on the lazy npm:ioredis path. Read only when no clients are injected.

readonly
optional
module: IRedisModule

A module exposing an ioredis-compatible constructor, for testing.

Usage

import { type RedisBackplaneOptions } from "realtime-backplane-plugin/src/index.ts";