adonis5-queue
Version:
Adonis JS 5 queue package based backed by Kue and Kue-scheduler
35 lines (34 loc) • 916 B
TypeScript
import { QueueConfig, ProcessingResultInteface } from '@ioc:Adonis5/Queue';
/**
* Register and preload consumer processes
*
* @version 2.0.0
* @adonis-version 4.0+
*/
export default class JobRegister {
private config;
private queue;
private appRootPath;
constructor(Config: QueueConfig, appRootPath: string);
/**
* Inject Kue Queue into the app
* @param {Kue/Queue} queue
*/
setQueue(queue: any): this;
/**
* Load all job classes aynchronously
* @return {Promise}
*/
listenForAppJobs(): Promise<ProcessingResultInteface>;
/**
* Get all job file paths
* @return {Promise<String>} File paths
*/
jobFilePaths(): Promise<string[]>;
/**
* Require all available jobs and process them
* @param {Array} filePaths Job class files
* @return {Void}
*/
requireAndProcessJobs(filePaths: any): Promise<void>;
}