Skip to main content

​
Interface: PollJobOptions

Defined in: src/utils/job-progress.ts

​
Properties

​
initialBackoff?

optional initialBackoff: number;
Defined in: src/utils/job-progress.ts

​
logger?

optional logger: JobProgressLogger;
Defined in: src/utils/job-progress.ts

​
maxBackoff?

optional maxBackoff: number;
Defined in: src/utils/job-progress.ts

​
onProgress()?

optional onProgress: (job: object) => void;
Defined in: src/utils/job-progress.ts

​
Parameters

job
completed_at?
null | string Completed At
created_at
string Created At Format: date-time
error_message?
null | string Error Message
failed_at?
null | string Failed At
id
string Id Format: uuid4
job_name
string Job Name
migration_name?
null | string Migration Name
monitor_batch_id?
null | string Monitor Batch Id
processing_started?
null | string Processing Started
progress_message?
null | string Progress Message
progress_percent?
number Progress Percent Default 
0;
project_id
string Project Id Format: uuid4
request_data
{ [key: string]: unknown; } Request Data
retries
number Retries
run_id
string Run Id Format: uuid4
status
string Status
steps_completed?
number Steps Completed Default 
0;
steps_total?
number Steps Total Default 
0;
updated_at
string Updated At Format: date-time

​
Returns

void

​
showProgressBar?

optional showProgressBar: boolean;
Defined in: src/utils/job-progress.ts

​
signal?

optional signal: AbortSignal;
Defined in: src/utils/job-progress.ts

​
timeout?

optional timeout: number;
Defined in: src/utils/job-progress.ts