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

Abstract Class: AsyncJsonWebsocketConsumer<User>

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

Base class for consumers written as classes. One instance serves one connection, so its fields are per-connection state.

Type Parameters

Type Parameter	Default type
User	unknown

Constructors

Constructor

new AsyncJsonWebsocketConsumer<User>(conn): AsyncJsonWebsocketConsumer<User>;

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

Parameters

Parameter	Type
conn	Connection<string, User>

Returns

AsyncJsonWebsocketConsumer<User>

Properties

conn

readonly conn: Connection<string, User>;

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

Accessors

params

Get Signature

get params(): Readonly<Record<string, string>>;

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

Params parsed from the route.

Returns

Readonly<Record<string, string>>

Methods

broadcast()

broadcast(message, options?): Promise<void>;

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

Send to every connection in the groups, across processes.

Parameters

Parameter	Type
message	Message
options?	BroadcastOptions

Returns

Promise<void>

---

onConnect()

onConnect(): void | Promise<void>;

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

Runs once authenticated and the groups are joined.

Returns

void | Promise<void>

---

onDisconnect()

onDisconnect(): void | Promise<void>;

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

Runs when the socket closes, before the groups are left.

Returns

void | Promise<void>

---

onEventError()?

optional onEventError(
   error, 
   event, 
   ctx
): void | Promise<void>;

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

Override to change how a failing event handler is reported.

Parameters

Parameter	Type
error	unknown
event	Message
ctx	ClassContext

Returns

void | Promise<void>

---

onHandlerError()?

optional onHandlerError(
   error, 
   message, 
   ctx
): void | Promise<void>;

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

Override to change how a failing message handler is reported.

Parameters

Parameter	Type
error	unknown
message	Message
ctx	ClassContext

Returns

void | Promise<void>

---

onValidationError()?

optional onValidationError(issues, ctx): void | Promise<void>;

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

Override to change how a frame that failed validation is answered.

Parameters

Parameter	Type
issues	ValidationIssue[]
ctx	ClassContext

Returns

void | Promise<void>

---

push()

push(message): Promise<void>;

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

Send to this client as a server push, without a ref.

Parameters

Parameter	Type
message	Message

Returns

Promise<void>