Class Task

Represents a task in a plan. A task is associated with a plan and can have various statuses, execution times, and retries.

Constructors

constructor

Properties

created_at executed_at? id next_execution_at? partition_key plan_id status

Constructors

constructor

  • new Task(
        id: string,
        plan_id: string,
        partition_key: number,
        status: TaskStatus,
        created_at: number,
        executed_at?: number,
        next_execution_at?: number,
    ): Task

  • Creates an instance of the Task class.

    Parameters

    • id: string

      The unique identifier for the task.

    • plan_id: string

      The ID of the plan this task belongs to.

    • partition_key: number

      A partition key for sharding or distribution.

    • status: TaskStatus

      The status of the task (e.g., CREATED, PROCESSING, SUCCESS).

    • created_at: number

      The timestamp when the task was created.

    • Optionalexecuted_at: number

      The timestamp when the task was executed. Optional.

    • Optionalnext_execution_at: number

      The timestamp for the next task execution. Optional.

    Returns Task

Properties

created_at

created_at: number

The timestamp (in milliseconds) when the task was created.

Optionalexecuted_at

executed_at?: number

The timestamp (in milliseconds) when the task was executed. Optional.

id

id: string

The unique identifier for the task.

Optionalnext_execution_at

next_execution_at?: number

The timestamp (in milliseconds) when the task is scheduled to be executed next. Optional.

partition_key

partition_key: number

A partition key for sharding or distribution.

plan_id

plan_id: string

The ID of the plan this task belongs to.

status

status: TaskStatus

The status of the task (e.g., CREATED, PROCESSING, SUCCESS).

Settings

Member Visibility

On This Page

Constructors
Properties