Type-bull NPM | npm.io

Description

Bull module for Nest.

Installation

$ npm install --save bull

$ npm install --save-dev @types/bull

$ npm i --save type-bull

Quick Start

Overview & Tutorial

Quick Guide

Basic Usage

project
│   app.module.ts 
│   
│  
└───test
│   │   test.module.ts
│   │
│   └───test-queue
│       │   test.queue.module.ts
│       │   test.queue.service.ts
│       │   
│       └───queue
│           │
│           │   test.queue.ts

// app.module.ts

@Module({
    imports: [TestModule]
})
export class AppModule {
}

// test.module.ts

@Module({
    imports: [TestQueueModule],
})
export class TestModule {
}

// test.queue.module.ts

@Module({
    imports: [BullModule.forFeature([TestQueue])],
    providers: [TestQueueService, TestQueue]
})
export class TestQueueModule {
}

// test.queue.service.ts

@Injectable()
export class TestQueueService {
    constructor(
        @Inject(TestQueue)
        private readonly testQueue: TypeBull<TestQueue>
    ) {}

    addInQueue(someData) {
      return this.testQueue.constructor.bull.add(someData);
    }
}

// test.queue.ts

@Queue('test_queue', {
    redis: {
        port: 6379,
        host: '127.0.0.1',
    },
})
export class TestQueue extends Bull {
    public readonly logger = new Logger();

    // this way
    @Process('HANDLE_TEST') 
    testProcess(job) {
        this.logger.debug(job)
    }

    // or this way
    @Process({
        name: 'someName',
        filePath: '../somepath.js',
        concurrency: 5
    }) testChildProcess() {}


    @Event('global:progress') 
    testEventGlobal(job, progress) {
        this.logger.debug(job)
        this.logger.debug(progress)
    }

    @Event('progress') 
    testEventProgress(job, progress) {
        this.logger.debug(job)
        this.logger.debug(progress)
    }


}