@types/orchestrator

property doneCallback

doneCallback?: (error?: any) => any;

property isRunning

isRunning: boolean;

property seq

seq: any[];

property sequence

sequence: Orchestrator.Sequencify;

property start

start: Orchestrator.StartMethod;

property tasks

tasks: { [name: string]: Orchestrator.Task };

method add

add: {
    (name: string, fn?: Orchestrator.TaskFunc): Orchestrator;
    (name: string, deps?: string[], fn?: Orchestrator.TaskFunc): Orchestrator;
};

• Define a task

  Parameter name

  The name of the task.

  Parameter fn

  The function that performs the task's operations. For asynchronous tasks, you need to provide a hint when the task is complete: - Take in a callback - Return a stream or a promise

• Define a task

  Parameter name

  The name of the task.

  Parameter deps

  An array of task names to be executed and completed before your task will run.

  Parameter fn

  The function that performs the task's operations. For asynchronous tasks, you need to provide a hint when the task is complete: - Take in a callback - Return a stream or a promise

method allDone

allDone: () => boolean;

method hasTask

hasTask: (name: string) => boolean;

• Have you defined a task with this name?

  Parameter name

  The task name to query

method on

on: (
    event: Orchestrator.EventNames,
    cb: (e: Orchestrator.OnCallbackEvent) => any
) => this;

• Listen to orchestrator internals

  Parameter event

  Event name to listen to: - start: from start() method, shows you the task sequence - stop: from stop() method, the queue finished successfully - err: from stop() method, the queue was aborted due to a task error - task_start: from _runTask() method, task was started - task_stop: from _runTask() method, task completed successfully - task_err: from _runTask() method, task errored - task_not_found: from start() method, you're trying to start a task that doesn't exist - task_recursion: from start() method, there are recursive dependencies in your task list

  Parameter cb

  Passes single argument: e: event details

method onAll

onAll: (cb: (e: Orchestrator.OnAllCallbackEvent) => any) => void;

• Listen to all orchestrator events from one callback

  Parameter cb

  Passes single argument: e: event details

method reset

reset: () => Orchestrator;

method stop

stop: (err?: any, successfulFinish?: boolean) => void;

method task

task: {
    (name: string): Orchestrator.Task;
    (name: string, fn: Orchestrator.TaskFunc): void;
    (name: string, dep: string[], fn: Orchestrator.TaskFunc): void;
};

call signature

(name: string, fn?: TaskFunc): Orchestrator;

• Define a task

  Parameter name

  The name of the task.

  Parameter fn

  The function that performs the task's operations. For asynchronous tasks, you need to provide a hint when the task is complete: - Take in a callback - Return a stream or a promise

call signature

(name: string, deps?: string[], fn?: TaskFunc): Orchestrator;

• Define a task

  Parameter name

  The name of the task.

  Parameter deps

  An array of task names to be executed and completed before your task will run.

  Parameter fn

  The function that performs the task's operations. For asynchronous tasks, you need to provide a hint when the task is complete: - Take in a callback - Return a stream or a promise

property duration

duration: number;

property hrDuration

hrDuration: [number, number];

property runMethod

runMethod: 'callback' | 'catch' | 'promise' | 'stream' | 'sync';

property src

src: string;

property duration

duration?: number | undefined;

property err

err: any;

property message

message: string;

property task

task: string;

call signature

(tasks: Strings, cb?: (error?: any) => any): Orchestrator;

• Start running the tasks

  Parameter tasks

  Tasks to be executed. You may pass any number of tasks as individual arguments.

  Parameter cb

  Callback to call after run completed.

call signature

(...tasks: Strings[] /*, cb?: (error: any) => any */): Orchestrator;

• Start running the tasks

  Parameter tasks

  Tasks to be executed. You may pass any number of tasks as individual arguments.

  Parameter cb

  Callback to call after run completed.

call signature

(task1: Strings, task2: Strings, cb?: (error?: any) => any): Orchestrator;

call signature

(
    task1: Strings,
    task2: Strings,
    task3: Strings,
    cb?: (error?: any) => any
): Orchestrator;

call signature

(
    task1: Strings,
    task2: Strings,
    task3: Strings,
    task4: Strings,
    cb?: (error?: any) => any
): Orchestrator;

call signature

(
    task1: Strings,
    task2: Strings,
    task3: Strings,
    task4: Strings,
    task5: Strings,
    cb?: (error?: any) => any
): Orchestrator;

call signature

(
    task1: Strings,
    task2: Strings,
    task3: Strings,
    task4: Strings,
    task5: Strings,
    task6: Strings,
    cb?: (error?: any) => any
): Orchestrator;

property dep

dep: string[];

property done

done?: boolean | undefined;

property duration

duration?: number | undefined;

property fn

fn: TaskFunc;

property hrDuration

hrDuration?: [number, number] | undefined;

property name

name: string;

property running

running?: boolean | undefined;