API reference / @node-ts/bus-messages / MessageDefinition

Interface: MessageDefinition()<TMessage, TData>

Defined in: packages/bus-messages/src/message-declaration.ts:48

A message declared with defineCommand or defineEvent: a function that creates the message from its fields. Messages it creates, and messages of its type that are received, are plain objects.

Example

const PlaceOrder = defineCommand('@my-org/orders/place-order')<{ orderId: string }>()
const placeOrder = PlaceOrder({ orderId: '1' })

Type Parameters

Type Parameter	Default type
TMessage extends Message	Message
TData extends object	MessageData<TMessage>

MessageDefinition(...data): TMessage;

Defined in: packages/bus-messages/src/message-declaration.ts:58

Creates a message

Parameters

Parameter	Type	Description
...data	object extends TData ? [TData] : [TData]	the fields of the message. They're copied, and $name and $version are added. It can be left out when the message has no required fields.

Returns

TMessage

the message

Properties

Property	Modifier	Type	Description	Defined in
NAME	readonly	TMessage["$name"]	The $name of every message it creates	packages/bus-messages/src/message-declaration.ts:63