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

Interface: HandlerSetBuilder<Needs, Events>

Defined in: packages/server/src/consumer.ts:308

What handlers() returns: chain handlers, then mount it with .use().

Extends

• HandlerSet<Needs, Events>.HandlerMethods<"set", string, Needs, unknown, Message, Events>

Type Parameters

Type Parameter	Default type
Needs	-
Events extends Message	never

Properties

[DEFINITION]

readonly [DEFINITION]: HandlerSetDefinition;

Defined in: packages/server/src/consumer.ts:217

Inherited from

HandlerSet.[DEFINITION]

---

~events?

readonly optional ~events?: Events;

Defined in: packages/server/src/consumer.ts:221

Phantom: the events these handlers accept, for typed broadcastEvent().

Inherited from

HandlerSet.~events

---

needs?

readonly optional needs?: (state) => void;

Defined in: packages/server/src/consumer.ts:219

Phantom: the consumer state this set's handlers rely on.

Parameters

Parameter	Type
state	Needs

Returns

void

Inherited from

HandlerSet.needs

Methods

event()

Call Signature

event<D>(message, handler): HandlerSetBuilder<Needs, Events | MessageOf<D>>;

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

Handle a server-side event from the channel layer.

Type Parameters

Type Parameter
D extends AnyMessageDefinition

Parameters

Parameter	Type
message	D
handler	Handler<MessageOf<D>, Context<string, Needs, unknown, Message<string, unknown>>, void | Message<string, unknown>>

Returns

HandlerSetBuilder<Needs, Events | MessageOf<D>>

Inherited from

HandlerMethods.event

Call Signature

event<D, O>(
   message, 
   options, 
   handler
): HandlerSetBuilder<Needs, Events | MessageOf<D>>;

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

Handle a server-side event; return a declared output to send it to the client.

Type Parameters

Type Parameter	Default type
D extends AnyMessageDefinition	-
O extends Outputs	never

Parameters

Parameter	Type
message	D
options	HandlerOptions<O>
handler	Handler<MessageOf<D>, Context<string, Needs, unknown, Message<string, unknown> | OutputMessages<O>>, Returned<O>>

Returns

HandlerSetBuilder<Needs, Events | MessageOf<D>>

Inherited from

HandlerMethods.event

---

on()

Call Signature

on<D>(message, handler): HandlerSetBuilder<Needs, Events>;

Defined in: packages/server/src/consumer.ts:253

Handle a client message.

Type Parameters

Type Parameter
D extends AnyMessageDefinition

Parameters

Parameter	Type
message	D
handler	Handler<MessageOf<D>, Context<string, Needs, unknown, Message<string, unknown>>, void | Message<string, unknown>>

Returns

HandlerSetBuilder<Needs, Events>

Inherited from

HandlerMethods.on

Call Signature

on<D, O>(
   message, 
   options, 
   handler
): HandlerSetBuilder<Needs, Events>;

Defined in: packages/server/src/consumer.ts:258

Handle a client message; return a declared output to reply.

Type Parameters

Type Parameter	Default type
D extends AnyMessageDefinition	-
O extends Outputs	never

Parameters

Parameter	Type
message	D
options	HandlerOptions<O>
handler	Handler<MessageOf<D>, Context<string, Needs, unknown, Message<string, unknown> | OutputMessages<O>>, Returned<O>>

Returns

HandlerSetBuilder<Needs, Events>

Inherited from

HandlerMethods.on

---

passthrough()

passthrough<D>(...messages): HandlerSetBuilder<Needs, Events | MessageOf<D[number]>>;

Defined in: packages/server/src/consumer.ts:283

Events forwarded to the client unchanged.

Type Parameters

Type Parameter
D extends readonly AnyMessageDefinition[]

Parameters

Parameter	Type
...messages	D

Returns

HandlerSetBuilder<Needs, Events | MessageOf<D[number]>>

Inherited from

HandlerMethods.passthrough