durable-execution - v0.8.0
    Preparing search index...

    Type Alias DurableTaskExecutionStorageObject

    A storage object for a durable task execution.

    type DurableTaskExecutionStorageObject = {
        rootTask?: { taskId: string; executionId: string };
        parentTask?: {
            taskId: string;
            executionId: string;
            isFinalizeTask?: boolean;
        };
        taskId: string;
        executionId: string;
        retryOptions: DurableTaskRetryOptions;
        timeoutMs: number;
        sleepMsBeforeRun: number;
        runInput: string;
        runOutput?: string;
        output?: string;
        childrenTasksCompletedCount: number;
        childrenTasks?: DurableTaskChildExecutionStorageObject[];
        childrenTasksErrors?: DurableTaskChildErrorStorageObject[];
        finalizeTask?: DurableTaskChildExecutionStorageObject;
        finalizeTaskError?: DurableTaskErrorStorageObject;
        error?: DurableTaskErrorStorageObject;
        status: DurableTaskExecutionStatus;
        isClosed: boolean;
        needsPromiseCancellation: boolean;
        retryAttempts: number;
        startAt: Date;
        startedAt?: Date;
        finishedAt?: Date;
        expiresAt: Date;
        createdAt: Date;
        updatedAt: Date;
    }
    Index

    Properties

    rootTask? parentTask? taskId executionId retryOptions timeoutMs sleepMsBeforeRun runInput runOutput? output? childrenTasksCompletedCount childrenTasks? childrenTasksErrors? finalizeTask? finalizeTaskError? error? status isClosed needsPromiseCancellation retryAttempts startAt startedAt? finishedAt? expiresAt createdAt updatedAt

    Properties

    rootTask?: { taskId: string; executionId: string }

    The root task of the execution.

    parentTask?: { taskId: string; executionId: string; isFinalizeTask?: boolean }

    The parent task of the execution.

    taskId: string

    The id of the task.

    executionId: string

    The id of the execution.

    retryOptions: DurableTaskRetryOptions

    The retry options of the task execution.

    timeoutMs: number

    The timeout ms of the task execution.

    sleepMsBeforeRun: number

    The sleep ms before run of the task execution.

    runInput: string

    The run input of the task execution.

    runOutput?: string

    The run output of the task execution.

    output?: string

    The output of the task execution.

    childrenTasksCompletedCount: number

    The number of children tasks that have been completed.

    childrenTasks?: DurableTaskChildExecutionStorageObject[]

    The children tasks of the execution. It is only present for waiting_for_children_tasks status.

    childrenTasksErrors?: DurableTaskChildErrorStorageObject[]

    The errors of the children tasks. It is only present for children_tasks_failed status. In case of multiple errors, the order of errors is not defined.

    finalizeTask?: DurableTaskChildExecutionStorageObject

    The finalize task child execution of the execution.

    finalizeTaskError?: DurableTaskErrorStorageObject

    The error of the finalize task execution. It is only present for finalize_task_failed status.

    error?: DurableTaskErrorStorageObject

    The error of the execution.

    status: DurableTaskExecutionStatus

    The status of the execution.

    isClosed: boolean

    Whether the execution is closed. Once the execution is finished, a background process will update the status of its parent task if present and children if present.

    needsPromiseCancellation: boolean

    Whether the execution needs a promise cancellation.

    retryAttempts: number

    The number of attempts the execution has been retried.

    startAt: Date

    The start time of the task execution. Used for delaying the execution.

    startedAt?: Date

    The time the task execution started.

    finishedAt?: Date

    The time the task execution finished.

    expiresAt: Date

    The time the task execution expires. It is used to recover from process failures.

    createdAt: Date

    The time the task execution was created.

    updatedAt: Date

    The time the task execution was updated.

    Settings

    Member Visibility

    On This Page

    Properties