API Reference

This section contains detailed documentation for Logix runtime core APIs.

If you want a complete, drift-free “dictionary” of exports and signatures, use the auto-generated API Reference:

• /api-reference

Contents

• Runtime and ManagedRuntime: how to build an app-level Runtime and run Logix in different host environments.
• Bound API ($): the $ object you use inside Logic to read/write state, dispatch actions, watch signals, and manage lifecycle.
• Module definition and implementation: how to define a Module’s Shape (Schema), create instances, and assemble ModuleImpl.
• Flow API: low-level Fluent Flow APIs, matching $.onAction / $.onState / $.on one-to-one.
• React integration: using Logix in React via RuntimeProvider / useModule / useSelector / useDispatch.

Type conventions

You will frequently see the following type parameters in the API docs:

• Sh (Shape): the Module shape, including State and Action schemas.
• R (Requirements): the required dependency environment (Services) for running Logic.
• E (Error): the error type a program may fail with.