providerplaneai
    Preparing search index...

    Interface CreateWorkflowRuntimeOptions

    Options for createWorkflowRuntime.

    interface CreateWorkflowRuntimeOptions {
        hooks?: WorkflowRunnerHooks;
        loadPersistedJobs?: () => JobSnapshot<any, any>[];
        loadWorkflowExecution?: (
            workflowId: string,
        ) =>
            | WorkflowExecutionSnapshot<any>
            | Promise<WorkflowExecutionSnapshot<any> | undefined>
            | undefined;
        persistJobs?: (snapshots: JobSnapshot<any, any>[]) => void;
        persistWorkflowExecution?: (
            snapshot: WorkflowExecutionSnapshot<any>,
        ) => void | Promise<void>;
        shouldResumeWorkflow?: (workflowId: string) => boolean;
    }
    Index

    Properties

    hooks? loadPersistedJobs? loadWorkflowExecution? persistJobs? persistWorkflowExecution? shouldResumeWorkflow?

    Properties

    hooks?: WorkflowRunnerHooks

    Optional workflow lifecycle hooks forwarded to WorkflowRunner.

    loadPersistedJobs?: () => JobSnapshot<any, any>[]

    Optional job snapshot loader forwarded to JobManager.

    loadWorkflowExecution?: (
        workflowId: string,
    ) =>
        | WorkflowExecutionSnapshot<any>
        | Promise<WorkflowExecutionSnapshot<any> | undefined>
        | undefined

    Optional workflow execution snapshot loader forwarded to WorkflowRunner.

    persistJobs?: (snapshots: JobSnapshot<any, any>[]) => void

    Optional job snapshot persistence callback forwarded to JobManager.

    persistWorkflowExecution?: (
        snapshot: WorkflowExecutionSnapshot<any>,
    ) => void | Promise<void>

    Optional workflow execution snapshot persistence callback forwarded to WorkflowRunner.

    shouldResumeWorkflow?: (workflowId: string) => boolean

    Optional policy function that decides whether a workflow should resume instead of starting fresh.

    Settings

    Member Visibility

    On This Page

    Properties