JS API Reference

Interface: JobEventsDict

job/job.JobEventsDict

Table of contents

Properties

Properties

created

created: () => void

Emitted immediately after the job is created and initialization begins.

Type declaration

▸ (): void

Emitted immediately after the job is created and initialization begins.

Returns

void

Defined in

src/job/job.ts:31


started

started: () => void

Emitted when the job finishes initialization and work begins.

Type declaration

▸ (): void

Emitted when the job finishes initialization and work begins.

Returns

void

Defined in

src/job/job.ts:35


success

success: () => void

Emitted when the job completes successfully and cleanup begins.

Type declaration

▸ (): void

Emitted when the job completes successfully and cleanup begins.

Returns

void

Defined in

src/job/job.ts:39


error

error: (error: Error) => void

Emitted when the job fails and cleanup begins.

Type declaration

▸ (error): void

Emitted when the job fails and cleanup begins.

Parameters
NameType
errorError
Returns

void

Defined in

src/job/job.ts:43


canceled

canceled: () => void

Emitted when the job is canceled by the user.

Type declaration

▸ (): void

Emitted when the job is canceled by the user.

Returns

void

Defined in

src/job/job.ts:47


ended

ended: () => void

Emitted when the job finishes cleanup after success, error or cancelation.

Type declaration

▸ (): void

Emitted when the job finishes cleanup after success, error or cancelation.

Returns

void

Defined in

src/job/job.ts:51

Was this helpful?