Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NormalJob

An implementation of Job.

Hierarchy

  • NormalJob

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • options: NormalJobOptions

      the settings for this Job.

      The default for options.prerequisiteJobs is the empty set.

      The default for options.prerequisiteFiles is the empty set.

      The default for options.environment is a Docker image containing GNU Make: {@link DEFAULT_ENV}. For forwards compatibility, always provide this parameter.

    Returns NormalJob

Properties

Private commands

commands: string[]

Private environment

environment: JobEnv

Private prerequisiteFiles

prerequisiteFiles: Set<string>

Private prerequisiteJobs

prerequisiteJobs: Set<Job>

Private target

target: string

Methods

getCommands

  • getCommands(): readonly string[]

  • Getter for this job's environment.

    Returns readonly string[]

getDeepPrerequisitesIterable

  • getDeepPrerequisitesIterable(): string[]

  • Gets this Job's dependencies (its prerequisites, recursively)

    Returns string[]

    a iterable containing a deep scan of the Job's prerequisites.

getEnvironment

  • getEnvironment(): Readonly<JobEnv>

  • Getter for the environment this job must run under.

    Returns Readonly<JobEnv>

getNumPrerequisiteJobs

  • getNumPrerequisiteJobs(): number

  • Returns the number of prerequisites using Set's native size property.

    Returns number

getPrerequisiteFilesIterable

  • getPrerequisiteFilesIterable(): Iterable<string>

  • Uses Set's native values() function to get an iterable of prerequisites.

    Returns Iterable<string>

    An iterable that iterates over the prerequisiteFiles Set.

getPrerequisiteJobsIterable

  • getPrerequisiteJobsIterable(): Iterable<Job>

  • Uses Set's native values() function to get an iterable of prerequisites.

    Returns Iterable<Job>

    An iterable that iterates over the prerequisiteJobs Set.

getTarget

  • getTarget(): string

  • Returns string

    This job's target.

setEnvironment

  • setEnvironment(env: JobEnv): void

  • Getter for the environment this job must run under.

    deprecated

    Should be removed soon.

    Parameters

    Returns void

toString

  • toString(): string

  • JavaScript calls this function whenever Job is casted to a string.

    Returns string

    A string detailing this job's target, as well as any prerequisite jobs or files.

Generated using TypeDoc