Axial

AppHandle<'error, 'value>Type

PackageAxial
Owns one running root workflow and provides coordinated application shutdown.

Specification

Kind
Type
Members
4
Examples
0
StopSignature
this.Stop
StopAndWaitSignature
this.StopAndWait
StatusSignature
this.Status
CompletionSignature
this.Completion

Summary

NameSignatureSynopsis
Operations
Stopthis.StopRequests cooperative interruption and waits for the final application exit.
StopAndWaitthis.StopAndWaitRequests stop and blocks until the root and its finalizers settle, or the timeout expires.
Statusthis.StatusGets the current application lifecycle state.
Completionthis.CompletionWaits for the root workflow and its scope finalizers to complete.

Operations

kind:member

Stop

this.Stop
Member
Requests cooperative interruption and waits for the final application exit.

Returns

Async<Exit<'value, 'error>>
kind:member

StopAndWait

this.StopAndWait
Member
Requests stop and blocks until the root and its finalizers settle, or the timeout expires. Safe on UI threads.

Parameters

NameTypeDescription
timeoutTimeSpan

Returns

bool
kind:member

Status

this.Status
Member
Gets the current application lifecycle state.

Returns

AppStatus
kind:member

Completion

this.Completion
Member
Waits for the root workflow and its scope finalizers to complete.

Returns

Async<Exit<'value, 'error>>