BullModule

  
class BullModule {
  static forRoot(keyOrConfig: string | BullRootModuleOptions, bullConfig?: BullRootModuleOptions): DynamicModule
  static forRootAsync(keyOrAsyncConfig: string | SharedBullAsyncConfiguration, asyncBullConfig?: SharedBullAsyncConfiguration): DynamicModule
  static registerQueue(...options: BullModuleOptions[]): DynamicModule
  static registerQueueAsync(...options: BullModuleAsyncOptions[]): DynamicModule
}

Static methods

forRoot()

Registers a globally available configuration for all queues or using a specified "configKey" (if passed).

Registers a globally available configuration for all queues.


static forRoot(bullConfig: BullRootModuleOptions): DynamicModule

Parameters

Option Type Description
bullConfig BullRootModuleOptions

shared bull configuration object

Returns

DynamicModule

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


static forRoot(configKey: string, bullConfig: BullRootModuleOptions): DynamicModule

Parameters

Option Type Description
configKey string

a key under which the configuration should be available

bullConfig BullRootModuleOptions

Returns

DynamicModule

forRootAsync()

Registers a globally available configuration for all queues or using a specified "configKey" (if passed).

Registers a globally available configuration for all queues.


static forRootAsync(asyncBullConfig: SharedBullAsyncConfiguration): DynamicModule

Parameters

Option Type Description
asyncBullConfig SharedBullAsyncConfiguration

shared bull configuration async factory

Returns

DynamicModule

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


static forRootAsync(configKey: string, asyncBullConfig: SharedBullAsyncConfiguration): DynamicModule

Parameters

Option Type Description
configKey string

a key under which the configuration should be available

asyncBullConfig SharedBullAsyncConfiguration

shared bull configuration async factory

Returns

DynamicModule

registerQueue()


static registerQueue(...options: BullModuleOptions[]): DynamicModule

Parameters

Option Type Description
options BullModuleOptions[]

Returns

DynamicModule

registerQueueAsync()


static registerQueueAsync(...options: BullModuleAsyncOptions[]): DynamicModule

Parameters

Option Type Description
options BullModuleAsyncOptions[]

Returns

DynamicModule