Class TaskGroup
Defined in: | src/lib/taskgroup.coffee |
Inherits: | Interface |
Overview
Class Method Summary
- TaskGroup .create(args...) Creates a new TaskGroup instance.
- Boolean .isTaskGroup(group) A helper method to check if the passed argument is an instanceof a TaskGroup.
Instance Method Summary
- ::addGroup(args...) Add a TaskGroup with some configuration to ourself, create it if needed.
- ::addGroups(items, args...) Add TaskGroups with some configuration to ourself, create it if needed.
- ::addTask(args...) Add a Task with some configuration to ourself, create it if needed.
- ::addTasks(items, args...) Add Tasks with some configuration to ourself, create it if needed.
- ::clear() Clear remaning items.
- ::constructor(args...) Initialize our new TaskGroup instance.
- TaskGroup ::createGroup(args...) Create a TaskGroup instance from some configuration.
- Task ::createTask(args...) Create a Task instance from some configuration.
- ::destroy() Destroy all remaining items and remove listeners.
- Object ::getItemNames() Gets the names of the items, the total number of items, and their results for the purpose of debugging.
- Object ::getItemTotals() Gets the total number count of each of our item lists.
- Number ::getItemsTotal() Gets the total number of items
- Boolean ::hasExited() Have we finished its execution yet?
- Boolean ::hasItems() Whether or not we have any items
- Boolean ::hasRemaining() Whether or not we have any items that are yet to execute
- Boolean ::hasRunning() Whether or not we have any running items
- Boolean ::hasStarted() Have we started execution yet?
- Boolean ::isComplete() Have we completed its execution yet? Completion of executed is determined of whether or not we have started, and whether or not we are currently paused or have no remaining and running items left
- Boolean ::isEmpty() Whether or not we have no items left
- ::onceDone(handler) Once Done Promise.
- ::run(args...) Start the execution.
- ::setConfig(opts = {}) Set the configuration for our instance.
- ::setNestedConfig(config = {}) Set Nested Config
- ::setNestedTaskConfig(config = {}) Set Nested Task Config
- ::whenDone(handler) When Done Promise.
Inherited Method Summary
Methods inherited from Interface
.whenDone, .onceDone, .done, .getNames, .getName, .getConfig
Class Method Details
TaskGroup .create(args...) Source
Constructor Details
::constructor(args...) Source
Instance Method Details
::addGroup(args...) Source
::addGroups(items, args...) Source
::addTask(args...) Source
::addTasks(items, args...) Source
::clear() Source
TaskGroup ::createGroup(args...) Source
Task ::createTask(args...) Source
::destroy() Source
Object ::getItemNames() Source
Object ::getItemTotals() Source
Number ::getItemsTotal() Source
Boolean ::hasExited() Source
Boolean ::hasItems() Source
Boolean ::hasRemaining() Source
Boolean ::hasRunning() Source
Boolean ::hasStarted() Source
Boolean ::isComplete() Source
Boolean ::isEmpty() Source
::onceDone(handler) Source
::run(args...) Source
::setConfig(opts = {}) Source
::setNestedConfig(config = {}) Source
::setNestedTaskConfig(config = {}) Source