Interface TaskLike<T>

Task Like

Type parameters

T

Hierarchy

CancelToken
PromiseLike<T | void>
- TaskLike

Implemented by

Task

Index

Properties

Methods

Properties

Readonly cancelled

cancelled: boolean

Has it been cancelled or whether cancellation has been requested

running

running: boolean

Is running

finished

finished: boolean

Whether finished

Methods

cancel

cancel(): void

Inherited from CancelToken.cancel
- Defined in task.ts:10
Communicates a request for cancellation

Returns void

guard

guard(): void

Inherited from CancelToken.guard
- Defined in task.ts:12
If cancelled, throw CancelGuard

Returns void

reg

reg(f: () => void): void
reg(): Promise<void>

Inherited from CancelToken.reg
- Defined in task.ts:15
Register an event that will be triggered when cancelled

Parameters
- f: () => void
  - - (): void
    - Returns void
Returns void
Inherited from CancelToken.reg
- Defined in task.ts:17
Waiting for cancellation

Returns Promise<void>

unReg

unReg(f: () => void): void

Inherited from CancelToken.unReg
- Defined in task.ts:19
Unregister event

Parameters
- f: () => void
  - - (): void
    - Returns void
Returns void

run

run(): PromiseLike<void | T>

- Defined in task.ts:92
Run task

Returns PromiseLike<void | T>

Generated using TypeDoc