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

Convex component for durably executing workflows.

import { type MutationCtx } from "./_generated/server.js";
import type { Doc, Id } from "./_generated/dataModel.js";
export declare function awaitEvent(ctx: MutationCtx, entry: Doc<"steps">, args: {
    eventId?: Id<"events">;
    name: string;
}): Promise<{
    _id: import("convex/values").GenericId<"steps">;
    _creationTime: number;
    workflowId: import("convex/values").GenericId<"workflows">;
    stepNumber: number;
    step: {
        kind?: "function" | undefined;
        runResult?: {
            kind: "success";
            returnValue: any;
        } | {
            kind: "failed";
            error: string;
        } | {
            kind: "canceled";
        } | undefined;
        completedAt?: number | undefined;
        workId?: import("@convex-dev/workpool").WorkId | undefined;
        name: string;
        args: any;
        startedAt: number;
        functionType: "mutation" | "query" | "action";
        handle: string;
        inProgress: boolean;
        argsSize: number;
    } | {
        workflowId?: import("convex/values").GenericId<"workflows"> | undefined;
        runResult?: {
            kind: "success";
            returnValue: any;
        } | {
            kind: "failed";
            error: string;
        } | {
            kind: "canceled";
        } | undefined;
        completedAt?: number | undefined;
        kind: "workflow";
        name: string;
        args: any;
        startedAt: number;
        handle: string;
        inProgress: boolean;
        argsSize: number;
    } | {
        runResult?: {
            kind: "success";
            returnValue: any;
        } | {
            kind: "failed";
            error: string;
        } | {
            kind: "canceled";
        } | undefined;
        completedAt?: number | undefined;
        eventId?: import("convex/values").GenericId<"events"> | undefined;
        kind: "event";
        name: string;
        args: {
            eventId?: import("convex/values").GenericId<"events"> | undefined;
        };
        startedAt: number;
        inProgress: boolean;
        argsSize: number;
    } | {
        runResult?: {
            kind: "success";
            returnValue: any;
        } | {
            kind: "failed";
            error: string;
        } | {
            kind: "canceled";
        } | undefined;
        completedAt?: number | undefined;
        workId?: import("@convex-dev/workpool").WorkId | undefined;
        kind: "sleep";
        name: string;
        args: any;
        startedAt: number;
        inProgress: boolean;
        argsSize: number;
    };
}>;
export declare const send: import("convex/server").RegisteredMutation<"public", {
    workflowId?: import("convex/values").GenericId<"workflows"> | undefined;
    name?: string | undefined;
    eventId?: import("convex/values").GenericId<"events"> | undefined;
    workpoolOptions?: {
        logLevel?: "DEBUG" | "TRACE" | "INFO" | "REPORT" | "WARN" | "ERROR" | undefined;
        maxParallelism?: number | undefined;
        defaultRetryBehavior?: {
            maxAttempts: number;
            initialBackoffMs: number;
            base: number;
        } | undefined;
        retryActionsByDefault?: boolean | undefined;
    } | undefined;
    result: {
        kind: "success";
        returnValue: any;
    } | {
        kind: "failed";
        error: string;
    } | {
        kind: "canceled";
    };
}, Promise<import("convex/values").GenericId<"events">>>;
export declare const create: import("convex/server").RegisteredMutation<"public", {
    workflowId: import("convex/values").GenericId<"workflows">;
    name: string;
}, Promise<import("convex/values").GenericId<"events">>>;
//# sourceMappingURL=event.d.ts.map