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

Interface: Session

Defined in: packages/server/src/session.ts:38

One accepted socket, as an adapter drives it.

Properties

ready

readonly ready: Promise<boolean>;

Defined in: packages/server/src/session.ts:40

Resolves once connected (authenticated, groups joined, onConnect run), or false if not.

Methods

closed()

closed(): Promise<void>;

Defined in: packages/server/src/session.ts:44

The socket closed, by either side. Resolves once onDisconnect ran and groups are left.

Returns

Promise<void>

---

receive()

receive(data): void;

Defined in: packages/server/src/session.ts:42

A frame from the client. Binary frames are answered with an error, as chanx does.

Parameters

Parameter	Type
data	string | BinaryFrame

Returns

void