| Documentation

Despite accepting an {Object} of configuration, we can also accept an {Array} of configuration. When using an array, a {String} becomes the :name, a {Function} becomes the :method, and an {Object} becomes the :config

config ([Object])

Name	Description
config.done `[Function]`	Passed to TaskGroup#onceDone (aliases are `onceDone` , and `next` )
config.whenDone `[Function]`	Passed to TaskGroup#whenDone
config.on `[Object]`	An object of event names linking to listener functions that we would like bounded via EventEmitter#on
config.once `[Object]`	An object of event names linking to listener functions that we would like bounded via EventEmitter#once
config.storeResult `[Boolean]`	Whether or not to store the result, if `false` will not store, defaults to `false` if `destroyOnceDone` is `true`
config.destroyOnceDone `[Boolean]` (default `true`)	Whether or not we should automatically destroy the {TaskGroup} once done to free up resources
config.parent `[TaskGroup]`	A parent {TaskGroup} that we may be attached to
config.method `[Function]`	The {Function} to execute for our {TaskGroup} when using inline execution style
config.name `[String]`	What we would like our name to be, useful for debugging
config.destroyDoneItems `[Boolean]` (default `true`)	Whether or not we should automatically destroy done items to free up resources
config.nestedTaskGroupConfig `[Object]`	The nested configuration to be applied to all {TaskGroup} descendants of this group
config.nestedTaskConfig `[Object]`	The nested configuration to be applied to all {Task} descendants of this group
config.emitNestedEvents `[Boolean]` (default `false`)	Whether or not we should emit nested item events @TODO remove this, there are not tests for it, can be accomplished via item.add listener like TaskGroupDebug
config.concurrency `[Number]` (default `1`)	The amount of items that we would like to execute at the same time. Use `0` for unlimited. `1` accomplishes serial execution, everything else accomplishes parallel execution
config.run `[Boolean]`	A {Boolean} for whether or not to run the TaskGroup automatically, by default will be enabled if config.method is defined
config.tasks `[Array]`	An {Array} of {Task} instances to be added to this group
config.taskgroups `[Array]`	An {Array} of {TaskGroup} instances to be added to this group
config.items `[Array]`	An {Array} of {Task} and/or {TaskGroup} instances to be added to this group
config.abortOnError `[Boolean]` (default `true`)	Whether or not we should abort execution of the {TaskGroup} and exit when an error occurs

args (...)

const Task = require('taskgroup').Task Task.create('my synchronous task', function () { return 5 }).done(console.info).run() // [null, 5] Task.create('my asynchronous task', function (complete) { complete(null, 5) }).done(console.info).run() // [null, 5] Task.create('my task that returns an error', function () { var error = new Error('deliberate error') return error }).done(console.info).run() // [Error('deliberator error')] Task.create('my task that passes an error', function (complete) { var error = new Error('deliberate error') complete(error) }).done(console.info).run() // [Error('deliberator error')]

Name	Description
config.done `[Function]`	Passed to Task#onceDone (aliases are `onceDone` , and `next` )
config.whenDone `[Function]`	Passed to Task#whenDone
config.on `[Object]`	A map of event names linking to listener functions that we would like bounded via {EventEmitter.on}
config.once `[Object]`	A map of event names linking to listener functions that we would like bounded via {EventEmitter.once}
config.storeResult `[Boolean]`	Whether or not to store the result, if `false` will not store
config.name `[String]`	What we would like our name to be, useful for debugging.
config.parent `[TaskGroup]`	A parent TaskGroup that we may be attached to
config.method `[Function]`	The {Function} to execute for our {Task}
config.errorOnExcessCompletions `[Boolean]` (default `true`)	Whether or not to error if the task completes more than once
config.ambi `[Boolean]` (default `true`)	Whether or not to use bevry/ambi to determine if the method is asynchronous or synchronous and execute it appropriately
config.domain `[Boolean]`	If not `false` will wrap the task execution in a domain to attempt to catch background errors (aka errors that are occuring in other ticks than the initial execution), if `true` will fail if domains aren't available
config.args `[Array]`	Arguments that we would like to forward onto our method when we execute it
config.destroyOnceDone `[Boolean]` (default `true`)	Whether or not to automatically destroy the task once it's done to free up resources

Name

Description

config.done [Function]

Passed to Task#onceDone (aliases are onceDone , and next )

config.whenDone [Function]

Passed to Task#whenDone

config.on [Object]

A map of event names linking to listener functions that we would like bounded via {EventEmitter.on}

config.once [Object]

A map of event names linking to listener functions that we would like bounded via {EventEmitter.once}

config.storeResult [Boolean]

Whether or not to store the result, if false will not store

config.name [String]

What we would like our name to be, useful for debugging.

config.parent [TaskGroup]

A parent TaskGroup that we may be attached to

config.method [Function]

The {Function} to execute for our {Task}

config.errorOnExcessCompletions [Boolean] (default true)

Whether or not to error if the task completes more than once

config.ambi [Boolean] (default true)

Whether or not to use bevry/ambi to determine if the method is asynchronous or synchronous and execute it appropriately

config.domain [Boolean]

If not false will wrap the task execution in a domain to attempt to catch background errors (aka errors that are occuring in other ticks than the initial execution), if true will fail if domains aren't available

config.args [Array]

Arguments that we would like to forward onto our method when we execute it

config.destroyOnceDone [Boolean] (default true)

Whether or not to automatically destroy the task once it's done to free up resources

BaseInterface

TaskGroup

Task