Skip to main content
Core 1.0.0-rc.1

Runtime Reference

Runtime Reference is the user-facing view of how a live Journey machine behaves after creation.

Machine Architecture explains which file owns each responsibility. Runtime Reference explains what those runtime guarantees mean when you are reading snapshots, subscribing to events, handling async work, or reasoning about history.

Section Map​

Runtime Reference
├─ Snapshot
│  └─ What is true right now?
├─ Lifecycle
│  └─ What just happened?
├─ Async Behavior
│  └─ How do guards, updateContext, timeouts, and errors behave?
└─ Timeline Navigation
   └─ How does Journey remember where the user actually went?

When To Use These Pages​

  • Read Snapshot when you are rendering UI, persisting state, or debugging current runtime truth.
  • Read Lifecycle when you are wiring analytics, logs, or event-driven side channels.
  • Read Async Behavior when guards can wait, fail, or time out, or when you need transition updateContext timing rules.
  • Read Timeline Navigation when you need to reason about back behavior, revisits, and branch-after-back flows.

Under The Hood​

If you want to connect these runtime guarantees back to implementation, use the matching architecture pages:

  1. Start with Snapshot because almost every other runtime question refers back to it.
  2. Read Lifecycle if you care about observation and event ordering.
  3. Read Async Behavior if transitions are not purely synchronous.
  4. Read Timeline Navigation if your product has explicit back, revisit, or branching flows.