Reference
Module index for the public FsFlow API surface.
API Reference
This categorical index covers the workflow surface, the capability helpers, the pure validation bridge, and the CAPS support packages.
The FsFlow ecosystem groups the main public surfaces:
Flow<'env, 'error, 'value>and theFlowmoduleCapabilityfor named capability helpers and environment accessCheckfor pureResult<'value, unit>predicatesValidationfor accumulated diagnosticsDiagnosticsfor the structured validation graphReffor atomic mutable referencesSchedulefor retry and repeat policiesSTMfor software transactional memoryStreamfor effectful pull-based streams- the
flow {}andvalidate {}entry points - the CAPS request tokens
Needs<'dep>andEnv<'dep>/Env<'dep, 'value>for explicit capability boundaries - the shared primitives
FsFlow.Caps.Core - the live capabilities
FsFlow.Caps.Console,FileSystem,Http, andProcess - the host integration
FsFlow.Hosting - the observability integration
FsFlow.Runtime.Telemetry
The builder types themselves stay below the surface. The modules are the public story.
Read the subpages
Execution boundaries
Type, module, composition, environment, and execution in the flow family.
Named capability helpers
Request tokens, service lookup, and environment/layer composition.
Pure checks
Pure predicates and the bridge to effectful error creation.
Accumulating validation
The Validation type and validate {} builder for collecting diagnostics.
Structured diagnostics
The validation graph and the helpers that render and flatten it.
Atomic references
Thread-safe mutable state handles for concurrent workflows.
Execution policies
DSL for describing retry and repetition strategies.
Transactional memory
Composable atomic transactions across multiple state variables.
Effectful streams
Asynchronous, pull-based streams with environment and error support.
Shared primitives
The clock, random, GUID, and environment-variable package.
System IO
Console, FileSystem, HTTP, and Process capability packages.
Host integration
Microsoft.Extensions.DependencyInjection and startup validation.
Observability
OpenTelemetry and Activity.trace integration.