UNPKG

1.91 kBTypeScriptView Raw
1import { DynamicModule } from '@nestjs/common';
2import * as Bull from 'bull';
3import { SharedBullAsyncConfiguration } from './interfaces';
4import { BullModuleAsyncOptions, BullModuleOptions } from './interfaces/bull-module-options.interface';
5export declare class BullModule {
6 /**
7 * Registers a globally available configuration for all queues.
8 *
9 * @param bullConfig shared bull configuration object
10 */
11 static forRoot(bullConfig: Bull.QueueOptions): DynamicModule;
12 /**
13 * Registers a globally available configuration under a specified "configKey".
14 *
15 * @param configKey a key under which the configuration should be available
16 * @param sharedBullConfig shared bull configuration object
17 */
18 static forRoot(configKey: string, bullConfig: Bull.QueueOptions): DynamicModule;
19 /**
20 * Registers a globally available configuration for all queues.
21 *
22 * @param asyncBullConfig shared bull configuration async factory
23 */
24 static forRootAsync(asyncBullConfig: SharedBullAsyncConfiguration): DynamicModule;
25 /**
26 * Registers a globally available configuration under a specified "configKey".
27 *
28 * @param configKey a key under which the configuration should be available
29 * @param asyncBullConfig shared bull configuration async factory
30 */
31 static forRootAsync(configKey: string, asyncBullConfig: SharedBullAsyncConfiguration): DynamicModule;
32 static registerQueue(...options: BullModuleOptions[]): DynamicModule;
33 static registerQueueAsync(...options: BullModuleAsyncOptions[]): DynamicModule;
34 private static createAsyncProviders;
35 private static createAsyncOptionsProvider;
36 private static createAsyncSharedConfigurationProviders;
37 private static createAsyncSharedConfigurationProvider;
38 private static registerCore;
39 private static getUniqImports;
40}
41//# sourceMappingURL=bull.module.d.ts.map
\No newline at end of file