Home / File/ JobStatus.ts — typescript-sdk Source File

JobStatus.ts — typescript-sdk Source File

Architecture documentation for JobStatus.ts, a typescript file in the typescript-sdk codebase. 2 imports, 0 dependents.

File typescript CodeGraph IR 2 imports 4 functions

Entity Profile

Dependency Diagram

graph LR
  7631b867_12e8_d1db_8a91_be2f324b8463["JobStatus.ts"]
  41b6b5c2_aa5b_90b9_c373_84e0a8cd9918["runtime.ts"]
  7631b867_12e8_d1db_8a91_be2f324b8463 --> 41b6b5c2_aa5b_90b9_c373_84e0a8cd9918
  11568abc_c5bd_8b5d_1ce1_6d595e449b9c["mapValues"]
  7631b867_12e8_d1db_8a91_be2f324b8463 --> 11568abc_c5bd_8b5d_1ce1_6d595e449b9c
  style 7631b867_12e8_d1db_8a91_be2f324b8463 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

/* tslint:disable */
/* eslint-disable */
/**
 * Supermodel
 * Code Graphing & Analysis API
 *
 * The version of the OpenAPI document: 0.9.3
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

import { mapValues } from '../runtime';
/**
 * Common fields for async job status tracking.
 * @export
 * @interface JobStatus
 */
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;
}


/**
 * @export
 */
export const JobStatusStatusEnum = {
    Pending: 'pending',
    Processing: 'processing',
    Completed: 'completed',
    Failed: 'failed'
} as const;
export type JobStatusStatusEnum = typeof JobStatusStatusEnum[keyof typeof JobStatusStatusEnum];


/**
 * Check if a given object implements the JobStatus interface.
 */
export function instanceOfJobStatus(value: object): value is JobStatus {
    if (!('status' in value) || value['status'] === undefined) return false;
    if (!('jobId' in value) || value['jobId'] === undefined) return false;
    return true;
}

export function JobStatusFromJSON(json: any): JobStatus {
    return JobStatusFromJSONTyped(json, false);
}

export function JobStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobStatus {
    if (json == null) {
        return json;
    }
    return {
        
        'status': json['status'],
        'jobId': json['jobId'],
        'retryAfter': json['retryAfter'] == null ? undefined : json['retryAfter'],
        'error': json['error'] == null ? undefined : json['error'],
    };
}

export function JobStatusToJSON(value?: JobStatus | null): any {
    if (value == null) {
        return value;
    }
    return {
        
        'status': value['status'],
        'jobId': value['jobId'],
        'retryAfter': value['retryAfter'],
        'error': value['error'],
    };
}

Domain

Subdomains

Dependencies

Frequently Asked Questions

What does JobStatus.ts do?
JobStatus.ts is a source file in the typescript-sdk codebase, written in typescript. It belongs to the CodeGraph domain, IR subdomain.
What functions are defined in JobStatus.ts?
JobStatus.ts defines 4 function(s): JobStatusFromJSON, JobStatusFromJSONTyped, JobStatusToJSON, instanceOfJobStatus.
What does JobStatus.ts depend on?
JobStatus.ts imports 2 module(s): mapValues, runtime.ts.
Where is JobStatus.ts in the architecture?
JobStatus.ts is located at src/models/JobStatus.ts (domain: CodeGraph, subdomain: IR, directory: src/models).

Analyze Your Own Codebase

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

Try Supermodel Free