API Reference musubi v#0.3.0

Copy Markdown View Source

Modules

Async lifecycle API for Musubi stores. Exposes assign_async/3,4, start_async/3,4, cancel_async/2,3, and stream_async/3,4.

Three-field struct that tracks the lifecycle of an asynchronously-resolved socket assignment.

Render-time child placeholder sentinel resolved by Musubi.Resolver when it appears in store output.

Compile-time DSL entrypoint for Musubi input-object schemas.

Lifecycle hook helpers for Musubi runtime stages.

Socket struct and assign helpers for Musubi runtimes.

Compile-time DSL entrypoint for Musubi reusable state modules.

Compile-time DSL entrypoint, behaviour contract, and runtime facade for Musubi store modules.

Stream API for Musubi stores.

Telemetry emission helper for Musubi runtime events plus the canonical event catalog.

Test entry point for Musubi root stores, analogous to Phoenix.LiveViewTest. Wraps Musubi.Page.Server.start_link/1 with test-friendly defaults and exposes the primary assertion surface (render/2).

Generic Phoenix Channel adapter that mounts any Musubi root store named in the channel module's allowlist.

Phoenix Channel adapter for Musubi sockets with multiple root stores.

Phoenix socket adapter generated by use Musubi.Socket.

Mix Tasks

Mix compiler that walks every Musubi state do module exposed by the current Mix project and writes one TypeScript bundle file with namespaces mirroring the Elixir module tree.