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

Class: InMemoryChannelLayer

Defined in: packages/layers/src/in-memory.ts:13

A single-process layer, for development and tests.

Implements

• ChannelLayer

Constructors

Constructor

new InMemoryChannelLayer(options?): InMemoryChannelLayer;

Defined in: packages/layers/src/in-memory.ts:16

Parameters

Parameter	Type
options	LayerOptions

Returns

InMemoryChannelLayer

Methods

flush()

flush(): Promise<void>;

Defined in: packages/layers/src/in-memory.ts:60

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/in-memory.ts:43

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/in-memory.ts:49

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/in-memory.ts:54

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/in-memory.ts:21

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/in-memory.ts:37

Parameters

Parameter	Type
channel	string
message	ChannelMessage

Returns

Promise<void>

Implementation of

ChannelLayer.send