Skip to main content

Module events

Module events 

Source
Expand description

The NDJSON event envelope for long-running commands.

Bounded commands emit one JSON object; long-running ones emit one complete event per line, opening with a EventKind::Schema event that names the version, so a consumer knows what it is reading before the first step event arrives. The compatibility rules are stated once and held by test: a consumer ignores unknown fields and unknown event types, field names are never renamed, and new event types append.

Structs§

Event
One event on the stream.

Enums§

ChildStream
Which of a child’s streams a chunk came from.
EventKind
Every event type the stream can carry; additions append, and no variant is ever renamed.

Constants§

EVENTS_SCHEMA
The version of the event envelope’s shape.