Class RedisBroadcaster

Redis pub/sub broadcaster.

Fans a broadcast out across every instance via Redis pub/sub: broadcast publishes on a Redis channel; each instance subscribes and delivers to its local listeners (the sockets a WS adapter registered). Uses a dedicated subscriber connection (a Redis connection in subscribe mode cannot run other commands). ioredis is imported lazily as an optional peer dependency. Presence is read from the injected ConnectionStore.

Implements

Broadcaster

Index

Constructors

constructor

new RedisBroadcaster(
options: RedisBroadcasterOptions,
store?: ConnectionStore,
): RedisBroadcaster
Parameters
- options: RedisBroadcasterOptions
  The connection options.
- store: ConnectionStore = ...
  The connection store.
Returns RedisBroadcaster

Properties

`Readonly`name

name: string

A human-readable name (e.g. 'memory', 'redis').

`Readonly`store

store: ConnectionStore = ...

The connection store.

Methods

broadcast

broadcast<T = unknown>(
    channel: string,
    event: string,
    payload?: T,
): Promise<void>
Type Parameters
- T = unknown
Parameters
- channel: string
- event: string
- Optionalpayload: T
Returns Promise<void>

Inherit Doc

Implementation of Broadcaster.broadcast

members

members(channel: string): Promise<PresenceMember<unknown>[]>
Parameters
- channel: string
Returns Promise<PresenceMember<unknown>[]>

Inherit Doc

Implementation of Broadcaster.members

on

on<T = unknown>(channel: string, listener: RealtimeListener<T>): () => void
Type Parameters
- T = unknown
Parameters
- channel: string
- listener: RealtimeListener<T>
Returns () => void

Inherit Doc

Implementation of Broadcaster.on

to

to(
channel: string,
): { emit: <T = unknown>(event: string, payload?: T) => Promise<void> }
Parameters
- channel: string
Returns { emit: <T = unknown>(event: string, payload?: T) => Promise<void> }

Inherit Doc

Implementation of Broadcaster.to

`Static`create

create(
options: RedisBroadcasterOptions,
store?: ConnectionStore,
): RedisBroadcaster
Create a Redis broadcaster.
Parameters
- options: RedisBroadcasterOptions
  The connection options.
- store: ConnectionStore = ...
  The connection store (defaults to an in-memory one).
Returns RedisBroadcaster
A new broadcaster.

Class RedisBroadcaster

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RedisBroadcaster

Properties

`Readonly`name

`Readonly`store

Methods

broadcast

Type Parameters

Parameters

Returns Promise<void>

Inherit Doc

members

Parameters

Returns Promise<PresenceMember<unknown>[]>

Inherit Doc

on

Type Parameters

Parameters

Returns () => void

Inherit Doc

to

Parameters

Returns { emit: <T = unknown>(event: string, payload?: T) => Promise<void> }

Inherit Doc

`Static`create

Parameters

Returns RedisBroadcaster

Settings

On This Page

Class RedisBroadcaster

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RedisBroadcaster

Properties

Readonlyname

Readonlystore

Methods

broadcast

Type Parameters

Parameters

Returns Promise<void>

Inherit Doc

members

Parameters

Returns Promise<PresenceMember<unknown>[]>

Inherit Doc

on

Type Parameters

Parameters

Returns () => void

Inherit Doc

to

Parameters

Returns { emit: <T = unknown>(event: string, payload?: T) => Promise<void> }

Inherit Doc

Staticcreate

Parameters

Returns RedisBroadcaster

Settings

On This Page

`Readonly`name

`Readonly`store

`Static`create