API reference / @chanx-js/server / core / consumer
Function: consumer()
ts
function consumer<Path, State, User, Emits>(path, options): ConsumerBuilder<Path, State, User, MessageOf<Emits>>;Defined in: packages/server/src/consumer.ts:314
Declare a consumer: a route and the messages it handles.
Type Parameters
| Type Parameter | Default type |
|---|---|
Path extends string | - |
State | Record<never, never> |
User | undefined |
Emits extends AnyMessageDefinition | never |
Parameters
| Parameter | Type |
|---|---|
path | Path |
options | ConsumerOptions<Path, State, User, Emits> |
Returns
ConsumerBuilder<Path, State, User, MessageOf<Emits>>