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

Interface: MessageDefinition<A, P>

Defined in: packages/server/src/messages.ts:12

A message type: its action, payload schema and AsyncAPI documentation.

Type Parameters

Type Parameter	Default type
A extends string	string
P	unknown

Properties

action

readonly action: A;

Defined in: packages/server/src/messages.ts:14

The action discriminant on the wire.

---

description?

readonly optional description?: string;

Defined in: packages/server/src/messages.ts:20

Documented in AsyncAPI.

---

payload

readonly payload: StandardSchemaV1<unknown, P> | null;

Defined in: packages/server/src/messages.ts:16

Validates the payload; null for a message that carries none.

---

title

readonly title: string;

Defined in: packages/server/src/messages.ts:18

Its AsyncAPI component name.

Methods

create()

create(...args): Message<A, P>;

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

Build a message of this type. The payload is typed, not validated.

Parameters

Parameter	Type
...args	CreateArgs<P>

Returns

Message<A, P>