Class TaskGroupBaseAbstract

Base class for managing task statuses, progress, flags, and event-driven operations.

Provides foundational methods for task lifecycle management and event handling, used by task group implementations.

Hierarchy (View Summary)

Constructors

constructor

Properties

_flags _progress _status

Accessors

flags progress status

Methods

addFlag clear emit hasFlag hasFlags isStatus off offAll on onAll removeFlag setFlags setProgress setStatus

Constructors

constructor

Properties

Protected_flags

_flags: Set<"CONTINUE_ON_ERROR"> = ...

Current flags for the task group.

Default

Empty set of flags.

Protected_progress

_progress: number = 0

Progress of the task group, represented as a value between 0 and 1.

Default

0

Protected_status

_status: TaskGroupStatus = "idle"

Current status of the task group.

Default

"idle"

Accessors

flags

  • get flags(): "CONTINUE_ON_ERROR"[]

  • Current flags for the task group.

    Returns "CONTINUE_ON_ERROR"[]

    Default

    Empty array of flags.
  • set flags(flags: Set<"CONTINUE_ON_ERROR">): void

  • Updates the flags for the task group.

    Parameters

    • flags: Set<"CONTINUE_ON_ERROR">

      New set of flags to apply.

    Returns void

    Emits

    param - When the flags parameter changes.

progress

  • get progress(): number

  • Progress of the task group, represented as a value between 0 and 1.

    Returns number

    Default

    0
  • set progress(progress: number): void

  • Updates the progress of the task group.

    Parameters

    • progress: number

      New progress value (0 to 1).

    Returns void

    Emits

    progress - When progress changes.

    Emits

    param - When the progress parameter changes.

status

Methods

addFlag

  • addFlag(flag: "CONTINUE_ON_ERROR"): this

  • Adds a flag to the task group.

    Parameters

    • flag: "CONTINUE_ON_ERROR"

      Flag to add.

    Returns this

    Instance of the task group for chaining.

    Emits

    param - When the flags parameter changes.

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

emit

  • emit<TType extends keyof TaskGroupEvents>(
        type: TType,
        ...data: TaskGroupEvents[TType] extends void
            ? []
            : [data: TaskGroupEvents[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: TaskGroupEvents[TType] extends void ? [] : [data: TaskGroupEvents[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

  • hasFlag(flag: "CONTINUE_ON_ERROR"): boolean

  • Checks if a specific flag is set in the task group.

    Parameters

    • flag: "CONTINUE_ON_ERROR"

      Flag to check.

    Returns boolean

    true if the flag is set.

hasFlags

  • hasFlags(...flags: "CONTINUE_ON_ERROR"[]): boolean

  • Checks if all specified flags are set in the task group.

    Parameters

    • ...flags: "CONTINUE_ON_ERROR"[]

      Flags to check.

    Returns boolean

    true if all specified flags are set.

isStatus

off

  • off<TType extends keyof TaskGroupEvents>(
        type: TType,
        listener: EventListener<
            TaskGroupEvents,
            TaskGroupEvents[TType],
            TaskGroupBase,
        >,
    ): 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<TaskGroupEvents, TaskGroupBase>): 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 TaskGroupEvents>(
        type: TType,
        listener: EventListener<
            TaskGroupEvents,
            TaskGroupEvents[TType],
            TaskGroupBase,
        >,
    ): 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<TaskGroupEvents, TaskGroupBase>): 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

  • removeFlag(flag: "CONTINUE_ON_ERROR"): this

  • Removes a flag from the task group.

    Parameters

    • flag: "CONTINUE_ON_ERROR"

      Flag to remove.

    Returns this

    Instance of the task group for chaining.

    Emits

    param - When the flags parameter changes.

setFlags

ProtectedsetProgress

ProtectedsetStatus

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods