Skip to content

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

Interface: HandlerSet<Needs, Events> ​

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

Handlers from handlers(), to mount on consumers with .use().

Extended by ​

Type Parameters ​

Type ParameterDefault type
Needsunknown
Events extends MessageMessage

Properties ​

[DEFINITION] ​

ts
readonly [DEFINITION]: HandlerSetDefinition;

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


~events? ​

ts
readonly optional ~events?: Events;

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

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


needs? ​

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

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

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

Parameters ​

ParameterType
stateNeeds

Returns ​

void

MIT licensed