API reference / @chanx-js/layers / redis / RedisPubSubChannelLayer

Class: RedisPubSubChannelLayer

Defined in: packages/layers/src/redis/index.ts:53

Redis pub/sub layer, wire-compatible with RedisPubSubChannelLayer from channels_redis and fast-channels: Python and Node processes can share it.

Implements

• ChannelLayer

Constructors

Constructor

new RedisPubSubChannelLayer(options?): RedisPubSubChannelLayer;

Defined in: packages/layers/src/redis/index.ts:61

Parameters

Parameter	Type
options	RedisPubSubChannelLayerOptions

Returns

RedisPubSubChannelLayer

Properties

prefix

readonly prefix: string;

Defined in: packages/layers/src/redis/index.ts:54

Methods

deserialize()

deserialize(data): Promise<ChannelMessage>;

Defined in: packages/layers/src/redis/index.ts:85

Parameters

Parameter	Type
data	Uint8Array

Returns

Promise<ChannelMessage>

---

flush()

flush(): Promise<void>;

Defined in: packages/layers/src/redis/index.ts:141

Forget every channel and group and close connections; usable again afterwards.

Returns

Promise<void>

Implementation of

ChannelLayer.flush

---

groupAdd()

groupAdd(group, channel): Promise<void>;

Defined in: packages/layers/src/redis/index.ts:115

Only channels created by this layer instance can join.

Parameters

Parameter	Type
group	string
channel	string

Returns

Promise<void>

Implementation of

ChannelLayer.groupAdd

---

groupDiscard()

groupDiscard(group, channel): Promise<void>;

Defined in: packages/layers/src/redis/index.ts:129

Parameters

Parameter	Type
group	string
channel	string

Returns

Promise<void>

Implementation of

ChannelLayer.groupDiscard

---

groupSend()

groupSend(group, message): Promise<void>;

Defined in: packages/layers/src/redis/index.ts:135

Parameters

Parameter	Type
group	string
message	ChannelMessage

Returns

Promise<void>

Implementation of

ChannelLayer.groupSend

---

newChannel()

newChannel(handler, __namedParameters?): Promise<LayerChannel>;

Defined in: packages/layers/src/redis/index.ts:89

Parameters

Parameter	Type
handler	MessageHandler
__namedParameters	{ prefix?: string; }
__namedParameters.prefix?	string

Returns

Promise<LayerChannel>

Implementation of

ChannelLayer.newChannel

---

send()

send(channel, message): Promise<void>;

Defined in: packages/layers/src/redis/index.ts:110

Parameters

Parameter	Type
channel	string
message	ChannelMessage

Returns

Promise<void>

Implementation of

ChannelLayer.send

---

serialize()

serialize(message): Promise<Uint8Array<ArrayBufferLike>>;

Defined in: packages/layers/src/redis/index.ts:81

Message to bytes on the wire. Override to change the format on both ends.

Parameters

Parameter	Type
message	ChannelMessage

Returns

Promise<Uint8Array<ArrayBufferLike>>