vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-08-13 05:20:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #34104 from panascais-forks/bull-function-overloading

Browse Source 
[bull] add function overloading
This commit is contained in:
Sheetal Nandi
2019-03-22 13:14:26 -07:00
committed by GitHub
parent 70ac3541e7 c0fc0677a3
commit 0a814dc172
1 changed files with 21 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/bull/index.d.ts
Vendored
+21 -6
View File
@@ -13,6 +13,7 @@
// Dan Manastireanu <https://github.com/danmana>
// Kjell-Morten Bratsberg Thorsen <https://github.com/kjellmorten>
// Christian D. <https://github.com/pc-jedi>
// Silas Rech <https://github.com/lenovouser>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.8
@@ -114,6 +115,9 @@ declare namespace Bull {
type JobId = number | string;
type ProcessCallbackFunction<T> = (job: Job<T>, done: DoneCallback) => void;
type ProcessPromiseFunction<T> = (job: Job<T>) => Promise<void>;
interface Job<T = any> {
id: JobId;
@@ -397,6 +401,8 @@ declare namespace Bull {
*/
isReady(): Promise<this>;
/* tslint:disable:unified-signatures */
/**
* Defines a processing function for the jobs placed into a given Queue.
*
@@ -414,7 +420,9 @@ declare namespace Bull {
* If the promise is rejected, the error will be passed as a second argument to the "failed" event.
* If it is resolved, its value will be the "completed" event's second argument.
*/
process(callback: ((job: Job<T>, done: DoneCallback) => void) | ((job: Job<T>) => Promise<any>) | string): void;
process(callback: ProcessCallbackFunction<T>): void;
process(callback: ProcessPromiseFunction<T>): void;
process(callback: string): void;
/**
* Defines a processing function for the jobs placed into a given Queue.
@@ -435,7 +443,9 @@ declare namespace Bull {
*
* @param concurrency Bull will then call your handler in parallel respecting this maximum value.
*/
process(concurrency: number, callback: ((job: Job<T>, done: DoneCallback) => void) | ((job: Job<T>) => Promise<any>) | string): void;
process(concurrency: number, callback: ProcessCallbackFunction<T>): void;
process(concurrency: number, callback: ProcessPromiseFunction<T>): void;
process(concurrency: number, callback: string): void;
/**
* Defines a processing function for the jobs placed into a given Queue.
@@ -456,8 +466,9 @@ declare namespace Bull {
*
* @param name Bull will only call the handler if the job name matches
*/
// tslint:disable-next-line:unified-signatures
process(name: string, callback: ((job: Job<T>, done: DoneCallback) => void) | ((job: Job<T>) => Promise<any>) | string): void;
process(name: string, callback: ProcessCallbackFunction<T>): void;
process(name: string, callback: ProcessPromiseFunction<T>): void;
process(name: string, callback: string): void;
/**
* Defines a processing function for the jobs placed into a given Queue.
@@ -479,7 +490,11 @@ declare namespace Bull {
* @param name Bull will only call the handler if the job name matches
* @param concurrency Bull will then call your handler in parallel respecting this maximum value.
*/
process(name: string, concurrency: number, callback: ((job: Job<T>, done: DoneCallback) => void) | ((job: Job<T>) => Promise<any>) | string): void;
process(name: string, concurrency: number, callback: ProcessCallbackFunction<T>): void;
process(name: string, concurrency: number, callback: ProcessPromiseFunction<T>): void;
process(name: string, concurrency: number, callback: string): void;
/* tslint:enable:unified-signatures */
/**
* Creates a new job and adds it to the queue.
@@ -598,7 +613,7 @@ declare namespace Bull {
* Returns a promise that will return an array of job instances of the given types.
* Optional parameters for range and ordering are provided.
*/
getJobs(types: string[], start?: number, end?: number, asc?: boolean): Promise<Job[]>;
getJobs(types: string[], start?: number, end?: number, asc?: boolean): Promise<Array<Job<T>>>;
/**
* Returns a promise that resolves with the job counts for the given queue.