@convex-dev/workpool/dist/commonjs/component/schema.d.ts

A Convex component for managing async work.

declare const _default: import("convex/server").SchemaDefinition<{
    globals: import("convex/server").TableDefinition<import("convex/values").VObject<{
        maxParallelism: number;
        logLevel: "DEBUG" | "TRACE" | "INFO" | "REPORT" | "WARN" | "ERROR";
    }, {
        maxParallelism: import("convex/values").VFloat64<number, "required">;
        logLevel: import("convex/values").VUnion<"DEBUG" | "TRACE" | "INFO" | "REPORT" | "WARN" | "ERROR", [import("convex/values").VLiteral<"DEBUG", "required">, import("convex/values").VLiteral<"TRACE", "required">, import("convex/values").VLiteral<"INFO", "required">, import("convex/values").VLiteral<"REPORT", "required">, import("convex/values").VLiteral<"WARN", "required">, import("convex/values").VLiteral<"ERROR", "required">], "required", never>;
    }, "required", "maxParallelism" | "logLevel">, {}, {}, {}>;
    internalState: import("convex/server").TableDefinition<import("convex/values").VObject<{
        report: {
            failed: number;
            canceled: number;
            completed: number;
            succeeded: number;
            retries: number;
            lastReportTs: number;
        };
        running: {
            workId: import("convex/values").GenericId<"work">;
            scheduledId: import("convex/values").GenericId<"_scheduled_functions">;
            started: number;
        }[];
        lastRecovery: bigint;
        generation: bigint;
        segmentCursors: {
            incoming: bigint;
            completion: bigint;
            cancelation: bigint;
        };
    }, {
        generation: import("convex/values").VInt64<bigint, "required">;
        segmentCursors: import("convex/values").VObject<{
            incoming: bigint;
            completion: bigint;
            cancelation: bigint;
        }, {
            incoming: import("convex/values").VInt64<bigint, "required">;
            completion: import("convex/values").VInt64<bigint, "required">;
            cancelation: import("convex/values").VInt64<bigint, "required">;
        }, "required", "incoming" | "completion" | "cancelation">;
        lastRecovery: import("convex/values").VInt64<bigint, "required">;
        report: import("convex/values").VObject<{
            failed: number;
            canceled: number;
            completed: number;
            succeeded: number;
            retries: number;
            lastReportTs: number;
        }, {
            completed: import("convex/values").VFloat64<number, "required">;
            succeeded: import("convex/values").VFloat64<number, "required">;
            failed: import("convex/values").VFloat64<number, "required">;
            retries: import("convex/values").VFloat64<number, "required">;
            canceled: import("convex/values").VFloat64<number, "required">;
            lastReportTs: import("convex/values").VFloat64<number, "required">;
        }, "required", "failed" | "canceled" | "completed" | "succeeded" | "retries" | "lastReportTs">;
        running: import("convex/values").VArray<{
            workId: import("convex/values").GenericId<"work">;
            scheduledId: import("convex/values").GenericId<"_scheduled_functions">;
            started: number;
        }[], import("convex/values").VObject<{
            workId: import("convex/values").GenericId<"work">;
            scheduledId: import("convex/values").GenericId<"_scheduled_functions">;
            started: number;
        }, {
            workId: import("convex/values").VId<import("convex/values").GenericId<"work">, "required">;
            scheduledId: import("convex/values").VId<import("convex/values").GenericId<"_scheduled_functions">, "required">;
            started: import("convex/values").VFloat64<number, "required">;
        }, "required", "workId" | "scheduledId" | "started">, "required">;
    }, "required", "report" | "running" | "lastRecovery" | "generation" | "segmentCursors" | "report.failed" | "report.canceled" | "report.completed" | "report.succeeded" | "report.retries" | "report.lastReportTs" | "segmentCursors.incoming" | "segmentCursors.completion" | "segmentCursors.cancelation">, {}, {}, {}>;
    runStatus: import("convex/server").TableDefinition<import("convex/values").VObject<{
        state: {
            kind: "running";
        } | {
            kind: "scheduled";
            generation: bigint;
            scheduledId: import("convex/values").GenericId<"_scheduled_functions">;
            segment: bigint;
            saturated: boolean;
        } | {
            kind: "idle";
            generation: bigint;
        };
    }, {
        state: import("convex/values").VUnion<{
            kind: "running";
        } | {
            kind: "scheduled";
            generation: bigint;
            scheduledId: import("convex/values").GenericId<"_scheduled_functions">;
            segment: bigint;
            saturated: boolean;
        } | {
            kind: "idle";
            generation: bigint;
        }, [import("convex/values").VObject<{
            kind: "running";
        }, {
            kind: import("convex/values").VLiteral<"running", "required">;
        }, "required", "kind">, import("convex/values").VObject<{
            kind: "scheduled";
            generation: bigint;
            scheduledId: import("convex/values").GenericId<"_scheduled_functions">;
            segment: bigint;
            saturated: boolean;
        }, {
            kind: import("convex/values").VLiteral<"scheduled", "required">;
            segment: import("convex/values").VInt64<bigint, "required">;
            scheduledId: import("convex/values").VId<import("convex/values").GenericId<"_scheduled_functions">, "required">;
            saturated: import("convex/values").VBoolean<boolean, "required">;
            generation: import("convex/values").VInt64<bigint, "required">;
        }, "required", "kind" | "generation" | "scheduledId" | "segment" | "saturated">, import("convex/values").VObject<{
            kind: "idle";
            generation: bigint;
        }, {
            kind: import("convex/values").VLiteral<"idle", "required">;
            generation: import("convex/values").VInt64<bigint, "required">;
        }, "required", "kind" | "generation">], "required", "kind" | "generation" | "scheduledId" | "segment" | "saturated">;
    }, "required", "state" | "state.kind" | "state.generation" | "state.scheduledId" | "state.segment" | "state.saturated">, {}, {}, {}>;
    work: import("convex/server").TableDefinition<import("convex/values").VObject<{
        canceled?: boolean | undefined;
        onComplete?: {
            context?: any;
            fnHandle: string;
        } | undefined;
        retryBehavior?: {
            maxAttempts: number;
            initialBackoffMs: number;
            base: number;
        } | undefined;
        fnHandle: string;
        fnType: "action" | "mutation" | "query";
        fnName: string;
        fnArgs: any;
        attempts: number;
    }, {
        fnType: import("convex/values").VUnion<"action" | "mutation" | "query", [import("convex/values").VLiteral<"action", "required">, import("convex/values").VLiteral<"mutation", "required">, import("convex/values").VLiteral<"query", "required">], "required", never>;
        fnHandle: import("convex/values").VString<string, "required">;
        fnName: import("convex/values").VString<string, "required">;
        fnArgs: import("convex/values").VAny<any, "required", string>;
        attempts: import("convex/values").VFloat64<number, "required">;
        onComplete: import("convex/values").VObject<{
            context?: any;
            fnHandle: string;
        } | undefined, {
            fnHandle: import("convex/values").VString<string, "required">;
            context: import("convex/values").VAny<any, "optional", string>;
        }, "optional", "fnHandle" | "context" | `context.${string}`>;
        retryBehavior: import("convex/values").VObject<{
            maxAttempts: number;
            initialBackoffMs: number;
            base: number;
        } | undefined, {
            maxAttempts: import("convex/values").VFloat64<number, "required">;
            initialBackoffMs: import("convex/values").VFloat64<number, "required">;
            base: import("convex/values").VFloat64<number, "required">;
        }, "optional", "maxAttempts" | "initialBackoffMs" | "base">;
        canceled: import("convex/values").VBoolean<boolean | undefined, "optional">;
    }, "required", "canceled" | "fnHandle" | "fnType" | "fnName" | "fnArgs" | "attempts" | "onComplete" | "retryBehavior" | `fnArgs.${string}` | "onComplete.fnHandle" | "onComplete.context" | `onComplete.context.${string}` | "retryBehavior.maxAttempts" | "retryBehavior.initialBackoffMs" | "retryBehavior.base">, {}, {}, {}>;
    pendingStart: import("convex/server").TableDefinition<import("convex/values").VObject<{
        workId: import("convex/values").GenericId<"work">;
        segment: bigint;
    }, {
        workId: import("convex/values").VId<import("convex/values").GenericId<"work">, "required">;
        segment: import("convex/values").VInt64<bigint, "required">;
    }, "required", "workId" | "segment">, {
        workId: ["workId", "_creationTime"];
        segment: ["segment", "_creationTime"];
    }, {}, {}>;
    pendingCompletion: import("convex/server").TableDefinition<import("convex/values").VObject<{
        workId: import("convex/values").GenericId<"work">;
        segment: bigint;
        runResult: {
            kind: "success";
            returnValue: any;
        } | {
            kind: "failed";
            error: string;
        } | {
            kind: "canceled";
        };
        retry: boolean;
    }, {
        segment: import("convex/values").VInt64<bigint, "required">;
        runResult: import("convex/values").VUnion<{
            kind: "success";
            returnValue: any;
        } | {
            kind: "failed";
            error: string;
        } | {
            kind: "canceled";
        }, [import("convex/values").VObject<{
            kind: "success";
            returnValue: any;
        }, {
            kind: import("convex/values").VLiteral<"success", "required">;
            returnValue: import("convex/values").VAny<any, "required", string>;
        }, "required", "kind" | "returnValue" | `returnValue.${string}`>, import("convex/values").VObject<{
            kind: "failed";
            error: string;
        }, {
            kind: import("convex/values").VLiteral<"failed", "required">;
            error: import("convex/values").VString<string, "required">;
        }, "required", "kind" | "error">, import("convex/values").VObject<{
            kind: "canceled";
        }, {
            kind: import("convex/values").VLiteral<"canceled", "required">;
        }, "required", "kind">], "required", "kind" | "returnValue" | `returnValue.${string}` | "error">;
        workId: import("convex/values").VId<import("convex/values").GenericId<"work">, "required">;
        retry: import("convex/values").VBoolean<boolean, "required">;
    }, "required", "workId" | "segment" | "runResult" | "retry" | "runResult.kind" | "runResult.returnValue" | `runResult.returnValue.${string}` | "runResult.error">, {
        workId: ["workId", "_creationTime"];
        segment: ["segment", "_creationTime"];
    }, {}, {}>;
    pendingCancelation: import("convex/server").TableDefinition<import("convex/values").VObject<{
        workId: import("convex/values").GenericId<"work">;
        segment: bigint;
    }, {
        segment: import("convex/values").VInt64<bigint, "required">;
        workId: import("convex/values").VId<import("convex/values").GenericId<"work">, "required">;
    }, "required", "workId" | "segment">, {
        workId: ["workId", "_creationTime"];
        segment: ["segment", "_creationTime"];
    }, {}, {}>;
}, true>;
export default _default;
//# sourceMappingURL=schema.d.ts.map