Interface Task

interface Task {
    cancel(): void;
    name(): string;
    run(): Promise<void>;
    setParent(parentTask: Task): void;
}

Implemented by

Index

Methods

cancel name run setParent

Methods

cancel

cancel(): void
Attempts to cancel the task. The task may still succeed if it is unable to be canceled. If the task is canceled, then its [[run]] function will reject the promise. If [[cancel]] is called before [[run]], then [[run]] must immediately reject the returned promise. If [[cancel]] is called after [[run]], then nothing happens.

Returns void
- Defined in src/task/Task.ts:21

name

name(): string
Describes the task for the purpose of logging.

Returns string
- Defined in src/task/Task.ts:12

run

run(): Promise<void>
Runs the unit of work until it either succeeds and fulfills the promise or fails and rejects the promise. Where possible it should listen for the cancellation signal, stop working, and reject the promise. If run is called more than once, it should immediately reject the promise.

Returns Promise<void>
- Defined in src/task/Task.ts:29

setParent

setParent(parentTask: Task): void
Sets the parent of this task for the purpose of logging.
Parameters
- parentTask: Task
Returns void
- Defined in src/task/Task.ts:34