Flow<'env, 'error, 'value>Union
PackageAxial
Represents a cold workflow that reads an environment, returns a typed result, and is executed
explicitly through one of its execution members such as
ToTask, ToAsync, or RunSynchronously.
Specification
Kind
Union
Members
4
Examples
0
RunSynchronouslySignature
this.RunSynchronously
StartAsTaskSignature
this.StartAsTask
StartAsValueTaskSignature
this.StartAsValueTask
ToAsyncSignature
this.ToAsync
Summary
| Name | Signature | Synopsis |
|---|---|---|
| RunSynchronously | this.RunSynchronously | Starts the workflow and blocks until the final exit is available. |
| StartAsTask | this.StartAsTask | Starts the workflow immediately and returns a task handle for its final exit. |
| StartAsValueTask | this.StartAsValueTask | Starts the workflow immediately and returns a value-task handle for its final exit. |
| ToAsync | this.ToAsync | Builds a cold async that runs the workflow when it is started. |
Starts the workflow and blocks until the final exit is available.
Parameters
| Name | Type | Description |
|---|---|---|
| environment | 'env | The environment used by the workflow. |
| timeout | int | |
| cancellationToken | CancellationToken |
Returns
Exit<'value, 'error>
Starts the workflow immediately and returns a task handle for its final exit.
Parameters
| Name | Type | Description |
|---|---|---|
| environment | 'env | The environment used by the workflow. |
| cancellationToken | CancellationToken |
Returns
Task<Exit<'value, 'error>>
Starts the workflow immediately and returns a value-task handle for its final exit.
Parameters
| Name | Type | Description |
|---|---|---|
| environment | 'env | The environment used by the workflow. |
| cancellationToken | CancellationToken |
Returns
ValueTask<Exit<'value, 'error>>