Docket.Interrupt (docket v0.1.0-dev)

Copy Markdown View Source

Interrupt request returned by node code to pause a run for external input.

Nodes may leave id nil; the runtime assigns an ID. resume_channel must name a declared state field: resolving the interrupt writes the resolution value to that field through the field's reducer (writing to an append field accumulates), and the interrupted node re-executes in the next superstep with the resolved value visible in its state snapshot.

Summary

Types

t()

@type t() :: %Docket.Interrupt{
  id: String.t() | nil,
  metadata: map(),
  node_id: String.t() | nil,
  resume_channel: String.t(),
  schema: Docket.Schema.t() | nil
}