Interface ZExecutionInit<TResult>

Execution initializer.

Returned from execution starter to construct new executions.

Type Parameters

TResult

Execution result type.

Hierarchy

ZExecutionInit

Index

Methods

abort? whenDone whenStarted?

Methods

`Optional` abort

abort(): void
Aborts the execution.

When omitted the execution won't be aborted

Returns void
- Defined in run-z/exec-z/src/exec.ts:51

whenDone

whenDone(): TResult | PromiseLike<TResult>
Constructs a promise that resolves to execution result.

Returns TResult | PromiseLike<TResult>
Either execution result, or a promise-like instance resolved to the one.
- Defined in run-z/exec-z/src/exec.ts:44

`Optional` whenStarted

whenStarted(): void | PromiseLike<unknown>
Constructs a promise resolved when execution starts.

When omitted the execution is started when starter finishes its work.

Returns void | PromiseLike<unknown>
Either none, or a promise-like instance resolved when execution started, or rejected when it is aborted before being started.
- Defined in run-z/exec-z/src/exec.ts:37

Generated using TypeDoc