Axial

API Reference

Axial

App

Module

Starts and controls root Flow applications without requiring an external hosting framework.

Bind

Module

Creates error-adaptation markers for let!, do!, and return!

Builders

Module

No description available.

Cause

Module

No description available.

ColdTask

Module

Functions for creating and executing cold tasks.

Deferred

Module

Flow-native helpers for one-shot typed coordination.

Exit

Module

No description available.

Fiber

Module

No description available.

FiberDump

Module

Snapshot conversion and rendering for fiber dumps.

FiberObserver

Module

Standard fiber observers.

Flow

Module

No description available.

Runtime

Module

Runtime helpers for execution-time concerns like cancellation, scope, timeout, retry, and cleanup.

FlowStream

Module

No description available.

Policy

Module

Constructors and combinators for environment-aware workflow requirements.

RetryPolicy

Module

Standard retry policies for runtime helpers.

Schedule

Module

No description available.

Semaphore

Module

Flow-native semaphore helpers.

SupervisePolicy

Module

Standard supervision policies for runtime helpers.

State

Namespace

No description available.

Ref

Module

No description available.

STM

Module

No description available.

StmBuilders

Module

No description available.

TRef

Module

No description available.

Ref<'T>

Union

Represents a handle to a mutable reference that can be updated atomically.

STM<'T>

Union

Represents a transactional operation that can be composed, retried, and executed atomically.

StmBuilder

Type

Computation expression builder for STM transactions.

TRef<'T>

Type

Represents a transactional reference that can be updated atomically within an transaction.

Telemetry

Namespace

No description available.

AttributeKey

Module

Creates typed keys for application-defined telemetry attributes.

Context

Module

Builds and scopes ambient telemetry attributes for Axial workflows.

Keys

Module

Contains typed keys for the curated OpenTelemetry semantic conventions exposed by Axial.

Attribute

Record

One telemetry attribute whose key has already validated its value type.

AttributeKey<'value>

Record

A typed name for one telemetry attribute.

AttributeValue

Union

An OpenTelemetry-compatible attribute value supported on both .NET and JavaScript.

TelemetryContext

Union

An immutable set of telemetry attributes propagated with a running workflow.

AppHandle<'error, 'value>

Type

Owns one running root workflow and provides coordinated application shutdown.

AppStatus

Union

Describes the lifecycle state of a running application.

BindError<'env, 'error, 'value>

Union

Marks a source whose error is adapted at a flow { } bind site.

Cause<'error>

Union

Represents the cause of a failed workflow.

ColdTask<'value>

Union

Represents delayed task work that can observe a runtime cancellation token when it is started.

Deferred<'error, 'value>

Union

A one-shot, typed handoff point that can be completed exactly once with a full Exit.

EnvFlow<'env, 'value>

Type

A flow that reads an environment and cannot fail with a typed error.

Exit<'value, 'error>

Union

Represents the final outcome of a workflow execution.

ExnEnvFlow<'env, 'value>

Type

A flow that reads an environment and uses exceptions as recoverable typed errors.

ExnFlow<'value>

Type

A flow that requires no environment and uses exceptions as recoverable typed errors.

Fiber<'error, 'value>

Record

Represents a handle to a workflow that has already been started.

FiberDump

Record

Structured diagnostic snapshot of a fiber, taken at a single point in time.

FiberId

Union

Unique identifier for a running fiber.

FiberMetadata

Record

Diagnostic metadata for a running fiber.

FiberObserver

Record

Runtime hooks observing fiber lifecycle events for diagnostics and telemetry.

FiberRegistry

Type

Tracks every live forked fiber so the whole runtime can be dumped as a parent/child tree at any moment.

FiberStatus

Union

Describes the current lifecycle state of a fiber.

Flow<'env, 'error, 'value>

Union

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>

Type

A flow that requires no environment and cannot fail with a typed error.

Flow<'error, 'value>

Type

A flow that requires no environment and can fail with a typed error.

FlowBuilder

Type

No description available.

FlowSemaphore

Union

A Flow-native semaphore handle used to limit concurrent workflow sections.

FlowStream<'env, 'error, 'value>

Union

Represents a cold stream of values that requires an environment, can fail with a typed error, and supports backpressure.

LogLevel

Union

Log levels used by runtime logging helpers and environment-provided logging functions.

Never

Union

Represents an error channel that cannot occur.

Policy<'env, 'error, 'input, 'output>

Type

Represents an environment-aware requirement that turns an input into either an output or a workflow error.

RetryPolicy<'error>

Record

Defines how runtime retry helpers repeat typed failures in a controlled way.

Schedule<'env, 'input, 'output>

Union

Represents a stateful schedule that can decide whether to continue and how long to delay.

Scope

Type

Owns finalizers for resources acquired during provisioning or runtime execution.

ServiceProvider

Type

Reads services from an environment.

StreamStep<'value, 'error>

Union

A single step of a : either the stream is exhausted, or it produced one value plus a thunk that continues the stream.

SupervisePolicy

Record

Defines how Flow.Runtime.supervise restarts flows that terminate with unexpected defects.

Axial.Layers

Layers

Namespace

No description available.

Builders

Module

No description available.

Layer

Module

No description available.

Layer<'input, 'error, 'output>

Union

Represents a provisioning step that builds an explicit environment inside a scope.

Axial.PlatformService

PlatformService

Namespace

No description available.

BaseRuntime

Module

Helpers for constructing the standard explicit service bundle used by workflow hosts.

Clock

Module

Helpers for the clock service.

EnvironmentVariable

Module

Helpers for reading and parsing environment variables through an explicit service.

EnvironmentVariableErrors

Module

Helpers for formatting environment-variable errors.

EnvironmentVariables

Module

Helpers for the environment-variable service.

Guid

Module

Helpers for the GUID service.

Log

Module

Helpers for the logging service.

Random

Module

Helpers for the random-number service.

BaseRuntime

Record

Groups the standard operational services commonly used by workflow hosts.

BaseRuntimeError

Union

No description available.

EnvironmentVariableError

Union

No description available.

IClock

Type

Provides synchronous access to the current UTC clock.

IEnvironmentVariables

Type

Provides environment-variable access supplied by the application host.

IGuid

Type

Provides synchronous GUID generation.

IHasClock

Type

Declares that an environment supplies the clock service.

IHasEnvironmentVariables

Type

Declares that an environment supplies the environment-variable service.

IHasGuid

Type

Declares that an environment supplies the GUID service.

IHasLog

Type

Declares that an environment supplies the logging service.

IHasRandom

Type

Declares that an environment supplies the random-number service.

ILog

Type

Provides synchronous access to workflow logging as an explicit service.

IRandom

Type

Provides synchronous random-number generation.

Axial.Console

Console

Namespace

No description available.

Console

Module

No description available.

IConsole

Type

Provides explicit access to standard console and terminal I/O.

IHasConsole

Type

Declares that an environment supplies the console service.

Axial.FileSystem

FileSystem

Namespace

No description available.

FileSystem

Module

No description available.

FileSystemError

Module

No description available.

FileSystemError

Union

Describes a meaningful file-system failure.

IFileSystem

Type

Provides access to common file, directory, and path operations.

IHasFileSystem

Type

No description available.

Axial.HttpClient

HttpClient

Namespace

No description available.

DSL

Module

No description available.

SecretValue

Type

Marks an interpolated URL value for redaction in plans and transcripts.

Http

Module

No description available.

HttpError

Module

No description available.

Method

Module

No description available.

Request

Module

No description available.

Response

Module

No description available.

HttpError

Union

A recoverable HTTP transport, timeout, status, or decoding failure.

HttpRequest

Record

An immutable, fully described HTTP request.

HttpResponse

Record

The complete response transcript for one HTTP exchange.

IHasHttp

Type

Declares that an environment supplies the HTTP service.

IHttp

Type

Sends fully described HTTP requests for a concrete host platform.

Method

Union

Identifies one HTTP request method.

RequestBody

Union

Supplies the request payload and its media type.

RequestPlan

Record

A redacted, serializable description of a request that would be sent.

StatusExpectation

Union

Decides which response status codes count as success for a request.

Axial.Process

Process

Namespace

No description available.

DSL

Module

No description available.

Input

Module

No description available.

Output

Module

No description available.

EndpointConnector

Type

No description available.

SecretArgument

Type

Marks an interpolated command value for redaction in plans and transcripts.

Process

Module

No description available.

ProcessError

Module

No description available.

Script

Module

No description available.

CapturedOutput

Record

Exact captured bytes plus their decoded text view and truncation status.

IHasProcess

Type

Declares that an environment supplies the process service.

IProcess

Type

Interprets process specifications as lazy Axial workflows for a concrete host platform.

InputSource

Union

Supplies bytes to the first process stage.

OutputChannel

Union

Identifies one standard output channel.

OutputFraming

Union

Selects arbitrary decoded chunks or complete decoded lines for streamed events.

OutputTarget

Union

Receives bytes from a process topology.

ProcessCancellation

Record

Diagnostic details for caller-initiated process cancellation.

ProcessError

Union

A recoverable process startup, cancellation, stage, or I/O failure.

ProcessEvent

Union

Values emitted by a native process FlowStream.

ProcessIoFailure

Record

Diagnostic details for a process I/O failure.

ProcessOutput

Record

A timestamped decoded output event attributed to one specification stage.

ProcessPlan

Record

A redacted, serializable description of work that would be executed.

ProcessResult

Record

The complete structured transcript returned by a process execution.

ProcessSpec

Record

An immutable description of one command or a connected process topology and its execution policy.

ProcessStartFailure

Record

Diagnostic details for a process that could not be started.

ProcessTimeout

Record

Diagnostic details for an elapsed process deadline.

ScriptEnvironment

Record

No description available.

StageFailure

Record

Diagnostic details for an unsuccessful process stage.

StageResult

Record

The redacted command, exit decision, timing, and diagnostic stderr tail for one stage.

Axial.Hosting

Hosting

Namespace

No description available.

DotNetApp

Module

Standalone .NET process integration for Flow applications that do not use Generic Host.

FiberLogging

Module

Fiber-lifecycle logging through Microsoft.Extensions.Logging.

Hosting

Module

Microsoft Generic Host registration helpers for root Flow applications.

MicrosoftLogging

Module

Adapts Microsoft.Extensions.Logging loggers to Axial's explicit logging service.

FlowHostedService<'env, 'error>

Type

Runs one root Flow application as a Microsoft Generic Host hosted service.

HostedAppOptions

Record

Controls how a root Flow application participates in Generic Host lifetime.

Axial.Hosting.Node

Hosting

Namespace

No description available.

Node

Namespace

No description available.

NodeApp

Module

Node.js signal, argument, and process-exit integration for root Flow applications.

NodeEnvironment

Module

Node.js process environment adaptation for Axial's explicit environment-variable service.

Axial.Hosting.Browser

Hosting

Namespace

No description available.

Browser

Namespace

No description available.

BrowserApp

Module

Browser ownership and AbortSignal integration for root Flow applications.

AbortSignal

Type

A structural binding for the browser and JavaScript AbortSignal contract.

Axial.Telemetry

Telemetry

Namespace

No description available.

Activity

Module

No description available.

ActivityTracer

Module

Creates values.

FiberDumpTelemetry

Module

Exports structured fiber dumps into traces.

FiberMetrics

Module

OpenTelemetry-compatible fiber runtime metrics on the Axial meter.

FiberTelemetry

Module

Telemetry wiring for runtime fiber-lifecycle observation.

ActivityTracer

Type

Captures an application-owned ActivitySource so application code can trace its own workflows without repeating the source at every call site.

Axial.Telemetry.JavaScript

Telemetry

Namespace

No description available.

JavaScript

Namespace

No description available.

FiberTelemetry

Module

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

Module

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

Type

The subset of the OpenTelemetry JS `context` api namespace this package calls.

OpenTelemetryApi

Type

The `@opentelemetry/api` module surface this package consumes: its `trace` and `context` namespaces.

OtelContext

Type

An opaque OpenTelemetry JS `Context`.

Span

Type

The subset of the OpenTelemetry JS `Span` interface this package writes to.

TraceApi

Type

The subset of the OpenTelemetry JS `trace` api namespace this package calls.

Tracer

Type

The subset of the OpenTelemetry JS `Tracer` interface this package calls.