@bull-board/nestjs/src/bull-board.types.ts

A NestJS module for Bull-Board dashboard.

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>,
};

//create our own types with the needed functions, so we don't need to include express/fastify libraries here.
export type BullBoardServerAdapter = IServerAdapter & { setBasePath(path: string): any };
export type BullBoardFastifyAdapter = BullBoardServerAdapter & { registerPlugin(): any };
export type BullBoardExpressAdapter = BullBoardServerAdapter & { getRouter(): any };