@queuedash/ui/dist/src/utils/trpc.d.ts

A stunning, sleek dashboard for Bull, BullMQ, and Bee-Queue

import type { AppRouter } from "@queuedash/api";
import type { inferRouterInputs, inferRouterOutputs } from "@trpc/server";
export type RouterOutput = inferRouterOutputs<AppRouter>;
export type RouterInput = inferRouterInputs<AppRouter>;
export type Job = RouterOutput["job"]["list"]["jobs"][0];
export type Queue = RouterOutput["queue"]["byName"];
export type Status = RouterInput["job"]["list"]["status"];
export type Scheduler = RouterOutput["scheduler"]["list"][0];
export declare const trpc: import("@trpc/react-query").CreateTRPCReactBase<import("@trpc/server").TRPCBuiltRouter<{
    ctx: import("@queuedash/api").Context;
    meta: object;
    errorShape: import("@trpc/server").TRPCDefaultErrorShape;
    transformer: false;
}, import("@trpc/server").TRPCDecorateCreateRouterOptions<{
    job: import("@trpc/server").TRPCBuiltRouter<{
        ctx: import("@queuedash/api").Context;
        meta: object;
        errorShape: import("@trpc/server").TRPCDefaultErrorShape;
        transformer: false;
    }, import("@trpc/server").TRPCDecorateCreateRouterOptions<{
        retry: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                jobId: string;
                queueName: string;
            };
            output: import("@queuedash/api/dist/src/queue-adapters/base.adapter").AdaptedJob;
            meta: object;
        }>;
        discard: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                jobId: string;
                queueName: string;
            };
            output: import("@queuedash/api/dist/src/queue-adapters/base.adapter").AdaptedJob;
            meta: object;
        }>;
        rerun: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                jobId: string;
                queueName: string;
            };
            output: import("@queuedash/api/dist/src/queue-adapters/base.adapter").AdaptedJob;
            meta: object;
        }>;
        promote: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                jobId: string;
                queueName: string;
            };
            output: import("@queuedash/api/dist/src/queue-adapters/base.adapter").AdaptedJob;
            meta: object;
        }>;
        remove: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                jobId: string;
                queueName: string;
            };
            output: import("@queuedash/api/dist/src/queue-adapters/base.adapter").AdaptedJob;
            meta: object;
        }>;
        bulkRemove: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                queueName: string;
                jobIds: string[];
            };
            output: import("@queuedash/api/dist/src/queue-adapters/base.adapter").AdaptedJob[];
            meta: object;
        }>;
        logs: import("@trpc/server").TRPCQueryProcedure<{
            input: {
                jobId: string;
                queueName: string;
            };
            output: string[] | null;
            meta: object;
        }>;
        list: import("@trpc/server").TRPCQueryProcedure<{
            input: {
                limit: number;
                status: "completed" | "failed" | "delayed" | "active" | "waiting" | "paused" | "waiting-children" | "prioritized";
                queueName: string;
                cursor?: number | undefined;
            };
            output: {
                totalCount: number;
                numOfPages: number;
                nextCursor: number | undefined;
                jobs: import("@queuedash/api/dist/src/queue-adapters/base.adapter").AdaptedJob[];
            };
            meta: object;
        }>;
    }>>;
    queue: import("@trpc/server").TRPCBuiltRouter<{
        ctx: import("@queuedash/api").Context;
        meta: object;
        errorShape: import("@trpc/server").TRPCDefaultErrorShape;
        transformer: false;
    }, import("@trpc/server").TRPCDecorateCreateRouterOptions<{
        clean: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                status: string;
                queueName: string;
            };
            output: {
                name: string;
            };
            meta: object;
        }>;
        empty: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                queueName: string;
            };
            output: {
                name: string;
            };
            meta: object;
        }>;
        pause: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                queueName: string;
            };
            output: {
                name: string;
            };
            meta: object;
        }>;
        pauseAll: import("@trpc/server").TRPCMutationProcedure<{
            input: void;
            output: string;
            meta: object;
        }>;
        resume: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                queueName: string;
            };
            output: {
                name: string;
            };
            meta: object;
        }>;
        resumeAll: import("@trpc/server").TRPCMutationProcedure<{
            input: void;
            output: string;
            meta: object;
        }>;
        addJob: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                queueName: string;
                data: {} & {
                    [k: string]: unknown;
                };
            };
            output: {
                name: string;
            };
            meta: object;
        }>;
        addJobScheduler: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                queueName: string;
                template: {
                    name?: string | undefined;
                    data?: any;
                    opts?: any;
                };
                opts?: {
                    every?: number | undefined;
                    tz?: string | undefined;
                    pattern?: string | undefined;
                } | undefined;
            };
            output: {
                name: string;
            };
            meta: object;
        }>;
        byName: import("@trpc/server").TRPCQueryProcedure<{
            input: {
                queueName: string;
            };
            output: {
                displayName: string;
                name: string;
                paused: boolean;
                type: "bull" | "bullmq" | "bee" | "groupmq";
                supports: import("@queuedash/api/dist/src/queue-adapters/base.adapter").FeatureSupport<string>;
                counts: {
                    active: number;
                    completed: number;
                    delayed: number;
                    failed: number;
                    waiting: number;
                    prioritized: number;
                    "waiting-children": number;
                    paused: number;
                };
                client: {
                    usedMemoryPercentage: number;
                    usedMemoryHuman: string;
                    totalMemoryHuman: string;
                    uptimeInSeconds: number;
                    connectedClients: number;
                    blockedClients: number;
                    maxClients: number;
                    version: string;
                };
            };
            meta: object;
        }>;
        list: import("@trpc/server").TRPCQueryProcedure<{
            input: void;
            output: {
                displayName: string;
                name: string;
            }[];
            meta: object;
        }>;
        metrics: import("@trpc/server").TRPCQueryProcedure<{
            input: {
                type: "completed" | "failed";
                queueName: string;
                start: number;
                end: number;
            };
            output: import("@queuedash/api/dist/src/queue-adapters/base.adapter").QueueMetrics;
            meta: object;
        }>;
    }>>;
    scheduler: import("@trpc/server").TRPCBuiltRouter<{
        ctx: import("@queuedash/api").Context;
        meta: object;
        errorShape: import("@trpc/server").TRPCDefaultErrorShape;
        transformer: false;
    }, import("@trpc/server").TRPCDecorateCreateRouterOptions<{
        list: import("@trpc/server").TRPCQueryProcedure<{
            input: {
                queueName: string;
            };
            output: import("@queuedash/api/dist/src/queue-adapters/base.adapter").SchedulerInfo[];
            meta: object;
        }>;
        add: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                queueName: string;
                data: Record<string, any>;
                jobName: string;
                every?: number | undefined;
                tz?: string | undefined;
                pattern?: string | undefined;
            };
            output: {
                success: boolean;
            };
            meta: object;
        }>;
        remove: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                queueName: string;
                jobSchedulerId: string;
            };
            output: {
                success: boolean;
            };
            meta: object;
        }>;
        bulkRemove: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                queueName: string;
                jobSchedulerIds: string[];
            };
            output: import("@queuedash/api/dist/src/queue-adapters/base.adapter").SchedulerInfo[];
            meta: object;
        }>;
    }>>;
}>>, unknown> & import("@trpc/react-query/dist/getQueryKey.d-C_PnqPni.cjs").DecorateRouterRecord<{
    ctx: import("@queuedash/api").Context;
    meta: object;
    errorShape: import("@trpc/server").TRPCDefaultErrorShape;
    transformer: false;
}, import("@trpc/server").TRPCDecorateCreateRouterOptions<{
    job: import("@trpc/server").TRPCBuiltRouter<{
        ctx: import("@queuedash/api").Context;
        meta: object;
        errorShape: import("@trpc/server").TRPCDefaultErrorShape;
        transformer: false;
    }, import("@trpc/server").TRPCDecorateCreateRouterOptions<{
        retry: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                jobId: string;
                queueName: string;
            };
            output: import("@queuedash/api/dist/src/queue-adapters/base.adapter").AdaptedJob;
            meta: object;
        }>;
        discard: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                jobId: string;
                queueName: string;
            };
            output: import("@queuedash/api/dist/src/queue-adapters/base.adapter").AdaptedJob;
            meta: object;
        }>;
        rerun: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                jobId: string;
                queueName: string;
            };
            output: import("@queuedash/api/dist/src/queue-adapters/base.adapter").AdaptedJob;
            meta: object;
        }>;
        promote: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                jobId: string;
                queueName: string;
            };
            output: import("@queuedash/api/dist/src/queue-adapters/base.adapter").AdaptedJob;
            meta: object;
        }>;
        remove: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                jobId: string;
                queueName: string;
            };
            output: import("@queuedash/api/dist/src/queue-adapters/base.adapter").AdaptedJob;
            meta: object;
        }>;
        bulkRemove: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                queueName: string;
                jobIds: string[];
            };
            output: import("@queuedash/api/dist/src/queue-adapters/base.adapter").AdaptedJob[];
            meta: object;
        }>;
        logs: import("@trpc/server").TRPCQueryProcedure<{
            input: {
                jobId: string;
                queueName: string;
            };
            output: string[] | null;
            meta: object;
        }>;
        list: import("@trpc/server").TRPCQueryProcedure<{
            input: {
                limit: number;
                status: "completed" | "failed" | "delayed" | "active" | "waiting" | "paused" | "waiting-children" | "prioritized";
                queueName: string;
                cursor?: number | undefined;
            };
            output: {
                totalCount: number;
                numOfPages: number;
                nextCursor: number | undefined;
                jobs: import("@queuedash/api/dist/src/queue-adapters/base.adapter").AdaptedJob[];
            };
            meta: object;
        }>;
    }>>;
    queue: import("@trpc/server").TRPCBuiltRouter<{
        ctx: import("@queuedash/api").Context;
        meta: object;
        errorShape: import("@trpc/server").TRPCDefaultErrorShape;
        transformer: false;
    }, import("@trpc/server").TRPCDecorateCreateRouterOptions<{
        clean: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                status: string;
                queueName: string;
            };
            output: {
                name: string;
            };
            meta: object;
        }>;
        empty: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                queueName: string;
            };
            output: {
                name: string;
            };
            meta: object;
        }>;
        pause: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                queueName: string;
            };
            output: {
                name: string;
            };
            meta: object;
        }>;
        pauseAll: import("@trpc/server").TRPCMutationProcedure<{
            input: void;
            output: string;
            meta: object;
        }>;
        resume: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                queueName: string;
            };
            output: {
                name: string;
            };
            meta: object;
        }>;
        resumeAll: import("@trpc/server").TRPCMutationProcedure<{
            input: void;
            output: string;
            meta: object;
        }>;
        addJob: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                queueName: string;
                data: {} & {
                    [k: string]: unknown;
                };
            };
            output: {
                name: string;
            };
            meta: object;
        }>;
        addJobScheduler: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                queueName: string;
                template: {
                    name?: string | undefined;
                    data?: any;
                    opts?: any;
                };
                opts?: {
                    every?: number | undefined;
                    tz?: string | undefined;
                    pattern?: string | undefined;
                } | undefined;
            };
            output: {
                name: string;
            };
            meta: object;
        }>;
        byName: import("@trpc/server").TRPCQueryProcedure<{
            input: {
                queueName: string;
            };
            output: {
                displayName: string;
                name: string;
                paused: boolean;
                type: "bull" | "bullmq" | "bee" | "groupmq";
                supports: import("@queuedash/api/dist/src/queue-adapters/base.adapter").FeatureSupport<string>;
                counts: {
                    active: number;
                    completed: number;
                    delayed: number;
                    failed: number;
                    waiting: number;
                    prioritized: number;
                    "waiting-children": number;
                    paused: number;
                };
                client: {
                    usedMemoryPercentage: number;
                    usedMemoryHuman: string;
                    totalMemoryHuman: string;
                    uptimeInSeconds: number;
                    connectedClients: number;
                    blockedClients: number;
                    maxClients: number;
                    version: string;
                };
            };
            meta: object;
        }>;
        list: import("@trpc/server").TRPCQueryProcedure<{
            input: void;
            output: {
                displayName: string;
                name: string;
            }[];
            meta: object;
        }>;
        metrics: import("@trpc/server").TRPCQueryProcedure<{
            input: {
                type: "completed" | "failed";
                queueName: string;
                start: number;
                end: number;
            };
            output: import("@queuedash/api/dist/src/queue-adapters/base.adapter").QueueMetrics;
            meta: object;
        }>;
    }>>;
    scheduler: import("@trpc/server").TRPCBuiltRouter<{
        ctx: import("@queuedash/api").Context;
        meta: object;
        errorShape: import("@trpc/server").TRPCDefaultErrorShape;
        transformer: false;
    }, import("@trpc/server").TRPCDecorateCreateRouterOptions<{
        list: import("@trpc/server").TRPCQueryProcedure<{
            input: {
                queueName: string;
            };
            output: import("@queuedash/api/dist/src/queue-adapters/base.adapter").SchedulerInfo[];
            meta: object;
        }>;
        add: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                queueName: string;
                data: Record<string, any>;
                jobName: string;
                every?: number | undefined;
                tz?: string | undefined;
                pattern?: string | undefined;
            };
            output: {
                success: boolean;
            };
            meta: object;
        }>;
        remove: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                queueName: string;
                jobSchedulerId: string;
            };
            output: {
                success: boolean;
            };
            meta: object;
        }>;
        bulkRemove: import("@trpc/server").TRPCMutationProcedure<{
            input: {
                queueName: string;
                jobSchedulerIds: string[];
            };
            output: import("@queuedash/api/dist/src/queue-adapters/base.adapter").SchedulerInfo[];
            meta: object;
        }>;
    }>>;
}>>;
//# sourceMappingURL=trpc.d.ts.map