API Reference

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.

FlowStream

FlowStream<'env, 'error, 'value> describes a cold, pull-based sequence of effectful values.

Hub

Hub<'a> delivers every published value to every current subscription.

Never

Uses the fact that a Never value cannot exist.

Parallelism

Creates Parallelism bounds for parallel Flow and stream operators.

Policy

Constructors and combinators for environment-aware workflow requirements.

PublishResult

Combines PublishResult values, for totalling several publishes.

Queue

Queue<'a> hands values from producer fibers to one logical consumer, in FIFO order, with an overflow strategy chosen when it is created.

Resource

Describes acquisition of a value together with registration of its release in the current Flow scope.

Retry

Constructors for Retry.

Schedule

A Schedule<'env, 'input, 'output> decides, after each run of a flow, whether to run it again and how long to wait first.

Semaphore

Flow-native semaphore 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.

SubscriptionRef

SubscriptionRef<'a> is a reference whose changes can be streamed.

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.

Backoff

How long a Retry waits between attempts.

BindError<'env, 'error, 'value>

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

ClockEnvironment

An environment containing only a clock, for timed flows with no other services.

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.

FiberStats

Totals for every settled fiber that shared a name, as recorded by a FiberRegistry.

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.

HubTryPublishResult

The immediate outcome of publishing from a synchronous callback.

IClock

Supplies wall time, monotonic time, and cancellable delays from one source.

IHasClock

Declares the clock required by timed workflows and fiber diagnostics.

KeyedFiberSlot<'key, 'error, 'value>

Holds at most one running fiber per key; forking into a key with Flow.forkReplacingKey interrupts that key's previous fiber.

LogLevel

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

ManualClock

A clock that advances only when a test or simulator asks it to.

QueueStats

A snapshot of a queue's backlog and of what it has done with offered values since it was created.

QueueStrategy

What a queue, or a hub subscription, does with a value offered while it is full.

QueueTryOfferResult

The immediate outcome of Queue.tryOffer.

Scope

A Scope owns finalizers for resources and child fibers.

ServiceProvider

Reads services from an IServiceProvider environment.

SettledFiber

A forked fiber that has settled, as recorded by a FiberRegistry.

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.

UnobservedDefect

A defect that nobody observed, as recorded by a FiberRegistry.

Axial.Layers

Builders

No description available.

Layer

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.

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.

IEnvironmentVariables

Provides environment-variable access supplied by the application host.

IGuid

Provides synchronous GUID generation.

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.

QueueMetrics

OpenTelemetry-compatible queue and hub-subscription metrics on the Axial meter.