Options
All
  • Public
  • Public/Protected
  • All
Menu

Class to handle downloading of job information

export

Hierarchy

  • DownloadJobs

Index

Properties

Static Readonly DEFAULT_JOBS_OUTPUT_DIR

DEFAULT_JOBS_OUTPUT_DIR: string = "./output"

Default directory where output will be placed

static
memberof

DownloadJobs

Static Readonly DEFAULT_JOBS_OUTPUT_FILE_EXT

DEFAULT_JOBS_OUTPUT_FILE_EXT: string = ".txt"

Default extension of downloaded folders

static
memberof

DownloadJobs

Accessors

Static Private log

Methods

Static downloadAllSpoolContentCommon

Static downloadSpoolContent

Static downloadSpoolContentCommon

Static getSpoolDownloadFile

  • getSpoolDownloadFile(jobFile: IJobFile, omitJobidDirectory?: boolean, outDir?: string): string
  • Get the file where a specified spool file (IJobFile) would be downloaded to

    deprecated

    Use getSpoolDownloadFilePath instead

    static
    memberof

    DownloadJobs

    Parameters

    • jobFile: IJobFile

      the spool file that would be downloaded

    • Optional omitJobidDirectory: boolean

      if true, the job ID of the jobFile will not be included in the file path

    • Default value outDir: string = DownloadJobs.DEFAULT_JOBS_OUTPUT_DIR

      parent output directory you would like to download to

    Returns string

    the file path that the spool file would be downloaded to

Static getSpoolDownloadFilePath

Generated using TypeDoc