API reference / @chanx-js/server / core / Subscription

Interface: Subscription<User>

Defined in: packages/server/src/classes.ts:267

What a class topic is built with: the subscription it serves.

Type Parameters

Type Parameter	Default type
User	unknown

Properties

conn

readonly conn: Connection<string, User>;

Defined in: packages/server/src/classes.ts:268

---

params

readonly params: Readonly<Record<string, string>>;

Defined in: packages/server/src/classes.ts:270

Params parsed from the topic: room:{room_name} subscribed as room:lobby gives lobby.

---

topic

readonly topic: string;

Defined in: packages/server/src/classes.ts:272

The topic string, such as room:lobby.

Methods

publish()

publish(event, options?): Promise<void>;

Defined in: packages/server/src/classes.ts:274

Parameters

Parameter	Type
event	Message
options?	PublishOptions

Returns

Promise<void>

---

push()

push(message): Promise<void>;

Defined in: packages/server/src/classes.ts:273

Parameters

Parameter	Type
message	Message

Returns

Promise<void>