Interface TaskGroupBuilder<TArgs>

Builder interface for creating TaskGroup instances.

interface TaskGroupBuilder<TArgs extends unknown[] = []> {
    id: string;
    taskGroupName: string;
    is(task: unknown): task is TaskGroup<TArgs>;
    toString(pretty?: boolean): string;
    (...args: TArgs): TaskGroup<TArgs>;
}

Type Parameters

TArgs extends unknown[] = []
Arguments used to create the task group.

Hierarchy (View Summary)

BuilderIs<TaskGroup<TArgs>>
- TaskGroupBuilder

TaskGroupBuilder(...args: TArgs): TaskGroup<TArgs>
Creates a new TaskGroup instance.
Parameters
- ...args: TArgs
  Arguments used to create the task group.
Returns TaskGroup<TArgs>
A new TaskGroup instance.
- Defined in src/core/task-group/task-group-builder.ts:46

Index

Properties

id taskGroupName

Methods

Properties

id

id: string

Unique identifier for the task group builder.

taskGroupName

taskGroupName: string

Name of the task group.

Methods

is

is(task: unknown): task is TaskGroup<TArgs>
Checks if the provided task is of the specified type.
Parameters
- task: unknown
  Object to check.
Returns task is TaskGroup<TArgs>
true if the task is of the specified type.
Inherited from BuilderIs.is
- Defined in src/common/execution.type.ts:36

toString

toString(pretty?: boolean): string
Converts the task group builder to a string representation.
Parameters
- Optionalpretty: boolean
  If true, formats the string for readability.
Returns string
A string representing the task group builder.
- Defined in src/core/task-group/task-group-builder.ts:61