AxialAxial
  • Docs
  • Reference
  • Packages
  • GitHub
  • 0.1.0
    • 0.1.0
  • light
  • dark

AxialNamespace

Contents

StateNamespace

Axial

AppModuleBindModuleBuildersModuleCauseModuleColdTaskModuleDeferredModuleExitModuleFiberModuleFiberDumpModuleFiberObserverModuleFlowModuleFlowStreamModulePolicyModuleRetryPolicyModuleScheduleModuleSemaphoreModuleSupervisePolicyModuleAppHandle<'error, 'value>TypeAppStatusUnionBindError<'env, 'error, 'value>UnionCause<'error>UnionColdTask<'value>UnionDeferred<'error, 'value>UnionEnvFlow<'env, 'value>TypeExit<'value, 'error>UnionExnEnvFlow<'env, 'value>TypeExnFlow<'value>TypeFiber<'error, 'value>RecordFiberDumpRecordFiberIdUnionFiberMetadataRecordFiberObserverRecordFiberRegistryTypeFiberStatusUnionFlow<'env, 'error, 'value>UnionFlow<'value>TypeFlow<'error, 'value>TypeFlowBuilderTypeFlowSemaphoreUnionFlowStream<'env, 'error, 'value>UnionLogLevelUnionNeverUnionPolicy<'env, 'error, 'input, 'output>TypeRetryPolicy<'error>RecordSchedule<'env, 'input, 'output>UnionScopeTypeServiceProviderTypeStreamStep<'value, 'error>UnionSupervisePolicyRecord

On This Page

    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
    • Built-in Services
      • Built-in Services
      • Platform Services
        • Platform Services
        • Clock
        • Logging
        • Randomness and GUIDs
        • Environment Variables
      • Console
      • FileSystem
      • Processes
        • Processes
        • Commands and composition
        • Output and streaming
        • Failures and transcripts
        • Scripts
        • Fable
      • HTTP
        • HTTP
        • Requests
        • Responses And Errors
        • Reliability
      • 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)
    • Scheduling and Retries
      • Scheduling and Retries
    • Streams
      • Streams
    • 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
      • Testing HTTP
      • Runnable Examples
    • Advanced
      • Advanced
      • Providing Services from a Package
      • Scopes and Resources
      • Tutorial: Creating Reusable Services
      • Write an effect-boundary analyzer
    • Notes
      • Notes
      • Packages and platforms
      • Effect-boundary guardrails

    API Reference

    • Axial
      • App
      • Bind
      • Builders
      • Cause
      • ColdTask
      • Deferred
      • Exit
      • Fiber
      • FiberDump
      • FiberObserver
      • Flow
        • Runtime
      • FlowStream
      • Policy
      • RetryPolicy
      • Schedule
      • Semaphore
      • SupervisePolicy
      • State
        • Ref
        • STM
        • StmBuilders
        • TRef
        • Ref<'T>
        • STM<'T>
        • StmBuilder
        • TRef<'T>
      • Telemetry
        • AttributeKey
        • Context
          • Keys
        • Attribute
        • AttributeKey<'value>
        • AttributeValue
        • TelemetryContext
      • AppHandle<'error, 'value>
      • AppStatus
      • BindError<'env, 'error, 'value>
      • Cause<'error>
      • ColdTask<'value>
      • Deferred<'error, 'value>
      • EnvFlow<'env, 'value>
      • Exit<'value, 'error>
      • ExnEnvFlow<'env, 'value>
      • ExnFlow<'value>
      • Fiber<'error, 'value>
      • FiberDump
      • FiberId
      • FiberMetadata
      • FiberObserver
      • FiberRegistry
      • FiberStatus
      • Flow<'env, 'error, 'value>
      • Flow<'value>
      • Flow<'error, 'value>
      • FlowBuilder
      • FlowSemaphore
      • FlowStream<'env, 'error, 'value>
      • LogLevel
      • Never
      • Policy<'env, 'error, 'input, 'output>
      • RetryPolicy<'error>
      • Schedule<'env, 'input, 'output>
      • Scope
      • ServiceProvider
      • StreamStep<'value, 'error>
      • SupervisePolicy
    • Axial.Layers
      • Builders
      • Layer
      • Layer<'input, 'error, 'output>
    • Axial.PlatformService
      • BaseRuntime
      • Clock
      • EnvironmentVariable
      • EnvironmentVariableErrors
      • EnvironmentVariables
      • Guid
      • Log
      • Random
      • BaseRuntime
      • BaseRuntimeError
      • EnvironmentVariableError
      • IClock
      • IEnvironmentVariables
      • IGuid
      • IHasClock
      • IHasEnvironmentVariables
      • IHasGuid
      • IHasLog
      • IHasRandom
      • ILog
      • IRandom
    • Axial.Console
      • Console
      • IConsole
      • IHasConsole
    • Axial.FileSystem
      • FileSystem
      • FileSystemError
      • FileSystemError
      • IFileSystem
      • IHasFileSystem
    • Axial.HttpClient
      • DSL
        • SecretValue
      • Http
      • HttpError
      • Method
      • Request
      • Response
      • HttpError
      • HttpRequest
      • HttpResponse
      • IHasHttp
      • IHttp
      • Method
      • RequestBody
      • RequestPlan
      • StatusExpectation
    • Axial.Process
      • DSL
        • Input
        • Output
        • EndpointConnector
        • SecretArgument
      • Process
      • ProcessError
      • Script
      • CapturedOutput
      • IHasProcess
      • IProcess
      • InputSource
      • OutputChannel
      • OutputFraming
      • OutputTarget
      • ProcessCancellation
      • ProcessError
      • ProcessEvent
      • ProcessIoFailure
      • ProcessOutput
      • ProcessPlan
      • ProcessResult
      • ProcessSpec
      • ProcessStartFailure
      • ProcessTimeout
      • ScriptEnvironment
      • StageFailure
      • StageResult
    • Axial.Hosting
      • DotNetApp
      • FiberLogging
      • Hosting
      • MicrosoftLogging
      • FlowHostedService<'env, 'error>
      • HostedAppOptions
    • Axial.Hosting.Node
      • NodeApp
      • NodeEnvironment
    • Axial.Hosting.Browser
      • BrowserApp
      • AbortSignal
    • Axial.Telemetry
      • Activity
      • ActivityTracer
      • FiberDumpTelemetry
      • FiberMetrics
      • FiberTelemetry
      • ActivityTracer
    • Axial.Telemetry.JavaScript
      • FiberTelemetry
      • Otel
      • ContextApi
      • OpenTelemetryApi
      • OtelContext
      • Span
      • TraceApi
      • Tracer