Docs
Packages
GitHub
Axial
Axial
Axial.Process
Axial.HttpClient
Packages
0.10.0
0.10.0
0.9.3
0.9.2
0.9.1
0.9.0
0.8.0
0.7.1
0.7.0
light
dark
Axial
Builders
Module
Package
Axial
Summary
Name
Signature
Synopsis
Operations
flow
flow
The universal flow { } computation expression.
Operations
kind:member
flow
flow
Member
The universal
flow { }
computation expression.
Returns
FlowBuilder
Axial
Filter
Overview
Home
API Reference
Docs
Getting Started
Getting Started
Why Flow?
Installation
Add Axial to an existing Task application
Your First Application
How It Compares
How It Compares
FsToolkit.ErrorHandling Comparison
Task vs Flow: seven scenarios
Effect-TS Comparison
The Flow Type
The Flow Type
Reading the Type
Creating Flows
Running Flows
The Flow CE
Combining Flows
Async and Task interop
Troubleshooting Types
Resources
Error Handling
Error Handling
Bind
Policy and verification
Defects and Exceptions
Dependencies
Dependencies
The Environment
Choosing an Approach
Service Contracts
Providing the Environment
Dependency Tutorials
Dependency Tutorials
Tutorial: Explicit Dependencies First
Tutorial: App Record
Platform Services
Platform Services
Platform Services
Platform Services
Clock
Logging
Randomness and GUIDs
Environment Variables
Console
FileSystem
Tutorial: Composing Built-in Services
Layers
Layers
Composing Layers
Tutorial: Layers
Concurrency and State
Concurrency and State
Fibers
Supervision and Fiber Observability
Ref (Atomic References)
Deferred and Semaphore
STM (Software Transactional Memory)
Queue
Hub
SubscriptionRef
Cache and Memoize
Torture Tests
Torture Tests
Pipeline
Queues
Hubs
Semaphores
Deferreds
Refs
STM
Fibers
Caches
Schedules
Parallel
Errors
Scopes
Layers
Streams
Interop
Scheduling and Retries
Scheduling and Retries
Scopes
Scopes
Streams
Streams
Getting Started
Constructing Streams
Transforming Values
Batching and Parallelism
Composing Streams
Consuming Streams
Platform Boundary
Time and Latest Value
Resources and Results
Observability
Observability
Axial.Telemetry
Axial.Telemetry
JavaScript Telemetry
Telemetry Reference
JavaScript Reference
Platforms and Hosting
Platforms and Hosting
Application Lifecycle
Node Hosting
Tutorial: Runtime Operations
Browser Hosting
Supplying Platform Services
.NET Hosting
Testing
Testing
Runnable Examples
Advanced
Advanced
Providing Services from a Package
Tutorial: Creating Reusable Services
Write an effect-boundary analyzer
Notes
Notes
Packages and platforms
Effect-boundary guardrails
API Reference
Axial
App
Operations
start
startWithCancellation
run
runWithCancellation
Bind
Operations
error
mapError
Builders
Operations
flow
Cache
Operations
make
get
invalidate
invalidateAll
count
Cause
Operations
map
thenCause
both
traced
untraced
failures
defects
isInterrupted
prettyPrint
ColdTask
Operations
create
fromTaskFactory
awaitStartedTask
fromValueTaskFactory
fromValueTaskFactoryWithoutCancellation
awaitStartedValueTask
run
Deferred
Operations
make
await
completeNow
succeedNow
failNow
dieNow
interruptNow
complete
succeed
fail
die
interrupt
Dequeue
Operations
take
poll
takeUpTo
takeBetween
takeAll
size
stats
capacity
shutdown
isShutdown
awaitShutdown
Exit
Operations
map
bind
mapError
mapBoth
fromResult
toResult
Fiber
Operations
dump
join
await
poll
interrupt
FiberDump
Operations
ofMetadata
renderAt
renderTreeAt
FiberObserver
Operations
none
compose
FiberSlot
Operations
make
makeKeyed
interrupt
interruptAll
count
Flow
Operations
scopeAsyncFinalizer
ofExit
scopeFinalizer
scopeDisposable
scopeAsyncDisposable
scopeResource
scopeAcquireRelease
scoped
fromAsync
fromAsyncResult
attemptAsync
fromBlocking
fromBlockingResult
attemptBlocking
fromTask
fromTaskResult
attemptTask
fromValueTask
fromValueTaskResult
attemptValueTask
awaitStartedTask
awaitStartedTaskResult
attemptStartedTask
awaitStartedValueTask
awaitStartedValueTaskResult
attemptStartedValueTask
ok
succeed
error
fail
die
fromResult
verify
withFiberObserver
addFiberObserver
withFiberRegistry
withAnnotationSink
addAnnotationSink
annotate
withTraceId
cancellationToken
ensureNotCanceled
catchCancellation
sleep
scope
annotations
traceId
fiberId
timeout
timeoutToOk
timeoutToError
timeoutWith
retry
repeat
supervise
fork
forkNamed
forkGraceful
forkDetached
memoize
forkReplacing
forkReplacingKey
zipPar
sequencePar
race
fromOption
fromValueOption
orElseFlow
env
envWith
map
ignore
bind
(>>=)
tap
tapError
mapError
widenError
tracedError
mapBoth
fold
onExit
ensuring
onInterrupt
never
catch
orElseWith
orElse
zip
map2
apply
map3
(<!>)
(<*>)
localEnv
delay
traverse
traversePar
traverseParUsing
forEachPar
forEachParUsing
sequence
toAsync
startTask
run
FlowStream
Operations
localEnv
unfoldFlow
fromDequeue
fromHub
fromSchedule
runIntoQueue
runIntoHub
buffer
mergePar
fromSeq
empty
singleton
fromFlow
runForEach
map
mapError
filter
choose
tapFlow
mapFlow
mapFlowPar
mapFlowParUsing
groupedWithin
debounce
throttle
switchMapFlow
chunkBySize
take
skip
takeWhile
skipWhile
indexed
scan
distinctUntilChangedBy
append
collect
zip
runFold
runCollect
runDrain
runForEachFlow
repeatFlow
using
runTryHead
runTryLast
runCount
Hub
Operations
make
makeScoped
publish
publishAll
tryPublish
tryPublishNow
subscribe
subscriberCount
shutdown
isShutdown
awaitShutdown
Never
Operations
absurd
Parallelism
Operations
bounded
ofProcessors
Policy
Operations
lift
withError
context
pass
compose
optional
PublishResult
Operations
empty
add
Queue
Operations
make
makeScoped
bounded
dropping
sliding
unbounded
offer
tryOffer
offerAll
Resource
Operations
create
finalizer
ofAsync
asyncFinalizer
Retry
Operations
defaults
schedule
Schedule
Operations
recurs
spaced
exponential
jitteredWith
union
intersect
fixedRate
whileInput
untilInput
recursAtMost
map
elapsed
whileOutput
untilOutput
upTo
andThen
resetAfter
Semaphore
Operations
make
withPermit
State
Ref
Operations
make
get
set
update
modify
getAndSet
getAndUpdate
updateAndGet
STM
Operations
retry
orElse
atomically
StmBuilders
Operations
stm
SubscriptionRef
Operations
make
get
set
update
modify
changes
TRef
Operations
make
get
set
update
Ref<'T>
STM<'T>
StmBuilder
Operations
``.ctor``
Bind
Combine
Delay
Return
ReturnFrom
Zero
SubscriptionRef<'a>
TRef<'T>
Telemetry
AttributeKey
Operations
string
boolean
int64
float
strings
booleans
integers
floats
Context
Operations
attribute
empty
ofAttributes
add
addMany
tryFind
toSeq
endUserId
addEndUserId
withContext
withAttribute
withAttributes
withEndUserId
current
withSink
addSink
Keys
Operations
endUserId
Attribute
Representation
AttributeValue
Key
Name
Value
AttributeKey<'value>
Representation
Name
Encode
Decode
AttributeValue
Union cases
IsIntegerValue
IsFloatValues
IsBooleanValues
IsStringValue
IsIntegerValues
IsStringValues
IsBooleanValue
IsFloatValue
StringValue
BooleanValue
IntegerValue
FloatValue
StringValues
BooleanValues
IntegerValues
FloatValues
TelemetryContext
AppHandle<'error, 'value>
Operations
Stop
Completion
Status
AppStatus
Union cases
IsStopping
IsCompleted
IsRunning
Running
Stopping
Completed
Backoff
Union cases
IsFixed
IsNoDelay
IsExponential
NoDelay
Fixed
Exponential
BindError<'env, 'error, 'value>
Cache<'key, 'error, 'value>
Cause<'error>
Union cases
IsThen
IsTraced
IsFail
IsInterrupt
IsBoth
IsDie
Fail
Die
Interrupt
Then
Both
Traced
ClockEnvironment
Operations
``.ctor``
Clock
ColdTask<'value>
Union cases
ColdTask
Deferred<'error, 'value>
Dequeue<'a>
EnvFlow<'env, 'value>
Exit<'value, 'error>
Union cases
IsSuccess
IsFailure
Success
Failure
ExnEnvFlow<'env, 'value>
ExnFlow<'value>
Fiber<'error, 'value>
Operations
Metadata
FiberDump
Representation
RenderAt
Id
Name
ParentId
Annotations
StartedAt
StartedTick
SettledAt
SettledTick
Status
FiberId
Union cases
Value
FiberId
FiberMetadata
Representation
Id
Name
ParentId
Annotations
StartedAt
StartedTick
SettledAt
SettledTick
Status
FiberObserver
Representation
OnStart
OnEnd
OnUnobservedDefect
FiberRegistry
Operations
``.ctor``
``.ctor``
DumpAt
Interrupt
InterruptByName
Settled
Snapshot
Stats
UnobservedDefects
Observer
LiveFiberCount
HistoryCapacity
StartedCount
FiberSlot<'error, 'value>
FiberStats
Representation
Name
Count
Failed
Interrupted
TotalDuration
MaxDuration
FiberStatus
Union cases
IsRunning
IsFailed
IsSucceeded
IsInterrupted
Running
Succeeded
Failed
Interrupted
Flow<'env, 'error, 'value>
Union cases
RunSynchronously
StartAsTask
StartAsValueTask
ToAsync
Flow<'value>
Flow<'error, 'value>
FlowBuilder
Operations
``.ctor``
Bind
Combine
Delay
For
Return
ReturnFrom
Run
Source
TryFinally
TryWith
Using
While
Zero
FlowSemaphore
FlowStream<'env, 'error, 'value>
Union cases
FlowStream
FlowStream<'value>
FlowStream<'error, 'value>
Hub<'a>
HubTryPublishResult
Union cases
IsPublished
IsFull
IsBusy
IsShutdown
Published
Busy
Full
Shutdown
IClock
Operations
Elapsed
Sleep
UtcNow
IHasClock
Operations
Clock
KeyedFiberSlot<'key, 'error, 'value>
LogLevel
Union cases
IsTrace
IsDebug
IsCritical
IsInformation
IsError
IsWarning
Trace
Debug
Information
Warning
Error
Critical
ManualClock
Operations
``.ctor``
AdvanceBy
AdvanceToNextDeadline
NextDeadline
Sleepers
Never
Parallelism
Policy<'env, 'error, 'input, 'output>
PublishResult
Representation
Delivered
Dropped
Evicted
Queue<'a>
QueueStats
Representation
Size
Capacity
Accepted
Dropped
Evicted
WaitingTakers
WaitingOfferers
IsShutdown
QueueStrategy
Union cases
IsUnbounded
IsDropping
IsBackPressure
IsSliding
BackPressure
Dropping
Sliding
Unbounded
QueueTryOfferResult
Union cases
IsDropped
IsFull
IsShutdown
IsAccepted
IsEvicted
Accepted
Full
Dropped
Evicted
Shutdown
Resource<'env, 'error, 'value>
Retry<'input>
Representation
Retries
Backoff
When
Schedule<'env, 'input, 'output>
Scope
Operations
``.ctor``
AddAsyncDisposable
AddChild
AddDisposable
AddFinalizer
Close
ServiceProvider
Operations
get
SettledFiber
Representation
Duration
Fiber
Failure
StreamStep<'value, 'error>
Union cases
IsNext
IsDone
Done
Next
UnobservedDefect
Representation
Fiber
Defect
Axial.Layers
Builders
Operations
layer
Layer
Operations
fromAsync
fromValueTask
fromTask
succeed
envWith
addFinalizer
acquireRelease
pool
map
mapError
widenError
bind
zip
zipPar
merge
map2
apply
map3
provide
Layer<'input, 'error, 'output>
Pool<'resource>
Operations
Next
Count
Instances
Axial.PlatformService
BaseRuntime
Operations
liveValue
live
fromServiceProvider
Clock
Operations
service
now
utcDateTime
unixTimeSeconds
unixTimeMilliseconds
elapsed
timed
live
fromValue
layer
EnvironmentVariable
Operations
get
tryGet
getInt
getInt64
getDouble
getDecimal
getGuid
getUri
getTimeSpan
getBool
EnvironmentVariableErrors
Operations
describe
EnvironmentVariables
Operations
service
tryGet
getAll
set
clear
expand
live
fromPairs
layer
Guid
Operations
service
newGuid
live
fromValue
layer
Log
Operations
service
log
trace
debug
info
warning
error
critical
logException
errorExn
criticalExn
live
fromSink
layer
Random
Operations
service
next
nextMax
nextInt
nextDouble
nextBytes
bytes
live
fromValue
fromFixed
layer
BaseRuntime
Representation
Clock
Log
Random
Guid
EnvironmentVariables
BaseRuntimeError
Union cases
MissingService
EnvironmentVariableError
Union cases
IsMissingVariable
IsInvalidVariable
MissingVariable
InvalidVariable
IEnvironmentVariables
Operations
Expand
GetAll
Set
TryGet
IGuid
Operations
NewGuid
IHasEnvironmentVariables
Operations
EnvironmentVariables
IHasGuid
Operations
Guid
IHasLog
Operations
Log
IHasRandom
Operations
Random
ILog
Operations
Log
LogException
IRandom
Operations
Next
NextBytes
NextDouble
NextInt
NextMax
Axial.Console
Console
Operations
service
input
output
error
inputEncoding
setInputEncoding
outputEncoding
setOutputEncoding
isInputRedirected
isOutputRedirected
isErrorRedirected
keyAvailable
read
readLine
readKey
write
writeLine
writeError
writeErrorLine
openStandardInput
openStandardOutput
openStandardError
clear
beep
resetColor
foregroundColor
setForegroundColor
backgroundColor
setBackgroundColor
cursorPosition
setCursorPosition
cursorVisible
setCursorVisible
title
setTitle
treatControlCAsInput
setTreatControlCAsInput
live
IConsole
Operations
Beep
Clear
OpenStandardError
OpenStandardInput
OpenStandardOutput
Read
ReadKey
ReadLine
ResetColor
SetCursorPosition
Write
WriteError
WriteErrorLine
WriteLine
Error
TreatControlCAsInput
InputEncoding
IsInputRedirected
OutputEncoding
BackgroundColor
ForegroundColor
IsOutputRedirected
Title
In
Out
CursorVisible
KeyAvailable
CursorLeft
CursorTop
IsErrorRedirected
IHasConsole
Operations
Console
Axial.FileSystem
FileSystem
Operations
service
readAllText
readAllTextWithEncoding
readAllTextAsync
readAllLines
readAllLinesWithEncoding
readAllLinesAsync
readAllBytes
readAllBytesAsync
writeAllText
writeAllTextWithEncoding
writeAllTextAsync
writeAllLines
writeAllLinesWithEncoding
writeAllLinesAsync
writeAllBytes
writeAllBytesAsync
appendAllText
appendAllTextWithEncoding
appendAllTextAsync
appendAllLines
appendAllLinesWithEncoding
fileExists
exists
deleteFile
copyFile
moveFile
createFileSymbolicLink
createDirectorySymbolicLink
getSymbolicLinkTarget
resolveSymbolicLinkTarget
openFile
openFileWithAccess
openFileWithShare
openRead
openText
openWrite
createFile
createText
appendText
getFileLength
getFileAttributes
setFileAttributes
getFileCreationTime
getFileCreationTimeUtc
setFileCreationTime
setFileCreationTimeUtc
getFileLastAccessTime
getFileLastAccessTimeUtc
setFileLastAccessTime
setFileLastAccessTimeUtc
getFileLastWriteTime
getFileLastWriteTimeUtc
setFileLastWriteTime
setFileLastWriteTimeUtc
directoryExists
createDirectory
deleteDirectory
moveDirectory
enumerateFiles
getFiles
enumerateDirectories
getDirectories
enumerateFileSystemEntries
getFileSystemEntries
getLogicalDrives
getDirectoryRoot
getParent
getCurrentDirectory
setCurrentDirectory
getDirectoryCreationTime
getDirectoryCreationTimeUtc
setDirectoryCreationTime
setDirectoryCreationTimeUtc
getDirectoryLastAccessTime
getDirectoryLastAccessTimeUtc
setDirectoryLastAccessTime
setDirectoryLastAccessTimeUtc
getDirectoryLastWriteTime
getDirectoryLastWriteTimeUtc
setDirectoryLastWriteTime
setDirectoryLastWriteTimeUtc
combine
changeExtension
getDirectoryName
getInvalidFileNameChars
getInvalidPathChars
getExtension
getFileName
getFileNameWithoutExtension
getFullPath
getPathRoot
getRelativePath
getTempPath
getTempFileName
getRandomFileName
hasExtension
endsInDirectorySeparator
trimEndingDirectorySeparator
isPathFullyQualified
isPathRooted
live
FileSystemError
Operations
fromException
describe
FileSystemError
Union cases
IsDirectoryNotFound
IsIo
IsUnsupported
IsInvalidPath
IsAlreadyExists
IsFileNotFound
IsUnexpected
IsPathTooLong
IsUnauthorized
FileNotFound
DirectoryNotFound
AlreadyExists
Unauthorized
InvalidPath
PathTooLong
Io
Unsupported
Unexpected
IFileSystem
Operations
AppendAllLines
AppendAllLines
AppendAllText
AppendAllText
AppendAllTextAsync
AppendText
ChangeExtension
Combine
CopyFile
CreateDirectory
CreateDirectorySymbolicLink
CreateFile
CreateFileSymbolicLink
CreateText
DeleteDirectory
DeleteFile
DirectoryExists
EndsInDirectorySeparator
EnumerateDirectories
EnumerateFileSystemEntries
EnumerateFiles
FileExists
GetCurrentDirectory
GetDirectories
GetDirectoryCreationTime
GetDirectoryCreationTimeUtc
GetDirectoryLastAccessTime
GetDirectoryLastAccessTimeUtc
GetDirectoryLastWriteTime
GetDirectoryLastWriteTimeUtc
GetDirectoryName
GetDirectoryRoot
GetExtension
GetFileAttributes
GetFileCreationTime
GetFileCreationTimeUtc
GetFileLastAccessTime
GetFileLastAccessTimeUtc
GetFileLastWriteTime
GetFileLastWriteTimeUtc
GetFileLength
GetFileName
GetFileNameWithoutExtension
GetFileSystemEntries
GetFiles
GetFullPath
GetInvalidFileNameChars
GetInvalidPathChars
GetLogicalDrives
GetParent
GetPathRoot
GetRandomFileName
GetRelativePath
GetSymbolicLinkTarget
GetTempFileName
GetTempPath
HasExtension
IsPathFullyQualified
IsPathRooted
MoveDirectory
MoveFile
OpenFile
OpenFile
OpenFile
OpenRead
OpenText
OpenWrite
ReadAllBytes
ReadAllBytesAsync
ReadAllLines
ReadAllLines
ReadAllLinesAsync
ReadAllText
ReadAllText
ReadAllTextAsync
ResolveSymbolicLinkTarget
SetCurrentDirectory
SetDirectoryCreationTime
SetDirectoryCreationTimeUtc
SetDirectoryLastAccessTime
SetDirectoryLastAccessTimeUtc
SetDirectoryLastWriteTime
SetDirectoryLastWriteTimeUtc
SetFileAttributes
SetFileCreationTime
SetFileCreationTimeUtc
SetFileLastAccessTime
SetFileLastAccessTimeUtc
SetFileLastWriteTime
SetFileLastWriteTimeUtc
TrimEndingDirectorySeparator
WriteAllBytes
WriteAllBytesAsync
WriteAllLines
WriteAllLines
WriteAllLinesAsync
WriteAllText
WriteAllText
WriteAllTextAsync
IHasFileSystem
Operations
FileSystem
Axial.Hosting
DotNetApp
Operations
exitCode
run
FiberLogging
Operations
observer
observe
Hosting
Operations
addApp
addAppWith
MicrosoftLogging
Operations
create
fromFactory
layer
FlowHostedService<'env, 'error>
Operations
``.ctor``
HostedAppOptions
Representation
Default
StopHostOnCompletion
Axial.Hosting.Node
NodeApp
Operations
arguments
exitCode
start
run
NodeEnvironment
Operations
live
Axial.Hosting.Browser
BrowserApp
Operations
mount
startWithSignal
AbortSignal
Axial.Telemetry
Activity
Operations
runtimeSource
traceWithSource
traceOn
withTracer
traceWith
trace
ActivityTracer
Operations
create
FiberDumpTelemetry
Operations
record
FiberMetrics
Operations
meter
observer
observe
FiberTelemetry
Operations
observer
observe
observerWithSpans
observeWithSpans
QueueMetrics
Operations
observe
ActivityTracer
Operations
Trace
TraceWith
Source
Axial.Telemetry.JavaScript
FiberTelemetry
Operations
observer
observe
observerWithSpans
observeWithSpans
Otel
Operations
installNamed
install
installWith
uninstall
traceWith
trace
ContextApi
Operations
active
``with``
OpenTelemetryApi
Operations
trace
context
OtelContext
Span
Operations
``end``
setAttribute
setStatus
spanContext
TraceApi
Operations
getTracer
setSpan
Tracer
Operations
startSpan
