Skip to content

Reference ​

The API surface, organized by primitive and by package.

Primitives ​

The define* functions that domain code uses every day. Each has its own page with signature, params, return type, runtime semantics, and a working example.

Core ​

Forge (CQRS battery, opt-in) ​

Orchestrator ​

HTTP ​

Other ​

  • Packages — every @nwire/* package with a one-liner
  • CLI — nwire dev, nwire run, nwire studio, nwire please, …
  • Runtime API — runtime.execute, runtime.query, runtime.publish, …
  • Telemetry kinds — every record the telemetry stream emits

Conventions ​

  • All primitives accept an object literal as their primary argument. Some accept a positional name string first.
  • Names use kebab-case prefixed by the bounded context: orders.place-order.
  • Exported symbols use PascalCase: OrderWasPlaced.
  • Cross-App events that flow over a bus carry an explicit version number.

MIT licensed.