UNPKG

@bull-board/nestjs

Version:

A NestJS module for Bull-Board dashboard.

35 lines (34 loc) 1.3 kB
import { createBullBoard } from "@bull-board/api"; import { BoardOptions, IServerAdapter, QueueAdapterOptions } from "@bull-board/api/dist/typings/app"; import { BaseAdapter } from "@bull-board/api/dist/src/queueAdapters/base"; import { InjectionToken, ModuleMetadata, OptionalFactoryDependency } from "@nestjs/common"; export type BullBoardInstance = ReturnType<typeof createBullBoard>; export type BullBoardModuleOptions = { route: string; adapter: { new (): BullBoardServerAdapter; }; boardOptions?: BoardOptions; middleware?: any; }; export type BullBoardModuleAsyncOptions = { useFactory: (...args: any[]) => BullBoardModuleOptions | Promise<BullBoardModuleOptions>; imports?: ModuleMetadata['imports']; inject?: Array<InjectionToken | OptionalFactoryDependency>; }; export type BullBoardQueueOptions = { name: string; adapter: { new (queue: any, options?: Partial<QueueAdapterOptions>): BaseAdapter; }; options?: Partial<QueueAdapterOptions>; }; export type BullBoardServerAdapter = IServerAdapter & { setBasePath(path: string): any; }; export type BullBoardFastifyAdapter = BullBoardServerAdapter & { registerPlugin(): any; }; export type BullBoardExpressAdapter = BullBoardServerAdapter & { getRouter(): any; };