providerplaneai
    Preparing search index...

    Interface WorkflowRunnerHooks

    Lifecycle hooks emitted by WorkflowRunner.

    interface WorkflowRunnerHooks {
        onNodeChunk?: (
            workflowId: string,
            nodeId: string,
            chunk: JobChunk<any>,
        ) => void;
        onNodeComplete?: (
            workflowId: string,
            nodeId: string,
            result: WorkflowStepResult,
        ) => void;
        onNodeError?: (
            workflowId: string,
            nodeId: string,
            error: Error,
            attempt: number,
            maxAttempts: number,
        ) => void;
        onNodeRetry?: (
            workflowId: string,
            nodeId: string,
            error: Error,
            attempt: number,
            maxAttempts: number,
        ) => void;
        onNodeStart?: (workflowId: string, nodeId: string) => void;
        onWorkflowComplete?: (
            workflowId: string,
            execution: WorkflowExecution<any>,
        ) => void;
        onWorkflowError?: (
            workflowId: string,
            error: Error,
            execution: WorkflowExecution<any>,
        ) => void;
        onWorkflowStart?: (workflowId: string) => void;
    }
    Index

    Properties

    onNodeChunk? onNodeComplete? onNodeError? onNodeRetry? onNodeStart? onWorkflowComplete? onWorkflowError? onWorkflowStart?

    Properties

    onNodeChunk?: (workflowId: string, nodeId: string, chunk: JobChunk<any>) => void

    Called for every streamed chunk emitted by a workflow node job.

    onNodeComplete?: (
        workflowId: string,
        nodeId: string,
        result: WorkflowStepResult,
    ) => void

    Called when a node completes (including retries resolved).

    onNodeError?: (
        workflowId: string,
        nodeId: string,
        error: Error,
        attempt: number,
        maxAttempts: number,
    ) => void

    Called when a node attempt fails and retries are exhausted.

    onNodeRetry?: (
        workflowId: string,
        nodeId: string,
        error: Error,
        attempt: number,
        maxAttempts: number,
    ) => void

    Called when a node attempt fails but will be retried.

    onNodeStart?: (workflowId: string, nodeId: string) => void

    Called when a node starts executing.

    onWorkflowComplete?: (
        workflowId: string,
        execution: WorkflowExecution<any>,
    ) => void

    Called once when workflow execution completes successfully.

    onWorkflowError?: (
        workflowId: string,
        error: Error,
        execution: WorkflowExecution<any>,
    ) => void

    Called once when workflow execution fails.

    onWorkflowStart?: (workflowId: string) => void

    Called once when workflow execution starts.

    Settings

    Member Visibility

    On This Page

    Properties