Class Job

Hierarchy (View Summary)

  • DataEntity<
        {
            error?: ErrorData;
            id: string;
            isNSFW?: boolean;
            previewUrl?: string;
            resultUrl?: null
            | string;
            seed?: number;
            status: JobStatus;
            step: number;
            stepCount: number;
            userCanceled?: boolean;
        },
        JobEventMap,
    >
    • Job

Constructors

constructor

Properties

data listeners

Accessors

error id imageUrl isNSFW previewUrl progress resultUrl seed status step stepCount

Methods

emit off on once toJSON

Constructors

constructor

  • new Job(
        data: {
            error?: ErrorData;
            id: string;
            isNSFW?: boolean;
            previewUrl?: string;
            resultUrl?: null | string;
            seed?: number;
            status: JobStatus;
            step: number;
            stepCount: number;
            userCanceled?: boolean;
        },
    ): Job

  • Parameters

    • data: {
          error?: ErrorData;
          id: string;
          isNSFW?: boolean;
          previewUrl?: string;
          resultUrl?: null | string;
          seed?: number;
          status: JobStatus;
          step: number;
          stepCount: number;
          userCanceled?: boolean;
      }

    Returns Job

Properties

Protecteddata

data: {
    error?: ErrorData;
    id: string;
    isNSFW?: boolean;
    previewUrl?: string;
    resultUrl?: null | string;
    seed?: number;
    status: JobStatus;
    step: number;
    stepCount: number;
    userCanceled?: boolean;
}

Protectedlisteners

listeners: {
    completed?: (data: string) => void[];
    failed?: (data: ErrorData) => void[];
    progress?: (data: number) => void[];
    updated?: (data: string[]) => void[];
} = {}

Accessors

error

id

imageUrl

isNSFW

  • get isNSFW(): boolean

  • Whether the image is NSFW or not. Only makes sense if job is completed. If NSFW filter is disabled, this property will always be false. If NSFW filter is enabled and the image is NSFW, image will not be available for download.

    Returns boolean

previewUrl

  • get previewUrl(): undefined | string

  • Last preview image URL generated by the worker.

    Returns undefined | string

progress

  • get progress(): number

  • Progress of the job in percentage (0-100).

    Returns number

resultUrl

  • get resultUrl(): undefined | null | string

  • URL to the result image, could be null if the job was canceled or triggered NSFW filter while it was not disabled explicitly.

    Returns undefined | null | string

seed

  • get seed(): undefined | number

  • Seed used to generate the image. This property is only available when the job is completed.

    Returns undefined | number

status

step

stepCount

  • get stepCount(): number

  • Total number of steps that worker will perform.

    Returns number

Methods

Protectedemit

off

on

once

toJSON

  • toJSON(): {
        error?: ErrorData;
        id: string;
        isNSFW?: boolean;
        previewUrl?: string;
        resultUrl?: null
        | string;
        seed?: number;
        status: JobStatus;
        step: number;
        stepCount: number;
        userCanceled?: boolean;
    }

  • Get a copy of the entity's data

    Returns {
        error?: ErrorData;
        id: string;
        isNSFW?: boolean;
        previewUrl?: string;
        resultUrl?: null | string;
        seed?: number;
        status: JobStatus;
        step: number;
        stepCount: number;
        userCanceled?: boolean;
    }

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods