Interface Task<Args, Result>

Represents an async task.

interface Task<Args extends any[] = [], Result = void> {
    cancel(): void;
    delay(delay: number, ...args: Args): CancelablePromise<Result>;
    delayIfNotQueued(delay: number, ...args: Args): CancelablePromise<Result>;
    isRunning(): boolean;
    run(...args: Args): CancelablePromise<Result>;
}

Type Parameters

Args extends any[] = []
Result = void

Index

Methods

cancel delay delayIfNotQueued isRunning run

Methods

cancel

cancel(): void
Cancels the current execution.

Returns void
- Defined in AsyncTask.ts:26

delay

delay(delay: number, ...args: Args): CancelablePromise<Result>
Runs the task delayed. Cancels the last execution.
Parameters
- delay: number
  milliseconds to wait until task execution
- ...args: Args
  the arguments given to the task function.
Returns CancelablePromise<Result>
the promise.
- Defined in AsyncTask.ts:43

delayIfNotQueued

delayIfNotQueued(delay: number, ...args: Args): CancelablePromise<Result>
Runs the task delayed. But only if it is not waiting for execution or executing. Does not cancel the last execution.
Parameters
- delay: number
  milliseconds to wait until next task execution.
- ...args: Args
  the arguments given to the task function. If queued again.
Returns CancelablePromise<Result>
the promise.
- Defined in AsyncTask.ts:52

isRunning

isRunning(): boolean
Returns the current running state.

Returns boolean
- Defined in AsyncTask.ts:21

run

run(...args: Args): CancelablePromise<Result>
Runs the task as early as possible. Cancels the last execution.
Parameters
- ...args: Args
  the arguments given to the task function.
Returns CancelablePromise<Result>
the promise.
- Defined in AsyncTask.ts:34