Interface TaskBuilder<TSpec>

Builder interface for creating Task instances.

interface TaskBuilder<TSpec extends TaskSpec = TaskSpec> {
    id: string;
    taskName: string;
    is(task: unknown): task is Task<TSpec>;
    toString(pretty?: boolean): string;
    (data: TSpec["TData"]): Task<TSpec>;
}

Type Parameters

TSpec extends TaskSpec = TaskSpec
Task specification type.

Hierarchy (View Summary)

BuilderIs<Task<TSpec>>
- TaskBuilder

TaskBuilder(data: TSpec["TData"]): Task<TSpec>
Creates a new Task instance.
Parameters
- data: TSpec["TData"]
  Input data for the task.
Returns Task<TSpec>
A new Task instance.
- Defined in src/core/task/task-builder.ts:39

Index

Properties

Methods

Properties

id

id: string

Unique identifier for the task builder.

taskName

taskName: string

Name of the task.

Methods

is

is(task: unknown): task is Task<TSpec>
Checks if the provided task is of the specified type.
Parameters
- task: unknown
  Object to check.
Returns task is Task<TSpec>
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
String representation of the task builder.
Parameters
- Optionalpretty: boolean
  If true, outputs a prettified string.
Returns string
String representing the task builder.
- Defined in src/core/task/task-builder.ts:54