Skip to main content

Message

@rotorsoft/act-root

@rotorsoft/act-root / act/src / Message

Type Alias: Message<TEvents, TKey>

Message<TEvents, TKey> = object

Defined in: libs/act/src/types/action.ts:201

Represents a message (event or action) with a name and data payload.

Messages are the basic building blocks of the event log. Each message has a name (event type) and data (event payload).

Example​

const message: Message<{ Incremented: { amount: number } }, "Incremented"> = {
  name: "Incremented",
  data: { amount: 5 }
};

Type Parameters​

TEvents​

TEvents extends Schemas

Schemas map

TKey​

TKey extends keyof TEvents

Event/action name

Properties​

data​

readonly data: Readonly<TEvents[TKey]>

Defined in: libs/act/src/types/action.ts:205

The event or action payload

name​

readonly name: TKey

Defined in: libs/act/src/types/action.ts:203

The event or action name