Axial.Guardrails
0.14.1
Prefix Reserved
dotnet add package Axial.Guardrails --version 0.14.1
NuGet\Install-Package Axial.Guardrails -Version 0.14.1
<PackageReference Include="Axial.Guardrails" Version="0.14.1" />
<PackageVersion Include="Axial.Guardrails" Version="0.14.1" />
<PackageReference Include="Axial.Guardrails" />
paket add Axial.Guardrails --version 0.14.1
#r "nuget: Axial.Guardrails, 0.14.1"
#:package Axial.Guardrails@0.14.1
#addin nuget:?package=Axial.Guardrails&version=0.14.1
#tool nuget:?package=Axial.Guardrails&version=0.14.1
Axial
<picture> <source media="(prefers-color-scheme: dark)" srcset="docs/content/img/axial-readme-dark.svg"> <source media="(prefers-color-scheme: light)" srcset="docs/content/img/axial-readme-light.svg"> <img alt="Axial" src="docs/content/img/axial-readme-light.svg" width="160"> </picture>
Write asynchronous F# workflows whose expected failures and required dependencies are visible in their types.
Axial is pre-1.0 and its API may change before the first stable release.
Your first flow
A handler usually needs services and can fail, but a Task signature shows neither fact. Flow<'env, 'error, 'value>
makes both part of the contract.
open Axial
type CheckoutError =
| OrderNotFound of orderId: int
| PaymentDeclined of reason: string
type Receipt = { OrderId: int; Total: decimal; Reference: string }
type CheckoutEnv =
{ FindTotal: int -> ColdTask<Result<decimal, CheckoutError>>
Charge: decimal -> ColdTask<Result<string, CheckoutError>> }
let checkout orderId : Flow<CheckoutEnv, CheckoutError, Receipt> =
flow {
let! findTotal = Flow.envWith _.FindTotal
let! charge = Flow.envWith _.Charge
let! total = findTotal orderId
let! reference = charge total
return { OrderId = orderId; Total = total; Reference = reference }
}
The application supplies live functions. A test supplies a record of fakes. The workflow does not change.
Adding a timeout and a retry policy leaves the Flow<CheckoutEnv, CheckoutError, Receipt> signature unchanged.
The runtime supplies its clock and owns cancellation, retries, and cleanup:
open System
let checkoutOrder orderId : Flow<CheckoutEnv, CheckoutError, Receipt> =
checkout orderId
|> Flow.retry (Schedule.recurs 2)
|> Flow.timeout (TimeSpan.FromSeconds 5.0) (PaymentDeclined "checkout timed out")
Flow also carries concurrency, scheduling, streams, and structured child fibers through the same runtime.
Clock, random and GUID values are scoped runtime services; application authority stays in 'env. Use
Flow.withClock, Flow.withRandom and Flow.withGuid to override values for a flow and its descendants.
Log.info writes to the current ILogSink (Information+ on stderr by default); install or decorate destinations
with Flow.withLogSink / Flow.mapLogSink, and observation callbacks with Flow.withTelemetry.
Core Axial ships these runtime services under the Axial namespace. Flow.runTest env creates a
fresh epoch manual clock, seeded random, sequential GUIDs and a recording log. Timed tests explicitly advance
TestClock after observing sleeper registration; time never advances automatically. See runtime services.
Install
dotnet add package Axial
Package family
Axial: the core workflow model: typed failures, dependencies, concurrency, resources, schedules, streams, and runtime platform services.Axial.Process: external process composition, pipelines, streaming output, typed failures, cancellation, and cleanup. Process docsAxial.HttpClient: typed HTTP requests, response handling, and reliability policies. HTTP docsAxial.Configuration: layered environment, argument, JSON, browser, and Microsoft configuration decoded by Reified, with redacted secrets. Configuration docsAxial.Console: standard streams, redirection, and terminal control. Console docsAxial.FileSystem: file-system access, streaming traversal, atomic writes, and the append log. FileSystem docsAxial.WebSocket: typed WebSocket client sessions and errors. WebSocket docsAxial.Hosting,Axial.Hosting.AspNetCore,Axial.Hosting.GenHttp,Axial.Hosting.Node, andAxial.Hosting.Browser: host adapters. Hosting docsAxial.ElmishFlows: Elmish commands and subscriptions backed by workflows. Elmish docsAxial.TelemetryandAxial.Telemetry.JavaScript: .NET and Fable tracing, metrics, and dumps. Telemetry docsAxial.GuardrailsandAxial.Tool: effect-boundary analysis and theaxialpolicy CLI. Guardrails docs
See the package maturity table for each package's rating and application evidence. The package catalogue links the first-class libraries and the complete compatibility matrix.
Documentation and examples
- Getting started
- Add Axial to an existing Task application
- Failures and defects
- Dependencies and services
- Concurrency
- Process
- HTTP client
- Runnable examples
- Integration reference application and HTTP host examples
Reified integration
Reified declares value, model, JSON, and HTTP contracts. Axial's optional server adapters execute Reified HTTP contracts as workflows; neither core depends on the other. Axial 0.12 requires Reified 0.12.1 or later, whose Fable schema builder supports typed schema construction and Config.load decoding on Fable.
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 0.14.1 | 96 | 11/8/2026 |
| 0.14.0 | 89 | 11/8/2026 |
| 0.13.0 | 116 | 11/7/2026 |
| 0.12.0 | 108 | 11/5/2026 |
| 0.11.3 | 110 | 10/19/2026 |
| 0.11.2 | 107 | 10/19/2026 |
| 0.11.1 | 92 | 10/19/2026 |
| 0.11.0 | 114 | 10/19/2026 |
| 0.10.0 | 160 | 10/1/2026 |
| 0.9.3 | 324 | 9/14/2026 |
| 0.9.2 | 122 | 9/14/2026 |
| 0.9.1 | 114 | 9/11/2026 |
| 0.9.0 | 107 | 9/11/2026 |
| 0.8.0 | 105 | 9/11/2026 |
| 0.7.1 | 137 | 8/18/2026 |
| 0.7.0 | 152 | 8/17/2026 |