Hierarchy

  • BullModule

Constructors

Accessors

  • set flowProducerClass(cls: Type<any>): void
  • Class to be used to create Bull flow producers. This configuration property can be used to instruct the "@nestjs/bullmq" package to use, for example, "FlowProducerPro" class (from "BullMQ Pro").

    Default

    FlowProducerPro

    Parameters

    • cls: Type<any>

    Returns void

  • set queueClass(cls: Type<any>): void
  • Class to be used to create Bull queues. This configuration property can be used to instruct the "@nestjs/bullmq" package to use, for example, "QueuePro" class (from "BullMQ Pro").

    Default

    QueuePro

    Parameters

    • cls: Type<any>

    Returns void

  • set workerClass(cls: Type<any>): void
  • Class to be used to create Bull workers. This configuration property can be used to instruct the "@nestjs/bullmq" package to use, for example, "WorkerPro" class (from "BullMQ Pro").

    Default

    WorkerPro

    Parameters

    • cls: Type<any>

    Returns void

Methods

  • Registers a globally available configuration for all queues.

    Parameters

    • bullConfig: QueueProOptions

      shared bull configuration object

    Returns DynamicModule

  • Registers a globally available configuration under a specified "configKey".

    Parameters

    • configKey: string

      a key under which the configuration should be available

    • bullConfig: QueueProOptions

    Returns DynamicModule

Generated using TypeDoc