Api References NestJS

RegisterQueueAsyncOptions

interface


interface RegisterQueueAsyncOptions extends Pick {
  name?: string
  configKey?: string
  useExisting?: Type<RegisterQueueOptionsFactory>
  useClass?: Type<RegisterQueueOptionsFactory>
  useFactory?: (...args: any[]) => Promise<RegisterQueueOptions> | RegisterQueueOptions
  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<RegisterQueueOptionsFactory>`	Existing Provider to be used.
`useClass?: Type<RegisterQueueOptionsFactory>`	Type (class name) of provider (instance to be registered and injected).
`useFactory?: (...args: any[]) => Promise<RegisterQueueOptions> \| RegisterQueueOptions`	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.