Class Task

Hierarchy

Task
- Task

Index

Constructors

Properties

Accessors

Methods

add cemit cemitAll clear destroy done emit emitAll finish first next off on once prev reset to

Constructors

constructor

new Task(tasks: ITaskDelegate | ITaskDelegate[], context: any): Task
Parameters
- tasks: ITaskDelegate | ITaskDelegate[]
- context: any
Returns Task
Overrides _Task.constructor
- Defined in src/modules/Task.ts:19

Properties

`Protected`_taskData

_taskData: ITaskData

Accessors

enabled

get enabled(): boolean
Whether the task works.

Returns boolean
Inherited from _Task.enabled
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:20
set enabled(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
Inherited from _Task.enabled
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:21

value

get value(): any
The value returned by the last task executed.

Returns any
Inherited from _Task.value
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:62

Methods

add

add(callbacks: ITaskDelegate | ITaskDelegate[]): this
Add the task to the end of the list.
Parameters
- callbacks: ITaskDelegate | ITaskDelegate[]
Returns this
Inherited from _Task.add
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:25

cemit

cemit(type: string, context: any, ...args: any[]): Task
Emit task with specifying a context.
Parameters
- type: string
  Event type to emit.
- context: any
  Context to execute the callback.
- ...args: any[]
  Argument(s) in callback.
Returns Task
- Defined in src/modules/Task.ts:92

cemitAll

cemitAll(context: any, ...args: any[]): Task
Emit all task events with specifying a context.
Parameters
- context: any
  Context to execute the callback.
- ...args: any[]
  Argument(s) in callback.
Returns Task
- Defined in src/modules/Task.ts:125

clear

clear(type?: string): Task
Remove callbacks grouped task event type.
Parameters
- type: string = ''
Returns Task
- Defined in src/modules/Task.ts:141

destroy

destroy(): void
Destroy instance.

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

done

done(...args: any[]): any
Execute the current task.
Parameters
- ...args: any[]
Returns any
Inherited from _Task.done
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:29

emit

emit(type: string, ...args: any[]): Task
Emit task.
Parameters
- type: string
  Event type to emit.
- ...args: any[]
  Argument(s) in callback.
Returns Task
- Defined in src/modules/Task.ts:74

emitAll

emitAll(...args: any[]): Task
Emit all task events.
Parameters
- ...args: any[]
  Argument(s) in callback.
Returns Task
- Defined in src/modules/Task.ts:108

finish

finish(): this
Skips all tasks and changes to the finished state.

Returns this
Inherited from _Task.finish
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:50

first

first(): this
Change the current task to the first task.

Returns this
Inherited from _Task.first
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:34

next

next(): this
Change the current task to the next task.

Returns this
Inherited from _Task.next
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:42

off

off(type: string, callback: ITaskDelegate): Task
Unregister task with event type.
Parameters
- type: string
  Event type.
- callback: ITaskDelegate
  Registered callback.
Returns Task
- Defined in src/modules/Task.ts:61

on

on(type: string, callback: ITaskDelegate): Task
Register task with event type.
Parameters
- type: string
  Event type.
- callback: ITaskDelegate
  Callback when the event fires.
Returns Task
- Defined in src/modules/Task.ts:35

once

once(type: string, callback: ITaskDelegate): Task
Register one-time task with event type.
Parameters
- type: string
  Event type.
- callback: ITaskDelegate
  Callback when the event fires.
Returns Task
- Defined in src/modules/Task.ts:48

prev

prev(): this
Change the current task to the previos task.

Returns this
Inherited from _Task.prev
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:38

reset

reset(): this
Cancel all task and leave them unregistered.

Returns this
Inherited from _Task.reset
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:54

to

to(index: number): this
Change the current task to the specified task.
Parameters
- index: number
Returns this
Inherited from _Task.to
- Defined in node_modules/@tawaship/task/types/modules/Task.d.ts:46