API Reference
Axial
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
Represents the cause of a failed workflow.
ColdTask
Functions for creating and executing cold tasks.
Deferred
Flow-native helpers for one-shot typed coordination.
Exit
Represents the final outcome of a workflow execution.
Fiber
Represents a handle to a workflow that has already been started.
FiberDump
Snapshot conversion and rendering for fiber dumps.
FiberObserver
Standard fiber observers.
Flow
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.
Runtime
Runtime helpers for execution-time concerns like cancellation, scope, timeout, retry, and cleanup.
FlowStream
Represents a cold stream of values that requires an environment, can fail with a typed error, and supports backpressure.
Policy
Constructors and combinators for environment-aware workflow requirements.
RetryPolicy
Standard retry policies for runtime helpers.
Schedule
Represents a stateful schedule that can decide whether to continue and how long to delay.
Semaphore
Flow-native semaphore helpers.
SupervisePolicy
Standard supervision policies for runtime helpers.
Ref
Represents a handle to a mutable reference that can be updated atomically.
STM
Represents a transactional operation that can be composed, retried, and executed atomically.
StmBuilders
No description available.
TRef
Represents a transactional reference that can be updated atomically within an STM transaction.
StmBuilder
Computation expression builder for STM transactions.
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.
AttributeValue
An OpenTelemetry-compatible attribute value supported on both .NET and JavaScript.
TelemetryContext
An immutable set of telemetry attributes propagated with a running workflow.
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.
EnvFlow<'env, 'value>
A flow that reads an environment and cannot fail with a typed error.
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.
FiberId
Unique identifier for a running fiber.
FiberMetadata
Diagnostic metadata for a running fiber.
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.
FlowBuilder
No description available.
FlowSemaphore
A Flow-native semaphore handle used to limit concurrent workflow sections.
LogLevel
Log levels used by runtime logging helpers and environment-provided logging functions.
Never
Represents an error channel that cannot occur.
Scope
Owns finalizers for resources acquired during provisioning or runtime execution.
ServiceProvider
Reads services from an IServiceProvider environment.
StreamStep<'value, 'error>
A single step of a FlowStream: either the stream is exhausted, or it produced one value plus a thunk that continues the stream.
Axial.Layers
Builders
No description available.
Layer
Represents a provisioning step that builds an explicit environment inside a scope.
Axial.PlatformService
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.
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.
Axial.Console
Console
No description available.
IConsole
Provides explicit access to standard console and terminal I/O.
IHasConsole
Declares that an environment supplies the console service.
Axial.FileSystem
FileSystem
No description available.
FileSystemError
Describes a meaningful file-system failure.
IFileSystem
Provides access to common file, directory, and path operations.
IHasFileSystem
No description available.
Axial.Hosting
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.
Axial.Hosting.Node
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.
Axial.Hosting.Browser
BrowserApp
Browser ownership and AbortSignal integration for root Flow applications.
AbortSignal
A structural binding for the browser and JavaScript AbortSignal contract.
Axial.Telemetry
Activity
No description available.
ActivityTracer
Creates ActivityTracer 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.
Axial.Telemetry.JavaScript
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.