Skip to content

entrypoints.md

Latest commit

 

History

History
83 lines (73 loc) · 2.48 KB

entrypoints.md

File metadata and controls

83 lines (73 loc) · 2.48 KB
Raw

Entrypoints

For npm consumers, @async/framework uses conditional exports: browser-aware tooling receives the browser entry, while Node receives the server-capable entry. Use explicit subpaths when the target matters. The root export also uses condition-specific declarations, so browser-conditioned root imports expose the same API as @async/framework/browser; server-only APIs remain declared on the Node/server entrypoints.

import {
  Async,
  AsyncError,
  Loader,
  attributeName,
  asyncErrorCodes,
  asyncSignal,
  createApp,
  createCacheRegistry,
  createComponentRegistry,
  createLazyRegistry,
  computed,
  component,
  createSignal,
  createHandlerRegistry,
  createRegistryStore,
  createScheduler,
  createServerProxy,
  createSignalRegistry,
  defineAsyncContainerElement,
  defineAsyncSuspenseElement,
  defineAttributeConfig,
  defineApp,
  defineCache,
  defineRegistrySnapshot,
  delay,
  effect,
  html,
  isAsyncError,
  readSnapshot,
  signal,
  toAsyncDiagnostic
} from "@async/framework/browser";

Use feature subpaths when an app needs the larger browser systems:

import { AsyncStream } from "@async/framework/stream";
import { Async, defineRoute } from "@async/framework/router";
import { flow, flowSignal, flowStatus, compose, when, transition } from "@async/framework/flow";

The flow entry exposes the Framework Flow authoring surface: declaration helpers (flowSignal, flowComputed, flowAsyncSignal, flowStatus), step helpers (set, update, when, branch, guard, transition, dispatch, after, onError), condition helpers (bool, every, some, not, can, matches, inspect), and composition (compose, parallel, remember). Apps do not need to install @async/flow separately.

Server-only APIs live behind the server entry:

import {
  createRequestContextStore,
  createServerRegistry
} from "@async/framework/server";

Loader is the canonical loader factory. AsyncLoader remains as a compatibility alias for older code.

AsyncError, asyncErrorCodes, isAsyncError, and toAsyncDiagnostic are available from the browser, router, flow, and server entrypoints. See Errors & Diagnostics for the stable code catalogue and event-reporting contract.

Related