Class TaskQuery

Provides methods to query, retrieve, and manage tasks and their results within a FlowController.

Constructors

constructor

Accessors

parent

Methods

find findLast get getAll getLast getLastResult getResult getResults

Constructors

constructor

Accessors

parent

Methods

find

  • find<T>(builder: BuilderIs<T>): undefined | T

  • Finds the first task in the completed collection that matches the provided builder.

    Type Parameters

    • T

      Type of the task.

    Parameters

    • builder: BuilderIs<T>

      Builder used to identify the task.

    Returns undefined | T

    The matching task, or undefined if not found.

findLast

  • findLast<T>(builder: BuilderIs<T>): undefined | T

  • Finds the last task in the completed collection that matches the provided builder.

    Type Parameters

    • T

      Type of the task.

    Parameters

    • builder: BuilderIs<T>

      Builder used to identify the task.

    Returns undefined | T

    The matching task, or undefined if not found.

get

  • get<T>(builder: BuilderIs<T>): NonNullable<T>

  • Retrieves the first task in the completed collection that matches the provided builder.

    This method behaves the same as find, except it throws an error if no task is found.

    Type Parameters

    • T

      Type of the task.

    Parameters

    • builder: BuilderIs<T>

      Builder used to identify the task.

    Returns NonNullable<T>

    The matching task.

    Throws

    If no task is found.

getAll

  • getAll<T>(builder: BuilderIs<T>): T[]

  • Retrieves all tasks in the completed collection that match the provided builder.

    Type Parameters

    • T

      Type of the task.

    Parameters

    • builder: BuilderIs<T>

      Builder used to identify the tasks.

    Returns T[]

    An array of matching tasks.

getLast

  • getLast<T>(builder: BuilderIs<T>): NonNullable<T>

  • Retrieves the last task in the completed collection that matches the provided builder.

    This method behaves the same as findLast, except it throws an error if no task is found.

    Type Parameters

    • T

      Type of the task.

    Parameters

    • builder: BuilderIs<T>

      Builder used to identify the task.

    Returns NonNullable<T>

    The matching task.

    Throws

    If no task is found.

getLastResult

  • getLastResult<TSpec extends TaskSpec>(
        taskBuilder: TaskBuilder<TSpec>,
    ): NonNullable<TSpec["TResult"]>

  • Retrieves the result of the last task in the completed collection that matches the provided builder.

    Type Parameters

    • TSpec extends TaskSpec

      Specification of the task.

    Parameters

    Returns NonNullable<TSpec["TResult"]>

    The result of the task.

    Throws

    If the task is not found or its result is empty.

getResult

  • getResult<TSpec extends TaskSpec>(
        taskBuilder: TaskBuilder<TSpec>,
    ): NonNullable<TSpec["TResult"]>

  • Retrieves the result of the first task in the completed collection that matches the provided builder.

    Type Parameters

    • TSpec extends TaskSpec

      Specification of the task.

    Parameters

    Returns NonNullable<TSpec["TResult"]>

    The result of the task.

    Throws

    If the task is not found or its result is empty.

getResults

  • getResults<TSpec extends TaskSpec>(
        taskBuilder: TaskBuilder<TSpec>,
    ): NonNullable<TSpec["TResult"]>[]

  • Retrieves the results of all tasks in the completed collection that match the provided builder.

    Type Parameters

    • TSpec extends TaskSpec

      Specification of the task.

    Parameters

    Returns NonNullable<TSpec["TResult"]>[]

    An array of results from the matching tasks.

    Throws

    If any task result is empty.

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods