• ------------------------------
  • JS API Reference

    Interface: JobEventsDict

    experimental/job/job.JobEventsDict

    Table of contents

    Properties

    Properties

    created

    created: () => void

    Emitted immediately after the job is created and initialization begins.

    Type declaration

    ▸ (): void

    Returns

    void

    Defined in

    src/experimental/job/job.ts:32


    started

    started: () => void

    Emitted when the job finishes initialization and work begins.

    Type declaration

    ▸ (): void

    Returns

    void

    Defined in

    src/experimental/job/job.ts:36


    success

    success: () => void

    Emitted when the job completes successfully and cleanup begins.

    Type declaration

    ▸ (): void

    Returns

    void

    Defined in

    src/experimental/job/job.ts:40


    error

    error: (error: Error) => void

    Emitted when the job fails and cleanup begins.

    Type declaration

    ▸ (error): void

    Parameters
    NameType
    errorError
    Returns

    void

    Defined in

    src/experimental/job/job.ts:44


    canceled

    canceled: () => void

    Emitted when the job is canceled by the user.

    Type declaration

    ▸ (): void

    Returns

    void

    Defined in

    src/experimental/job/job.ts:48


    ended

    ended: () => void

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

    Type declaration

    ▸ (): void

    Returns

    void

    Defined in

    src/experimental/job/job.ts:52