BullModuleAsyncOptions


interface BullModuleAsyncOptions extends Pick {
  name?: string
  configKey?: string
  useExisting?: Type<BullOptionsFactory>
  useClass?: Type<BullOptionsFactory>
  useFactory?: (...args: any[]) => Promise<BullModuleOptions> | BullModuleOptions
  inject?: FactoryProvider['inject']
}

Properties

Property Description
name?: string

Queue name.

By default Queue name and set to "default"

configKey?: string

Shared configuration key.

useExisting?: Type<BullOptionsFactory>

Existing Provider to be used.

useClass?: Type<BullOptionsFactory>

Type (class name) of provider (instance to be registered and injected).

useFactory?: (...args: any[]) => Promise<BullModuleOptions> | BullModuleOptions

Factory function that returns an instance of the provider to be injected.

inject?: FactoryProvider['inject']

Optional list of providers to be injected into the context of the Factory function.