Skip to content

API reference (package surface)

This topic lists the public exports of omega-angular. It mirrors how Angular’s docs separate guides from a compact API map; for parameter-level detail, rely on TSDoc in your editor or the .d.ts files in the published package (see the library’s public-api.ts in the repository).

Source of truth

Use this page as a navigable index. TypeScript declarations under node_modules/omega-angular (or your monorepo path) are authoritative for signatures and deprecations.

Types & semantics

Export areaContents
OmegaObject, OmegaFailureBase / error helpers.
OmegaEventName, OmegaIntentName, OmegaFlowId, OmegaAgentIdBranded / enum-like wire identifiers (optional).
OmegaTypedEventTyped wrapper for emitTyped.
omegaWireNameFromCamelCaseEnumMemberordersCreateorders.create dotted wire names.

Intents & events

TypeDescription
OmegaIntentfromName, payloadAs — routed by OmegaFlowManager.
OmegaEventfromName, fromJson, toJson, payloadAs.

Channel

TypeDescription
OmegaEventBusInterface implemented by OmegaChannel and OmegaChannelNamespace.
OmegaChannelevents, emit, emitNamed, emitTyped, on, namespace, dispose.
OmegaChannelNamespaceScoped emit + filtered events / on.

Flows & manager

TypeDescription
OmegaFlowSubclass with id, onIntent, onEvent, protected emit.
OmegaFlowManagerregisterFlow, activate, deactivate, switchTo, handleIntent, getChannel.

Agents

TypeDescription
OmegaAgentBehaviorEngineAbstract evaluate → reaction or null.
OmegaAgent(channel, behaviors[], onReaction); destroy.

Bootstrap

SymbolDescription
provideOmega(options)Returns providers for channel, manager, flows, and an app initializer that runs bootstrap + createAgents.
OmegaProvideOptionscreateFlows, optional bootstrap, optional createAgents.
OmegaRuntimeContext{ channel, manager } passed to bootstrap / createAgents.

Inspector (diagnostics)

SymbolDescription
provideOmegaInspector(options?)Provider[] — registers OmegaInspectorService + optional OMEGA_FLOW_MANAGER_INSTRUMENTATION. Place before provideOmega.
OmegaInspectorServiceBuffers channel events + intents; optional BroadcastChannel.
OmegaInspectorPanelComponentStandalone UI (<omega-inspector-panel />).
OmegaFlowManagerInstrumentationOptional hooks on OmegaFlowManager (used by the inspector).
OMEGA_FLOW_MANAGER_INSTRUMENTATIONInjection token for custom instrumentation.
OmegaInspectorGlobalApiShape of window.__OMEGA_INSPECTOR__ (console API + log getters).
provideOmegaInspectorFloatingUi()Mounts OmegaInspectorFloatingComponent on document.body (no Router).
OmegaInspectorFloatingComponentFloating Ω button + expandable panel shell.

Deprecated aliases

  • registerregisterFlow
  • dispatchhandleIntent

Prefer the non-deprecated names in new code.

What’s next

Omega Angular — by Yeferson Segura. Documentation for the npm package and this repository.