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

Interface: ConsumerBuilder<Path, State, User, Emits, Events>

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

What consumer() returns: chain handlers, then pass it to createChanx().

Extends

• HandlerMethods<"consumer", Path, State, User, Emits, Events>.ConsumerSource

Type Parameters

Type Parameter	Default type
Path extends string	-
State	-
User	-
Emits extends Message	-
Events extends Message	never

Properties

[DEFINITION]

readonly [DEFINITION]: ConsumerDefinition;

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

Inherited from

ConsumerSource.[DEFINITION]

---

~events?

readonly optional ~events?: Events;

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

Methods

event()

Call Signature

event<D>(message, handler): ConsumerBuilder<Path, State, User, Emits, 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<Path, State, User, Emits>, void | Emits>

Returns

ConsumerBuilder<Path, State, User, Emits, Events | MessageOf<D>>

Inherited from

HandlerMethods.event

Call Signature

event<D, O>(
   message, 
   options, 
   handler
): ConsumerBuilder<Path, State, User, Emits, 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<Path, State, User, Emits | OutputMessages<O>>, Returned<O>>

Returns

ConsumerBuilder<Path, State, User, Emits, Events | MessageOf<D>>

Inherited from

HandlerMethods.event

---

on()

Call Signature

on<D>(message, handler): ConsumerBuilder<Path, State, User, Emits, 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<Path, State, User, Emits>, void | Emits>

Returns

ConsumerBuilder<Path, State, User, Emits, Events>

Inherited from

HandlerMethods.on

Call Signature

on<D, O>(
   message, 
   options, 
   handler
): ConsumerBuilder<Path, State, User, Emits, 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<Path, State, User, Emits | OutputMessages<O>>, Returned<O>>

Returns

ConsumerBuilder<Path, State, User, Emits, Events>

Inherited from

HandlerMethods.on

---

passthrough()

passthrough<D>(...messages): ConsumerBuilder<Path, State, User, Emits, 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

ConsumerBuilder<Path, State, User, Emits, Events | MessageOf<D[number]>>

Inherited from

HandlerMethods.passthrough

---

use()

use<S>(set): ConsumerBuilder<Path, State, User, Emits, Events | EventsOf<S>>;

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

Mount a reusable handler set; its required state must be part of this consumer's.

Type Parameters

Type Parameter
S extends HandlerSet<never, Message<string, unknown>>

Parameters

Parameter	Type
set	S & [State] extends [NeedsOf<S>] ? unknown : object

Returns

ConsumerBuilder<Path, State, User, Emits, Events | EventsOf<S>>