API Reference
Axial
App
App
Bind
Creates error-adaptation markers for let!, do!, and return!
Builders
No description available.
Cache
Cache
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.
Dequeue
Dequeue<'a> is the consuming side of a queue.
Exit
Represents the final outcome of a workflow execution.
Fiber
Fiber
FiberDump
Snapshot conversion and rendering for fiber dumps.
FiberLocal
A value scoped to the current fiber and inherited by fibers forked within its scope.
FiberObserver
Standard fiber observers.
FiberSlot
Creates and clears FiberSlot and KeyedFiberSlot values.
Flow
Flow
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 each value from producer fibers to exactly one taker, in FIFO order, with an overflow strategy chosen when it is created.
Resource
Resource
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.
SemaphoreSlim
Flow-native bridges to SemaphoreSlim.
Ref
Ref<'T> holds a mutable value that concurrent workflows update atomically.
STM
STM<'T> is a composable transaction: a value describing reads and writes that commit together.
StmBuilders
No description available.
SubscriptionRef
SubscriptionRef<'a> is a reference whose changes can be streamed.
TPromise
A transactional promise that blocks readers until it is completed.
TQueue
A transactional FIFO queue, built from a transactional reference.
TRef
TRef<'T> is a transactional reference: a variable read and written inside an STM transaction.
TSemaphore
A transactional semaphore, built from a transactional reference.
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.
CallbackOverflow<'error>
What a callback stream does when its buffer is full.
ClockEnvironment
An environment containing only a clock, for timed flows with no other services.
Emit<'error, 'value>
Synchronous, thread-safe callback sink.
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
A FiberRegistry (core Axial, no telemetry dependency) tracks every live fiber below one edge install and answers "what is my runtime doing right now?" Install it with Flow.withFiberRegistry; registry.DumpAt(clock) renders the tree and registry.Snapshot() returns structured FiberDump values.
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.
UnrecoveredFailureException
A typed failure retained as a defect when changing a compound cause's error type.
Axial.Layers
Builders
No description available.
Layer
Layer<'input, 'error, 'output> builds an environment or service bundle from an input value, running inside a Scope so acquired resources are finalized when the provided flow finishes.
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.
TestRuntime
Helpers for constructing deterministic test environments.
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.
LogEntry
A single entry recorded by a TestLog.
TestLog
A test double for ILog that records entries for assertions.
Axial.ElmishFlows
Cmd
Axial.ElmishFlows.Cmd turns Axial workflows into Elmish commands.
OfFlow
OfFlow
Latest
Latest
ElmishRuntime
ElmishRuntime<'env> owns the root scope for all commands in one Elmish program.
Inbox
Inbox<'value> is a dropping queue for synchronous UI input, created by Inbox.create capacity runtime.
Sub
Axial.ElmishFlows.Sub connects FlowStream subscriptions to an Elmish program.
OfFlowStream
OfFlowStream
TestRuntime
ElmishRuntime.test env creates a test runtime with queued delivery.
CommandDefect
A command defect rendered without F# structural formatting.
ElmishRuntimeOptions
Host delivery and diagnostic policy.
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.
TestConsole
An in-memory console test double backed by string readers and writers.
Axial.FileSystem
FileSystem
IFileSystem makes file access an explicit, mockable dependency.
FileSystemError
Describes a meaningful file-system failure.
FileSystemChange
A change reported by a file-system watcher.
FileSystemChangeKind
No description available.
FileSystemEntry
Metadata captured for a file or directory during enumeration.
FileSystemEntryKind
Distinguishes files from directories in a listing.
IFileSystem
Provides access to common file, directory, and path operations.
IHasFileSystem
No description available.
TestFileSystem
An in-memory file-system test double for the common read/write/enumerate surface.
Axial.Files
Axial.Hosting
Configuration
Adapts Microsoft configuration to Axial's explicit environment-variable service.
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.
HttpFactory
Adapts IHttpClientFactory to Axial's HTTP service.
MicrosoftLogging
Adapts Microsoft.Extensions.Logging loggers to Axial's explicit logging service.
SystemdNotify
Systemd notification transport with an explicitly supplied socket address.
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.
ISystemdNotifier
Transport for systemd notification datagrams.
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
FiberMetrics.observe installs a fiber observer that records runtime health onto the Axial Meter.
FiberTelemetry
Telemetry wiring for runtime fiber-lifecycle observation.
Metrics
Flow-native helpers for application-defined metrics over Meter.
QueueMetrics
OpenTelemetry-compatible queue and hub-subscription metrics on the Axial meter.
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.