Add types to private functions

- Job.moveToCompleted
- Job.moveToFailed
- Queue.getNextJob
- Also add null possibility to Queue.getJob
This commit is contained in:
Alec Brunelle
2018-08-02 14:38:33 -04:00
parent 41eca014e1
commit 589188a626
2 changed files with 30 additions and 1 deletions
+1
View File
@@ -9,6 +9,7 @@
// David Koblas <https://github.com/koblas>
// Bond Akinmade <https://github.com/bondz>
// Wuha Team <https://github.com/wuha-team>
// Alec Brunelle <https://github.com/aleccool213>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.8
+29 -1
View File
@@ -54,6 +54,22 @@ declare module "bull" {
* since pubsub does not give any guarantees.
*/
finished(): Promise<void>;
/**
* Moves a job to the completed queue and moves a new job from 'waiting' to 'active'.
* @param returnValue The jobs success message.
* @param ignoreLock True when wanting to ignore the redis lock on this job.
* @returns Returns the id of the pulled job.
*/
moveToCompleted(returnValue: string, ignoreLock: boolean): Promise<string[]>;
/**
* Moves a job to the failed queue.
* @param errorInfo The jobs error message.
* @param ignoreLock True when wanting to ignore the redis lock on this job.
* @returns void
*/
moveToFailed(errorInfo: ErrorMessage, ignoreLock: boolean): Promise<void>;
}
export interface Backoff {
@@ -204,7 +220,7 @@ declare module "bull" {
* Returns a promise that will return the job instance associated with the jobId parameter.
* If the specified job cannot be located, the promise callback parameter will be set to null.
*/
getJob(jobId: string): Promise<Job>;
getJob(jobId: string): Promise<Job | null>;
/**
* Tells the queue remove all jobs created outside of a grace period in milliseconds.
@@ -217,6 +233,18 @@ declare module "bull" {
* 'ready', 'error', 'activ', 'progress', 'completed', 'failed', 'paused', 'resumed', 'cleaned'
*/
on(eventName: string, callback: EventCallback): void;
/**
* Moves the next job from 'waiting' to 'active'.
* Sets the processedOn timestamp to the current datetime.
* @param jobId If specified, will move a specific job from 'waiting' to 'active',
* @returns Returns the job moved from waiting to active queue.
*/
getNextJob:(jobId?: string) => Promise<Job | null>;
}
interface ErrorMessage {
message: string;
}
interface EventCallback {