Class Task

Hierarchy

_Task
- Task

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Task(tasks: ITaskDelegate | ITaskDelegate[], context: any): Task

Overrides _Task.constructor
- Defined in src/modules/Task.ts:12
Parameters
- tasks: ITaskDelegate | ITaskDelegate[]
- context: any
Returns Task

Properties

Private _piximData

_piximData: ITaskData

Protected _taskData

_taskData: ITaskData

Accessors

enabled

get enabled(): boolean
set enabled(enabled: boolean): any

- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:20
Whether the task works.

Returns boolean
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:21
Whether the task works.

Parameters
- enabled: boolean
Returns any

value

get value(): any

- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:62
The value returned by the last task executed.

Returns any

Methods

add

add(callbacks: ITaskDelegate | ITaskDelegate[]): Task

Inherited from _Task.add
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:25
Add the task to the end of the list.

Parameters
- callbacks: ITaskDelegate | ITaskDelegate[]
Returns Task

cemit

cemit(type: string, context: any, ...args: any[]): Task

- Defined in src/modules/Task.ts:66
deprecated

1.7.0

Parameters
- type: string
- context: any
- Rest ...args: any[]
Returns Task

cemitAll

cemitAll(context: any, ...args: any[]): Task

- Defined in src/modules/Task.ts:92
deprecated

1.9.0

Parameters
- context: any
- Rest ...args: any[]
Returns Task

clear

clear(type?: string): Task

- Defined in src/modules/Task.ts:105
deprecated

1.7.0

Parameters
- type: string = ''
Returns Task

destroy

destroy(): void

Overrides _Task.destroy
- Defined in src/modules/Task.ts:111
Returns void

done

done(...args: any[]): any

Inherited from _Task.done
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:29
Execute the current task.

Parameters
- Rest ...args: any[]
Returns any

emit

emit(type: string, ...args: any[]): Task

- Defined in src/modules/Task.ts:53
deprecated

1.7.0

Parameters
- type: string
- Rest ...args: any[]
Returns Task

emitAll

emitAll(...args: any[]): Task

- Defined in src/modules/Task.ts:79
deprecated

1.9.0

Parameters
- Rest ...args: any[]
Returns Task

finish

finish(): Task

Inherited from _Task.finish
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:50
Skips all tasks and changes to the finished state.

Returns Task

first

first(): Task

Inherited from _Task.first
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:34
Change the current task to the first task.

Returns Task

next

next(): Task

Inherited from _Task.next
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:42
Change the current task to the next task.

Returns Task

off

off(type: string, callback: ITaskDelegate): Task

- Defined in src/modules/Task.ts:44
deprecated

1.7.0

Parameters
- type: string
- callback: ITaskDelegate
Returns Task

on

on(type: string, callback: ITaskDelegate): Task

- Defined in src/modules/Task.ts:26
deprecated

1.7.0

Parameters
- type: string
- callback: ITaskDelegate
Returns Task

once

once(type: string, callback: ITaskDelegate): Task

- Defined in src/modules/Task.ts:35
deprecated

1.7.0

Parameters
- type: string
- callback: ITaskDelegate
Returns Task

prev

prev(): Task

Inherited from _Task.prev
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:38
Change the current task to the previos task.

Returns Task

reset

reset(): Task

Inherited from _Task.reset
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:54
Cancel all task and leave them unregistered.

Returns Task

to

to(index: number): Task

Inherited from _Task.to
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:46
Change the current task to the specified task.

Parameters
- index: number
Returns Task

Generated using TypeDoc