Class TaskManager

Manages task execution, including queue management, progress control, and event handling.

Supports sequential and parallel execution modes and provides methods to query, retrieve, and manage task results.

Hierarchy

  • TaskManagerBase
    • TaskManager

Constructors

constructor

Properties

_flags _mode _progress _status flowController query

Accessors

flags isEmptyQueue mode progress status tasks

Methods

addFlag addTask addTasks clear clearQueue emit hasFlag hasFlags isStatus off offAll on onAll removeFlag reset setFlags setMode setProgress setStatus start stop

Constructors

constructor

Properties

Protected_flags

_flags: Set<TaskManagerFlag> = ...

Current flags for the task manager.

Default

Empty set of flags.

Protected_mode

_mode: ExecutionMode = ExecutionMode.SEQUENTIAL

Current execution mode of the task manager.

Default

ExecutionMode.SEQUENTIAL

Protected_progress

_progress: number = 0

Current progress of tasks, represented as a value between 0 and 1.

Default

0

Protected_status

_status: TaskManagerStatus = "idle"

Current status of the task manager.

Default

"idle"

ProtectedflowController

flowController: FlowController = ...

Manages task execution and flow control.

query

query: TaskQuery = ...

Query interface for accessing and managing tasks.

Accessors

flags

isEmptyQueue

mode

progress

  • get progress(): number

  • Retrieves the current progress of tasks.

    Returns number

  • set progress(progress: number): void

  • Updates the progress of tasks.

    Parameters

    • progress: number

      New progress value (0 to 1).

    Returns void

    Emits

    progress - When progress changes.

    Emits

    param - When the progress parameter changes.

status

tasks

Methods

addFlag

addTask

addTasks

clear

  • clear(): this

  • Removes all listeners for all event types, as well as all global listeners.

    Returns this

    The EventEmitter instance itself, allowing for method chaining.

    Example

    emitter.clear(); // No more event listeners remain

clearQueue

emit

  • emit<TType extends keyof TaskManagerEvents>(
        type: TType,
        ...data: TaskManagerEvents[TType] extends void
            ? []
            : [data: TaskManagerEvents[TType]],
    ): this

  • Emits an event of a specific type, invoking all registered listeners for that event type with the provided data. Also calls any global event listeners with a GlobalEvent object.

    Type Parameters

    Parameters

    • type: TType

      The identifier for the event type to emit.

    • ...data: TaskManagerEvents[TType] extends void ? [] : [data: TaskManagerEvents[TType]]

      The data to pass to the event listeners. The type of this data is defined by the corresponding value in TEvents.

    Returns this

    The EventEmitter instance itself, allowing for method chaining.

    Example

    emitter.emit("data", "Sample data");
    emitter.emit("loaded");
    emitter.emit("error", new Error("Oh no!"));

hasFlag

hasFlags

isStatus

off

  • off<TType extends keyof TaskManagerEvents>(
        type: TType,
        listener: EventListener<
            TaskManagerEvents,
            TaskManagerEvents[TType],
            TaskManager,
        >,
    ): this

  • Removes a previously registered event listener for a specified event type. Use this method to unregister listeners when they are no longer needed, preventing potential memory leaks.

    Type Parameters

    Parameters

    Returns this

    The EventEmitter instance itself, allowing for method chaining.

    Example

    const onError = (error: Error) => console.error(error);

    emitter.on("error", onError);

    // ...

    emitter.off("error", onError);

offAll

  • offAll(listener: GlobalEventListener<TaskManagerEvents, TaskManager>): this

  • Removes a previously registered global event listener.

    Parameters

    Returns this

    The EventEmitter instance itself, allowing for method chaining.

    Example

    const globalListener = (event: GlobalEvent<TEvents>) => {
      console.log(`Event of type ${String(event.type)} received`, event.data);
    };

    emitter.onAll(globalListener);

    // ...

    emitter.offAll(globalListener);

on

  • on<TType extends keyof TaskManagerEvents>(
        type: TType,
        listener: EventListener<
            TaskManagerEvents,
            TaskManagerEvents[TType],
            TaskManager,
        >,
    ): this

  • Adds an event listener for a specified event type. This method allows you to specify which event you are interested in listening to and to provide a callback function that will be executed whenever that event is emitted.

    Type Parameters

    Parameters

    Returns this

    The EventEmitter instance itself, allowing for method chaining.

    Example

    emitter.on("data", (data: string) => {
      console.log("Data", data);
    });

    emitter.on("loaded", function () {
      console.log(
        "Emitter loaded",
        this // EventEmitter<MyEvents>
      );
    });

    emitter.on("error", (error: Error) => {
      console.error(`Error: ${error.message}`);
    });

onAll

  • onAll(listener: GlobalEventListener<TaskManagerEvents, TaskManager>): this

  • Adds a global event listener that is called for every emitted event.

    Parameters

    Returns this

    The EventEmitter instance itself, allowing for method chaining.

    Example

    emitter.onAll((event: GlobalEvent<TEvents>) => {
      console.log(`Event of type ${String(event.type)} received`, event.data);
    });

removeFlag

reset

setFlags

setMode

ProtectedsetProgress

  • setProgress(progress: number): TaskManager

  • Sets the progress of tasks.

    Parameters

    • progress: number

      Progress value to set.

    Returns TaskManager

    Instance of the task manager for chaining.

    Emits

    progress - When progress changes.

    Emits

    param - When the progress parameter changes.

ProtectedsetStatus

start

  • start(force?: boolean): Promise<void | TaskManager>

  • Starts executing tasks in the queue.

    Parameters

    • Optionalforce: boolean

      If true, starts even if the manager is in an error state.

    Returns Promise<void | TaskManager>

    A promise that resolves when execution starts.

    Emits

    progress - When task progress updates.

    Emits

    success - When all tasks complete successfully.

    Emits

    error - When a task or the manager encounters an error.

    Emits

    fail - When a task fails and the CONTINUE_ON_ERROR flag is not set.

stop

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods