Class Project

Hierarchy (View Summary)

Constructors

constructor

Properties

data listeners

Accessors

error id jobs params progress queuePosition resultUrls status

Methods

emit job off on once toJSON waitForCompletion

Constructors

constructor

Properties

Protecteddata

data: {
    error?: ErrorData;
    id: string;
    params: ProjectParams;
    queuePosition: number;
    startedAt: Date;
    status: ProjectStatus;
}

Protectedlisteners

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

Accessors

error

id

jobs

  • get jobs(): Job[]

  • List of jobs in the project. Note that jobs will be added to this list as workers start processing them. So initially this list will be empty. Subscribe to project updated event to get notified about any update, including new jobs.

    Returns Job[]

    Example

    project.on('updated', (keys) => {
     if (keys.includes('jobs')) {
       // Project jobs have been updated
     }
    });

params

progress

  • get progress(): number

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

    Returns number

queuePosition

resultUrls

  • get resultUrls(): string[]

  • List of result URLs for all completed jobs in the project.

    Returns string[]

status

Methods

Protectedemit

job

off

on

once

toJSON

  • toJSON(): {
        error?: ErrorData;
        id: string;
        jobs: {
            error?: ErrorData;
            id: string;
            isNSFW?: boolean;
            previewUrl?: string;
            resultUrl?: null
            | string;
            seed?: number;
            status: JobStatus;
            step: number;
            stepCount: number;
            userCanceled?: boolean;
        }[];
        params: ProjectParams;
        queuePosition: number;
        startedAt: Date;
        status: ProjectStatus;
    }

  • Get full project data snapshot. Can be used to serialize the project and store it in a database.

    Returns {
        error?: ErrorData;
        id: string;
        jobs: {
            error?: ErrorData;
            id: string;
            isNSFW?: boolean;
            previewUrl?: string;
            resultUrl?: null | string;
            seed?: number;
            status: JobStatus;
            step: number;
            stepCount: number;
            userCanceled?: boolean;
        }[];
        params: ProjectParams;
        queuePosition: number;
        startedAt: Date;
        status: ProjectStatus;
    }

waitForCompletion

  • waitForCompletion(): Promise<string[]>

  • Wait for the project to complete, then return the result URLs, or throw an error if the project fails.

    Returns Promise<string[]>

    Promise<string[]> - Promise that resolves to the list of result URLs

    Throws

    ErrorData

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods