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

Interface: AnyMessageDefinition

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

Any message definition, whatever its action and payload.

Extends

• Omit<MessageDefinition, "create">

Properties

action

readonly action: string;

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

The action discriminant on the wire.

Inherited from

Omit.action

---

description?

readonly optional description?: string;

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

Documented in AsyncAPI.

Inherited from

Omit.description

---

payload

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

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

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

Inherited from

Omit.payload

---

title

readonly title: string;

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

Its AsyncAPI component name.

Inherited from

Omit.title

Methods

create()

create(...args): Message;

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

Parameters

Parameter	Type
...args	never

Returns

Message