@convex-dev/workflow/dist/commonjs/component/workflow.d.ts

Convex component for durably executing workflows.

import { Id } from "./_generated/dataModel.js";
import { QueryCtx } from "./_generated/server.js";
export declare const create: import("convex/server").RegisteredMutation<"public", {
    maxParallelism?: number | undefined;
    onComplete?: {
        context?: any;
        fnHandle: string;
    } | undefined;
    validateAsync?: boolean | undefined;
    workflowHandle: string;
    workflowName: string;
    workflowArgs: any;
}, Promise<string>>;
export declare const getStatus: import("convex/server").RegisteredQuery<"public", {
    workflowId: Id<"workflows">;
}, Promise<{
    workflow: {
        _id: import("convex/values").GenericId<"workflows">;
        _creationTime: number;
        logLevel?: null | undefined;
        name?: string | undefined;
        onComplete?: {
            context?: any;
            fnHandle: string;
        } | undefined;
        startedAt?: null | undefined;
        state?: null | undefined;
        runResult?: {
            kind: "success";
            returnValue: any;
        } | {
            kind: "failed";
            error: string;
        } | {
            kind: "canceled";
        } | undefined;
        workflowHandle: string;
        args: any;
        generationNumber: number;
    };
    inProgress: {
        _creationTime: number;
        workflowId: import("convex/values").GenericId<"workflows">;
        stepNumber: number;
        step: {
            runResult?: {
                kind: "success";
                returnValue: any;
            } | {
                kind: "failed";
                error: string;
            } | {
                kind: "canceled";
            } | undefined;
            workId?: import("@convex-dev/workpool").WorkId | undefined;
            completedAt?: number | undefined;
            name: string;
            args: any;
            startedAt: number;
            inProgress: boolean;
            functionType: "query" | "mutation" | "action";
            handle: string;
            argsSize: number;
        };
        _id: string;
    }[];
    logLevel: "DEBUG" | "TRACE" | "INFO" | "REPORT" | "WARN" | "ERROR";
}>>;
export declare function getStatusHandler(ctx: QueryCtx, args: {
    workflowId: Id<"workflows">;
}): Promise<{
    workflow: {
        _id: import("convex/values").GenericId<"workflows">;
        _creationTime: number;
        logLevel?: null | undefined;
        name?: string | undefined;
        onComplete?: {
            context?: any;
            fnHandle: string;
        } | undefined;
        startedAt?: null | undefined;
        state?: null | undefined;
        runResult?: {
            kind: "success";
            returnValue: any;
        } | {
            kind: "failed";
            error: string;
        } | {
            kind: "canceled";
        } | undefined;
        workflowHandle: string;
        args: any;
        generationNumber: number;
    };
    inProgress: {
        _creationTime: number;
        workflowId: import("convex/values").GenericId<"workflows">;
        stepNumber: number;
        step: {
            runResult?: {
                kind: "success";
                returnValue: any;
            } | {
                kind: "failed";
                error: string;
            } | {
                kind: "canceled";
            } | undefined;
            workId?: import("@convex-dev/workpool").WorkId | undefined;
            completedAt?: number | undefined;
            name: string;
            args: any;
            startedAt: number;
            inProgress: boolean;
            functionType: "query" | "mutation" | "action";
            handle: string;
            argsSize: number;
        };
        _id: string;
    }[];
    logLevel: "DEBUG" | "TRACE" | "INFO" | "REPORT" | "WARN" | "ERROR";
}>;
export declare const cancel: import("convex/server").RegisteredMutation<"public", {
    workflowId: import("convex/values").GenericId<"workflows">;
}, Promise<void>>;
export declare const complete: import("convex/server").RegisteredMutation<"public", {
    runResult: {
        kind: "success";
        returnValue: any;
    } | {
        kind: "failed";
        error: string;
    } | {
        kind: "canceled";
    };
    generationNumber: number;
    workflowId: import("convex/values").GenericId<"workflows">;
    now: number;
}, Promise<void>>;
export declare const cleanup: import("convex/server").RegisteredMutation<"public", {
    workflowId: string;
}, Promise<boolean>>;
//# sourceMappingURL=workflow.d.ts.map