API Reference
Axial
No description available.
App
Starts and controls root Flow applications without requiring an external hosting framework.
Bind
Creates error-adaptation markers for let!, do!, and return!
Builders
No description available.
Cause
No description available.
ColdTask
Functions for creating and executing cold tasks.
Deferred
Flow-native helpers for one-shot typed coordination.
Exit
No description available.
Fiber
No description available.
FiberDump
Snapshot conversion and rendering for fiber dumps.
FiberObserver
Standard fiber observers.
Flow
No description available.
Runtime
Runtime helpers for execution-time concerns like cancellation, scope, timeout, retry, and cleanup.
FlowStream
No description available.
Policy
Constructors and combinators for environment-aware workflow requirements.
RetryPolicy
Standard retry policies for runtime helpers.
Schedule
No description available.
Semaphore
Flow-native semaphore helpers.
SupervisePolicy
Standard supervision policies for runtime helpers.
State
No description available.
Ref
No description available.
STM
No description available.
StmBuilders
No description available.
TRef
No description available.
Ref<'T>
Represents a handle to a mutable reference that can be updated atomically.
STM<'T>
Represents a transactional operation that can be composed, retried, and executed atomically.
StmBuilder
Computation expression builder for STM transactions.
TRef<'T>
Represents a transactional reference that can be updated atomically within an transaction.
Telemetry
No description available.
AttributeKey
Creates typed keys for application-defined telemetry attributes.
Context
Builds and scopes ambient telemetry attributes for Axial workflows.
Keys
Contains typed keys for the curated OpenTelemetry semantic conventions exposed by Axial.
Attribute
One telemetry attribute whose key has already validated its value type.
AttributeKey<'value>
A typed name for one telemetry attribute.
AttributeValue
An OpenTelemetry-compatible attribute value supported on both .NET and JavaScript.
TelemetryContext
An immutable set of telemetry attributes propagated with a running workflow.
Activity
No description available.
ActivityTracer
Creates values.
FiberDumpTelemetry
Exports structured fiber dumps into traces.
FiberMetrics
OpenTelemetry-compatible fiber runtime metrics on the Axial meter.
FiberTelemetry
Telemetry wiring for runtime fiber-lifecycle observation.
ActivityTracer
Captures an application-owned ActivitySource so application code can trace its own workflows without repeating the source at every call site.
JavaScript
No description available.
FiberTelemetry
Fiber-lifecycle observability on the installed OpenTelemetry tracer: the JavaScript counterpart of the .NET package's FiberTelemetry, with the same span names and attribute vocabulary.
Otel
OpenTelemetry JS tracing for Axial workflows compiled with Fable: the JavaScript counterpart of the .NET package's Activity.trace, emitting through a host-supplied @opentelemetry/api object.
ContextApi
The subset of the OpenTelemetry JS `context` api namespace this package calls.
OpenTelemetryApi
The `@opentelemetry/api` module surface this package consumes: its `trace` and `context` namespaces.
OtelContext
An opaque OpenTelemetry JS `Context`.
Span
The subset of the OpenTelemetry JS `Span` interface this package writes to.
TraceApi
The subset of the OpenTelemetry JS `trace` api namespace this package calls.
Tracer
The subset of the OpenTelemetry JS `Tracer` interface this package calls.
AppHandle<'error, 'value>
Owns one running root workflow and provides coordinated application shutdown.
AppStatus
Describes the lifecycle state of a running application.
BindError<'env, 'error, 'value>
Marks a source whose error is adapted at a flow { } bind site.
Cause<'error>
Represents the cause of a failed workflow.
ColdTask<'value>
Represents delayed task work that can observe a runtime cancellation token when it is started.
Deferred<'error, 'value>
A one-shot, typed handoff point that can be completed exactly once with a full Exit.
EnvFlow<'env, 'value>
A flow that reads an environment and cannot fail with a typed error.
Exit<'value, 'error>
Represents the final outcome of a workflow execution.
ExnEnvFlow<'env, 'value>
A flow that reads an environment and uses exceptions as recoverable typed errors.
ExnFlow<'value>
A flow that requires no environment and uses exceptions as recoverable typed errors.
Fiber<'error, 'value>
Represents a handle to a workflow that has already been started.
FiberDump
Structured diagnostic snapshot of a fiber, taken at a single point in time.
FiberId
Unique identifier for a running fiber.
FiberMetadata
Diagnostic metadata for a running fiber.
FiberObserver
Runtime hooks observing fiber lifecycle events for diagnostics and telemetry.
FiberRegistry
Tracks every live forked fiber so the whole runtime can be dumped as a parent/child tree at any moment.
FiberStatus
Describes the current lifecycle state of a fiber.
Flow<'env, 'error, 'value>
Represents a cold workflow that reads an environment, returns a typed result, and is executed explicitly through one of its execution members such as ToTask, ToAsync, or RunSynchronously.
Flow<'value>
A flow that requires no environment and cannot fail with a typed error.
Flow<'error, 'value>
A flow that requires no environment and can fail with a typed error.
FlowBuilder
No description available.
FlowSemaphore
A Flow-native semaphore handle used to limit concurrent workflow sections.
FlowStream<'env, 'error, 'value>
Represents a cold stream of values that requires an environment, can fail with a typed error, and supports backpressure.
LogLevel
Log levels used by runtime logging helpers and environment-provided logging functions.
Never
Represents an error channel that cannot occur.
Policy<'env, 'error, 'input, 'output>
Represents an environment-aware requirement that turns an input into either an output or a workflow error.
RetryPolicy<'error>
Defines how runtime retry helpers repeat typed failures in a controlled way.
Schedule<'env, 'input, 'output>
Represents a stateful schedule that can decide whether to continue and how long to delay.
Scope
Owns finalizers for resources acquired during provisioning or runtime execution.
ServiceProvider
Reads services from an environment.
StreamStep<'value, 'error>
A single step of a : either the stream is exhausted, or it produced one value plus a thunk that continues the stream.
SupervisePolicy
Defines how Flow.Runtime.supervise restarts flows that terminate with unexpected defects.
Layers
No description available.
Builders
No description available.
Layer
No description available.
Layer<'input, 'error, 'output>
Represents a provisioning step that builds an explicit environment inside a scope.
Pool<'resource>
A fixed-size set of eagerly provisioned resource instances, handed out round-robin.
PlatformService
No description available.
BaseRuntime
Helpers for constructing the standard explicit service bundle used by workflow hosts.
Clock
Helpers for the clock service.
EnvironmentVariable
Helpers for reading and parsing environment variables through an explicit service.
EnvironmentVariableErrors
Helpers for formatting environment-variable errors.
EnvironmentVariables
Helpers for the environment-variable service.
Guid
Helpers for the GUID service.
Log
Helpers for the logging service.
Random
Helpers for the random-number service.
BaseRuntime
Groups the standard operational services commonly used by workflow hosts.
BaseRuntimeError
No description available.
EnvironmentVariableError
No description available.
IClock
Provides synchronous access to the current UTC clock.
IEnvironmentVariables
Provides environment-variable access supplied by the application host.
IGuid
Provides synchronous GUID generation.
IHasClock
Declares that an environment supplies the clock service.
IHasEnvironmentVariables
Declares that an environment supplies the environment-variable service.
IHasGuid
Declares that an environment supplies the GUID service.
IHasLog
Declares that an environment supplies the logging service.
IHasRandom
Declares that an environment supplies the random-number service.
ILog
Provides synchronous access to workflow logging as an explicit service.
IRandom
Provides synchronous random-number generation.
Console
No description available.
Console
No description available.
IConsole
Provides explicit access to standard console and terminal I/O.
IHasConsole
Declares that an environment supplies the console service.
FileSystem
No description available.
FileSystem
No description available.
FileSystemError
No description available.
FileSystemError
Describes a meaningful file-system failure.
IFileSystem
Provides access to common file, directory, and path operations.
IHasFileSystem
No description available.
Hosting
No description available.
DotNetApp
Standalone .NET process integration for Flow applications that do not use Generic Host.
FiberLogging
Fiber-lifecycle logging through Microsoft.Extensions.Logging.
Hosting
Microsoft Generic Host registration helpers for root Flow applications.
MicrosoftLogging
Adapts Microsoft.Extensions.Logging loggers to Axial's explicit logging service.
FlowHostedService<'env, 'error>
Runs one root Flow application as a Microsoft Generic Host hosted service.
HostedAppOptions
Controls how a root Flow application participates in Generic Host lifetime.
Node
No description available.
NodeApp
Node.js signal, argument, and process-exit integration for root Flow applications.
NodeEnvironment
Node.js process environment adaptation for Axial's explicit environment-variable service.
Browser
No description available.
BrowserApp
Browser ownership and AbortSignal integration for root Flow applications.
AbortSignal
A structural binding for the browser and JavaScript AbortSignal contract.