JobStatus Type — typescript-sdk Architecture

Architecture documentation for the JobStatus type/interface in JobStatus.ts from the typescript-sdk codebase.

Type typescript

Entity Profile

Dependency Diagram

graph TD
  2aa6baa9_5db4_5f6f_fd0c_3320f7ef0464["JobStatus"]
  7631b867_12e8_d1db_8a91_be2f324b8463["JobStatus.ts"]
  2aa6baa9_5db4_5f6f_fd0c_3320f7ef0464 -->|defined in| 7631b867_12e8_d1db_8a91_be2f324b8463
  style 2aa6baa9_5db4_5f6f_fd0c_3320f7ef0464 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/models/JobStatus.ts lines 21–46

export interface JobStatus {
    /**
     * Current status of the job.
     * @type {string}
     * @memberof JobStatus
     */
    status: JobStatusStatusEnum;
    /**
     * Unique identifier for the job.
     * @type {string}
     * @memberof JobStatus
     */
    jobId: string;
    /**
     * Recommended seconds to wait before polling again.
     * @type {number}
     * @memberof JobStatus
     */
    retryAfter?: number;
    /**
     * Error message (present when status is failed).
     * @type {string}
     * @memberof JobStatus
     */
    error?: string;
}

Defined In

src/models/JobStatus.ts

Source

View on GitHub

Frequently Asked Questions

What is the JobStatus type?

JobStatus is a type/interface in the typescript-sdk codebase, defined in src/models/JobStatus.ts.

Where is JobStatus defined?

JobStatus is defined in src/models/JobStatus.ts at line 21.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free