Class Task<T>

A simplified synchronous (but deferrable) version of Task Asynchronous operations should use Promise.

Type Parameters

T

Hierarchy (View Summary)

TaskHandlerBase
- Task

Index

Constructors

Accessors

error isScheduled result state status

Methods

_onDispose _onExecute cancel getResult getState getStatus runSynchronously start

Constructors

constructor

new Task<T>(valueFactory: Func<T>): Task<T>
Type Parameters
- T
Parameters
- valueFactory: Func<T>
Returns Task<T>
Overrides TaskHandlerBase.constructor
- Defined in Task.ts:22

Accessors

error

get error(): any
Returns any
- Defined in Task.ts:41

isScheduled

get isScheduled(): boolean
Returns boolean
Inherited from TaskHandlerBase.isScheduled
- Defined in TaskHandlerBase.ts:33

result

get result(): T
Returns T
- Defined in Task.ts:34

state

get state(): TaskState<T>
Returns TaskState<T>
- Defined in Task.ts:29

status

get status(): TaskStatus
Returns TaskStatus
Inherited from TaskHandlerBase.status
- Defined in TaskHandlerBase.ts:28

Methods

`Protected`_onDispose

_onDispose(): void
Returns void
Overrides TaskHandlerBase._onDispose
- Defined in Task.ts:83

`Protected`_onExecute

_onExecute(): void
Returns void
Overrides TaskHandlerBase._onExecute
- Defined in Task.ts:63

cancel

cancel(): boolean
Returns true if cancelled. Returns false if already run or already cancelled or unable to cancel.

Returns boolean
Inherited from TaskHandlerBase.cancel
- Defined in TaskHandlerBase.ts:75

`Protected`getResult

getResult(): T
Returns T
- Defined in Task.ts:68

`Protected`getState

getState(): TaskState<T>
Returns TaskState<T>
- Defined in Task.ts:73

`Protected`getStatus

getStatus(): TaskStatus
Returns TaskStatus
Inherited from TaskHandlerBase.getStatus
- Defined in TaskHandlerBase.ts:88

runSynchronously

runSynchronously(): void
Returns void
Overrides TaskHandlerBase.runSynchronously
- Defined in Task.ts:55

start

start(defer?: number): void
Schedules/Reschedules triggering the task.
Parameters
- Optionaldefer: number
  Optional time to wait until triggering.
Returns void
Overrides TaskHandlerBase.start
- Defined in Task.ts:47