Signals API

Exact public API for typed Signal definitions, publication, filtering, and durable Flow waits.

Create Signal definitions from the root package:

import { signal } from "@use-crux/core";

Import the complete Signal type and error surface from the focused subpath:

import {
  SignalError,
  SignalValidationError,
  type Signal,
  type SignalOccurrence,
} from "@use-crux/core/signal";

Static Flow wait types and methods live on the existing Flow surface:

import { flow, type FlowWaitForSignalOptions } from "@use-crux/core/flow";

publish() resolves at acceptance, never consumer completion. The default in-memory node() Runtime is process-local and cannot activate a durable Signal-to-Flow wait.

Reference map

Definitions and publication

signal(), Signal, schema inference, occurrences, receipts, listeners, and options.

Filters and helper types

Match and predicate views, StaticSignalSource, and occurrence inference.

Flow integration

Flow signal maps, waitFor(source), local Flow signals, and their exact separation.

Providers and transports

webhook, signalProvider, managed bindings, accept/normalize, statistics, and projections.

Errors

SignalError, SignalValidationError, and Runtime errors around durable waits.

Start with the Signals guide for the recommended learning path and deployment boundaries.

Adapter authors should use the exact Runtime Signal adapter surface for the shipped records, payload codec, atomic composites, and required certification suite.