Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JobsApi

JobsApi - object-oriented interface

export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • Default value basePath: string = BASE_PATH
    • Default value axios: AxiosInstance = globalAxios

    Returns JobsApi

Properties

Protected axios

axios: AxiosInstance

Protected basePath

basePath: string

Protected configuration

configuration: Configuration | undefined

Methods

getJob

  • getJob(id: string, options?: any): Promise<AxiosResponse<Job>>

  • Get the status of a queued job, including its status and result if available.

    summary

    Get job

    throws

    {RequiredError}

    memberof

    JobsApi

    Parameters

    • id: string
    • Optional options: any

    Returns Promise<AxiosResponse<Job>>

Generated using TypeDoc