155 lines
3.9 KiB
TypeScript
155 lines
3.9 KiB
TypeScript
import { JobsOptions } from '../types/job-options';
|
|
import { JobProgress } from '../types/job-progress';
|
|
import { JobJsonSandbox } from '../types/job-json-sandbox';
|
|
import { JobJson } from './job-json';
|
|
import { ParentKeys } from './parent';
|
|
import { ParentOptions } from './parent-options';
|
|
export type BulkJobOptions = Omit<JobsOptions, 'repeat'>;
|
|
export interface MoveToDelayedOpts {
|
|
skipAttempt?: boolean;
|
|
fieldsToUpdate?: Record<string, any>;
|
|
}
|
|
export interface RetryJobOpts {
|
|
fieldsToUpdate?: Record<string, any>;
|
|
}
|
|
export interface MoveToWaitingChildrenOpts {
|
|
child?: ParentOptions;
|
|
}
|
|
export interface DependencyOpts {
|
|
/**
|
|
* Cursor value to be passed for pagination
|
|
*/
|
|
cursor?: number;
|
|
/**
|
|
* Max quantity of jobs to be retrieved
|
|
*/
|
|
count?: number;
|
|
}
|
|
export interface DependenciesOpts {
|
|
/**
|
|
* Options for failed child pagination
|
|
*/
|
|
failed?: DependencyOpts;
|
|
/**
|
|
* Options for ignored child pagination
|
|
*/
|
|
ignored?: DependencyOpts;
|
|
/**
|
|
* Options for processed child pagination
|
|
*/
|
|
processed?: DependencyOpts;
|
|
/**
|
|
* Options for unprocessed child pagination
|
|
*/
|
|
unprocessed?: DependencyOpts;
|
|
}
|
|
/**
|
|
* MinimalJob
|
|
*/
|
|
export interface MinimalJob<DataType = any, ReturnType = any, NameType extends string = string> {
|
|
/**
|
|
* The name of the Job
|
|
*/
|
|
name: NameType;
|
|
/**
|
|
* The payload for this job.
|
|
*/
|
|
data: DataType;
|
|
/**
|
|
* The options object for this job.
|
|
*/
|
|
opts: JobsOptions;
|
|
id?: string;
|
|
/**
|
|
* The progress a job has performed so far.
|
|
* @defaultValue 0
|
|
*/
|
|
progress: JobProgress;
|
|
/**
|
|
* The value returned by the processor when processing this job.
|
|
* @defaultValue null
|
|
*/
|
|
returnvalue: ReturnType;
|
|
/**
|
|
* Stacktrace for the error (for failed jobs).
|
|
* @defaultValue null
|
|
*/
|
|
stacktrace: string[];
|
|
/**
|
|
* An amount of milliseconds to wait until this job can be processed.
|
|
* @defaultValue 0
|
|
*/
|
|
delay: number;
|
|
/**
|
|
* Timestamp when the job was created (unless overridden with job options).
|
|
*/
|
|
timestamp: number;
|
|
/**
|
|
* Number of attempts after the job has failed.
|
|
* @defaultValue 0
|
|
*/
|
|
attemptsMade: number;
|
|
/**
|
|
* Reason for failing.
|
|
*/
|
|
failedReason: string;
|
|
/**
|
|
* Timestamp for when the job finished (completed or failed).
|
|
*/
|
|
finishedOn?: number;
|
|
/**
|
|
* Timestamp for when the job was processed.
|
|
*/
|
|
processedOn?: number;
|
|
/**
|
|
* Fully qualified key (including the queue prefix) pointing to the parent of this job.
|
|
*/
|
|
parentKey?: string;
|
|
/**
|
|
* Object that contains parentId (id) and parent queueKey.
|
|
*/
|
|
parent?: ParentKeys;
|
|
/**
|
|
* Base repeat job key.
|
|
*/
|
|
repeatJobKey?: string;
|
|
/**
|
|
* Prepares a job to be serialized for storage in Redis.
|
|
* @returns
|
|
*/
|
|
asJSON(): JobJson;
|
|
/**
|
|
* Prepares a job to be passed to Sandbox.
|
|
* @returns
|
|
*/
|
|
asJSONSandbox(): JobJsonSandbox;
|
|
/**
|
|
* Updates a job's data
|
|
*
|
|
* @param data - the data that will replace the current jobs data.
|
|
*/
|
|
updateData(data: DataType): Promise<void>;
|
|
/**
|
|
* Updates a job's progress
|
|
*
|
|
* @param progress - number or object to be saved as progress.
|
|
*/
|
|
updateProgress(progress: JobProgress): Promise<void>;
|
|
/**
|
|
* Logs one row of log data.
|
|
*
|
|
* @param logRow - string with log data to be logged.
|
|
*/
|
|
log(logRow: string): Promise<number>;
|
|
get queueName(): string;
|
|
/**
|
|
* @returns the prefix that is used.
|
|
*/
|
|
get prefix(): string;
|
|
/**
|
|
* @returns it includes the prefix, the namespace separator :, and queue name.
|
|
* @see https://www.gnu.org/software/gawk/manual/html_node/Qualified-Names.html
|
|
*/
|
|
get queueQualifiedName(): string;
|
|
}
|