API reference / @chanx-js/layers / core / ChannelLayer

Interface: ChannelLayer

Defined in: packages/layers/src/types.ts:17

Python channels' layer API (new_channel, send, group_add, group_discard, group_send, flush), delivering through a handler instead of receive().

Methods

flush()

flush(): Promise<void>;

Defined in: packages/layers/src/types.ts:28

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

Returns

Promise<void>

---

groupAdd()

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

Defined in: packages/layers/src/types.ts:24

Only channels created by this layer instance can join.

Parameters

Parameter	Type
group	string
channel	string

Returns

Promise<void>

---

groupDiscard()

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

Defined in: packages/layers/src/types.ts:25

Parameters

Parameter	Type
group	string
channel	string

Returns

Promise<void>

---

groupSend()

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

Defined in: packages/layers/src/types.ts:26

Parameters

Parameter	Type
group	string
message	ChannelMessage

Returns

Promise<void>

---

newChannel()

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

Defined in: packages/layers/src/types.ts:18

Parameters

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

Returns

Promise<LayerChannel>

---

send()

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

Defined in: packages/layers/src/types.ts:22

Parameters

Parameter	Type
channel	string
message	ChannelMessage

Returns

Promise<void>