@queuedash/ui
Version:
A stunning, sleek dashboard for Bull, BullMQ, and Bee-Queue
830 lines • 29.7 kB
TypeScript
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/unstable-core-do-not-import").BuiltRouter<{
ctx: import("@queuedash/api").Context;
meta: object;
errorShape: import("@trpc/server/unstable-core-do-not-import").DefaultErrorShape;
transformer: false;
}, import("@trpc/server/unstable-core-do-not-import").DecorateCreateRouterOptions<{
job: import("@trpc/server/unstable-core-do-not-import").BuiltRouter<{
ctx: import("@queuedash/api").Context;
meta: object;
errorShape: import("@trpc/server/unstable-core-do-not-import").DefaultErrorShape;
transformer: false;
}, import("@trpc/server/unstable-core-do-not-import").DecorateCreateRouterOptions<{
retry: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
jobId: string;
};
output: {
id: string;
name: string;
data: object;
opts: {
priority?: number;
delay?: number;
attempts?: number;
backoff?: number;
lifo?: boolean;
timeout?: number;
removeOnComplete?: boolean | number;
removeOnFail?: boolean | number;
stackTraceLimit?: number;
preventParsingData?: boolean;
repeat?: {
offset: number;
tz: string;
pattern: string;
count: number;
};
};
createdAt: Date;
processedAt: Date | null;
finishedAt: Date | null;
failedReason?: string;
stacktrace?: string[];
retriedAt: Date | null;
};
}>;
discard: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
jobId: string;
};
output: {
id: string;
name: string;
data: object;
opts: {
priority?: number;
delay?: number;
attempts?: number;
backoff?: number;
lifo?: boolean;
timeout?: number;
removeOnComplete?: boolean | number;
removeOnFail?: boolean | number;
stackTraceLimit?: number;
preventParsingData?: boolean;
repeat?: {
offset: number;
tz: string;
pattern: string;
count: number;
};
};
createdAt: Date;
processedAt: Date | null;
finishedAt: Date | null;
failedReason?: string;
stacktrace?: string[];
retriedAt: Date | null;
};
}>;
rerun: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
jobId: string;
};
output: {
id: string;
name: string;
data: object;
opts: {
priority?: number;
delay?: number;
attempts?: number;
backoff?: number;
lifo?: boolean;
timeout?: number;
removeOnComplete?: boolean | number;
removeOnFail?: boolean | number;
stackTraceLimit?: number;
preventParsingData?: boolean;
repeat?: {
offset: number;
tz: string;
pattern: string;
count: number;
};
};
createdAt: Date;
processedAt: Date | null;
finishedAt: Date | null;
failedReason?: string;
stacktrace?: string[];
retriedAt: Date | null;
};
}>;
promote: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
jobId: string;
};
output: {
id: string;
name: string;
data: object;
opts: {
priority?: number;
delay?: number;
attempts?: number;
backoff?: number;
lifo?: boolean;
timeout?: number;
removeOnComplete?: boolean | number;
removeOnFail?: boolean | number;
stackTraceLimit?: number;
preventParsingData?: boolean;
repeat?: {
offset: number;
tz: string;
pattern: string;
count: number;
};
};
createdAt: Date;
processedAt: Date | null;
finishedAt: Date | null;
failedReason?: string;
stacktrace?: string[];
retriedAt: Date | null;
};
}>;
remove: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
jobId: string;
};
output: {
id: string;
name: string;
data: object;
opts: {
priority?: number;
delay?: number;
attempts?: number;
backoff?: number;
lifo?: boolean;
timeout?: number;
removeOnComplete?: boolean | number;
removeOnFail?: boolean | number;
stackTraceLimit?: number;
preventParsingData?: boolean;
repeat?: {
offset: number;
tz: string;
pattern: string;
count: number;
};
};
createdAt: Date;
processedAt: Date | null;
finishedAt: Date | null;
failedReason?: string;
stacktrace?: string[];
retriedAt: Date | null;
};
}>;
bulkRemove: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
jobIds: string[];
};
output: {
id: string;
name: string;
data: object;
opts: {
priority?: number;
delay?: number;
attempts?: number;
backoff?: number;
lifo?: boolean;
timeout?: number;
removeOnComplete?: boolean | number;
removeOnFail?: boolean | number;
stackTraceLimit?: number;
preventParsingData?: boolean;
repeat?: {
offset: number;
tz: string;
pattern: string;
count: number;
};
};
createdAt: Date;
processedAt: Date | null;
finishedAt: Date | null;
failedReason?: string;
stacktrace?: string[];
retriedAt: Date | null;
}[];
}>;
logs: import("@trpc/server").TRPCQueryProcedure<{
input: {
queueName: string;
jobId: string;
};
output: string[] | null;
}>;
list: import("@trpc/server").TRPCQueryProcedure<{
input: {
status: "completed" | "failed" | "delayed" | "active" | "prioritized" | "waiting" | "paused";
queueName: string;
limit: number;
cursor?: number | undefined;
};
output: {
totalCount: number;
numOfPages: number;
nextCursor: number | undefined;
jobs: {
id: string;
name: string;
data: object;
opts: {
priority?: number;
delay?: number;
attempts?: number;
backoff?: number;
lifo?: boolean;
timeout?: number;
removeOnComplete?: boolean | number;
removeOnFail?: boolean | number;
stackTraceLimit?: number;
preventParsingData?: boolean;
repeat?: {
offset: number;
tz: string;
pattern: string;
count: number;
};
};
createdAt: Date;
processedAt: Date | null;
finishedAt: Date | null;
failedReason?: string;
stacktrace?: string[];
retriedAt: Date | null;
}[];
};
}>;
}>>;
queue: import("@trpc/server/unstable-core-do-not-import").BuiltRouter<{
ctx: import("@queuedash/api").Context;
meta: object;
errorShape: import("@trpc/server/unstable-core-do-not-import").DefaultErrorShape;
transformer: false;
}, import("@trpc/server/unstable-core-do-not-import").DecorateCreateRouterOptions<{
clean: import("@trpc/server").TRPCMutationProcedure<{
input: {
status: "completed" | "failed" | "delayed" | "active" | "prioritized" | "waiting" | "paused";
queueName: string;
};
output: {
name: string;
};
}>;
empty: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
};
output: {
name: string;
};
}>;
pause: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
};
output: {
name: string;
};
}>;
pauseAll: import("@trpc/server").TRPCMutationProcedure<{
input: void;
output: string;
}>;
resume: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
};
output: {
name: string;
};
}>;
resumeAll: import("@trpc/server").TRPCMutationProcedure<{
input: void;
output: string;
}>;
addJob: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
data: {} & {
[k: string]: unknown;
};
};
output: {
name: string;
};
}>;
byName: import("@trpc/server").TRPCQueryProcedure<{
input: {
queueName: string;
};
output: {
displayName: string;
name: string;
paused: boolean;
type: "bull" | "bullmq" | "bee";
counts: {
waiting: number;
paused: number;
prioritized?: number | undefined;
active: number;
completed: number;
delayed: number;
failed: number;
};
client: {
usedMemoryPercentage: number;
usedMemoryHuman: string;
totalMemoryHuman: string;
uptimeInSeconds: number;
connectedClients: number;
blockedClients: number;
maxClients: number;
version: string;
};
};
}>;
list: import("@trpc/server").TRPCQueryProcedure<{
input: void;
output: {
displayName: string;
name: string;
}[];
}>;
}>>;
scheduler: import("@trpc/server/unstable-core-do-not-import").BuiltRouter<{
ctx: import("@queuedash/api").Context;
meta: object;
errorShape: import("@trpc/server/unstable-core-do-not-import").DefaultErrorShape;
transformer: false;
}, import("@trpc/server/unstable-core-do-not-import").DecorateCreateRouterOptions<{
list: import("@trpc/server").TRPCQueryProcedure<{
input: {
queueName: string;
};
output: import("@queuedash/api/dist/src/utils/global.utils").QueueDashScheduler[];
}>;
add: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
data: Record<string, any>;
jobName: string;
every?: number | undefined;
pattern?: string | undefined;
tz?: string | undefined;
};
output: {
success: boolean;
};
}>;
remove: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
jobSchedulerId: string;
};
output: {
success: boolean;
};
}>;
bulkRemove: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
jobSchedulerIds: string[];
};
output: import("@queuedash/api/dist/src/utils/global.utils").QueueDashScheduler[];
}>;
}>>;
}>>, unknown> & import("@trpc/react-query/dist/createTRPCReact").DecorateRouterRecord<{
ctx: import("@queuedash/api").Context;
meta: object;
errorShape: import("@trpc/server/unstable-core-do-not-import").DefaultErrorShape;
transformer: false;
}, import("@trpc/server/unstable-core-do-not-import").DecorateCreateRouterOptions<{
job: import("@trpc/server/unstable-core-do-not-import").BuiltRouter<{
ctx: import("@queuedash/api").Context;
meta: object;
errorShape: import("@trpc/server/unstable-core-do-not-import").DefaultErrorShape;
transformer: false;
}, import("@trpc/server/unstable-core-do-not-import").DecorateCreateRouterOptions<{
retry: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
jobId: string;
};
output: {
id: string;
name: string;
data: object;
opts: {
priority?: number;
delay?: number;
attempts?: number;
backoff?: number;
lifo?: boolean;
timeout?: number;
removeOnComplete?: boolean | number;
removeOnFail?: boolean | number;
stackTraceLimit?: number;
preventParsingData?: boolean;
repeat?: {
offset: number;
tz: string;
pattern: string;
count: number;
};
};
createdAt: Date;
processedAt: Date | null;
finishedAt: Date | null;
failedReason?: string;
stacktrace?: string[];
retriedAt: Date | null;
};
}>;
discard: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
jobId: string;
};
output: {
id: string;
name: string;
data: object;
opts: {
priority?: number;
delay?: number;
attempts?: number;
backoff?: number;
lifo?: boolean;
timeout?: number;
removeOnComplete?: boolean | number;
removeOnFail?: boolean | number;
stackTraceLimit?: number;
preventParsingData?: boolean;
repeat?: {
offset: number;
tz: string;
pattern: string;
count: number;
};
};
createdAt: Date;
processedAt: Date | null;
finishedAt: Date | null;
failedReason?: string;
stacktrace?: string[];
retriedAt: Date | null;
};
}>;
rerun: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
jobId: string;
};
output: {
id: string;
name: string;
data: object;
opts: {
priority?: number;
delay?: number;
attempts?: number;
backoff?: number;
lifo?: boolean;
timeout?: number;
removeOnComplete?: boolean | number;
removeOnFail?: boolean | number;
stackTraceLimit?: number;
preventParsingData?: boolean;
repeat?: {
offset: number;
tz: string;
pattern: string;
count: number;
};
};
createdAt: Date;
processedAt: Date | null;
finishedAt: Date | null;
failedReason?: string;
stacktrace?: string[];
retriedAt: Date | null;
};
}>;
promote: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
jobId: string;
};
output: {
id: string;
name: string;
data: object;
opts: {
priority?: number;
delay?: number;
attempts?: number;
backoff?: number;
lifo?: boolean;
timeout?: number;
removeOnComplete?: boolean | number;
removeOnFail?: boolean | number;
stackTraceLimit?: number;
preventParsingData?: boolean;
repeat?: {
offset: number;
tz: string;
pattern: string;
count: number;
};
};
createdAt: Date;
processedAt: Date | null;
finishedAt: Date | null;
failedReason?: string;
stacktrace?: string[];
retriedAt: Date | null;
};
}>;
remove: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
jobId: string;
};
output: {
id: string;
name: string;
data: object;
opts: {
priority?: number;
delay?: number;
attempts?: number;
backoff?: number;
lifo?: boolean;
timeout?: number;
removeOnComplete?: boolean | number;
removeOnFail?: boolean | number;
stackTraceLimit?: number;
preventParsingData?: boolean;
repeat?: {
offset: number;
tz: string;
pattern: string;
count: number;
};
};
createdAt: Date;
processedAt: Date | null;
finishedAt: Date | null;
failedReason?: string;
stacktrace?: string[];
retriedAt: Date | null;
};
}>;
bulkRemove: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
jobIds: string[];
};
output: {
id: string;
name: string;
data: object;
opts: {
priority?: number;
delay?: number;
attempts?: number;
backoff?: number;
lifo?: boolean;
timeout?: number;
removeOnComplete?: boolean | number;
removeOnFail?: boolean | number;
stackTraceLimit?: number;
preventParsingData?: boolean;
repeat?: {
offset: number;
tz: string;
pattern: string;
count: number;
};
};
createdAt: Date;
processedAt: Date | null;
finishedAt: Date | null;
failedReason?: string;
stacktrace?: string[];
retriedAt: Date | null;
}[];
}>;
logs: import("@trpc/server").TRPCQueryProcedure<{
input: {
queueName: string;
jobId: string;
};
output: string[] | null;
}>;
list: import("@trpc/server").TRPCQueryProcedure<{
input: {
status: "completed" | "failed" | "delayed" | "active" | "prioritized" | "waiting" | "paused";
queueName: string;
limit: number;
cursor?: number | undefined;
};
output: {
totalCount: number;
numOfPages: number;
nextCursor: number | undefined;
jobs: {
id: string;
name: string;
data: object;
opts: {
priority?: number;
delay?: number;
attempts?: number;
backoff?: number;
lifo?: boolean;
timeout?: number;
removeOnComplete?: boolean | number;
removeOnFail?: boolean | number;
stackTraceLimit?: number;
preventParsingData?: boolean;
repeat?: {
offset: number;
tz: string;
pattern: string;
count: number;
};
};
createdAt: Date;
processedAt: Date | null;
finishedAt: Date | null;
failedReason?: string;
stacktrace?: string[];
retriedAt: Date | null;
}[];
};
}>;
}>>;
queue: import("@trpc/server/unstable-core-do-not-import").BuiltRouter<{
ctx: import("@queuedash/api").Context;
meta: object;
errorShape: import("@trpc/server/unstable-core-do-not-import").DefaultErrorShape;
transformer: false;
}, import("@trpc/server/unstable-core-do-not-import").DecorateCreateRouterOptions<{
clean: import("@trpc/server").TRPCMutationProcedure<{
input: {
status: "completed" | "failed" | "delayed" | "active" | "prioritized" | "waiting" | "paused";
queueName: string;
};
output: {
name: string;
};
}>;
empty: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
};
output: {
name: string;
};
}>;
pause: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
};
output: {
name: string;
};
}>;
pauseAll: import("@trpc/server").TRPCMutationProcedure<{
input: void;
output: string;
}>;
resume: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
};
output: {
name: string;
};
}>;
resumeAll: import("@trpc/server").TRPCMutationProcedure<{
input: void;
output: string;
}>;
addJob: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
data: {} & {
[k: string]: unknown;
};
};
output: {
name: string;
};
}>;
byName: import("@trpc/server").TRPCQueryProcedure<{
input: {
queueName: string;
};
output: {
displayName: string;
name: string;
paused: boolean;
type: "bull" | "bullmq" | "bee";
counts: {
waiting: number;
paused: number;
prioritized?: number | undefined;
active: number;
completed: number;
delayed: number;
failed: number;
};
client: {
usedMemoryPercentage: number;
usedMemoryHuman: string;
totalMemoryHuman: string;
uptimeInSeconds: number;
connectedClients: number;
blockedClients: number;
maxClients: number;
version: string;
};
};
}>;
list: import("@trpc/server").TRPCQueryProcedure<{
input: void;
output: {
displayName: string;
name: string;
}[];
}>;
}>>;
scheduler: import("@trpc/server/unstable-core-do-not-import").BuiltRouter<{
ctx: import("@queuedash/api").Context;
meta: object;
errorShape: import("@trpc/server/unstable-core-do-not-import").DefaultErrorShape;
transformer: false;
}, import("@trpc/server/unstable-core-do-not-import").DecorateCreateRouterOptions<{
list: import("@trpc/server").TRPCQueryProcedure<{
input: {
queueName: string;
};
output: import("@queuedash/api/dist/src/utils/global.utils").QueueDashScheduler[];
}>;
add: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
data: Record<string, any>;
jobName: string;
every?: number | undefined;
pattern?: string | undefined;
tz?: string | undefined;
};
output: {
success: boolean;
};
}>;
remove: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
jobSchedulerId: string;
};
output: {
success: boolean;
};
}>;
bulkRemove: import("@trpc/server").TRPCMutationProcedure<{
input: {
queueName: string;
jobSchedulerIds: string[];
};
output: import("@queuedash/api/dist/src/utils/global.utils").QueueDashScheduler[];
}>;
}>>;
}>>;
//# sourceMappingURL=trpc.d.ts.map