Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Job

A job for a Daemon to complete.

Hierarchy

  • Job

Implemented by

Index

Methods

Methods

getCommands

  • getCommands(): readonly string[]

  • Returns the commands to run (in-order and synchronously) that will result.

    Returns readonly string[]

getDeepPrerequisitesIterable

  • getDeepPrerequisitesIterable(): string[]

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

    Returns string[]

    an array containing a deep scan of the Job's prerequisites.

getEnvironment

  • getEnvironment(): Readonly<JobEnv>

  • Gets the environment this job must run under.

    Returns Readonly<JobEnv>

    A recipe for the job's runtime environment.

getNumPrerequisiteJobs

  • getNumPrerequisiteJobs(): number

  • Gets the number of prerequisites that this Job has.

    Returns number

    The number of prerequisites.

getPrerequisiteFilesIterable

  • getPrerequisiteFilesIterable(): Iterable<string>

  • Gets this Job's prerequisite files as an iterable.

    Returns an iterable to prevent modifying the prerequisites directly.

    Returns Iterable<string>

    An iterable that iterates over this Job's prerequisite files.

getPrerequisiteJobsIterable

  • getPrerequisiteJobsIterable(): Iterable<Job>

  • Gets this Job's prerequisite Jobs as an iterable.

    Returns an iterable to prevent modifying the prerequisites directly.

    Returns Iterable<Job>

    An iterable that iterates over this Job's prerequisite Jobs.

getTarget

  • getTarget(): string

  • Get this job's target.

    The target is the resulting file.

    Returns string

    This job's target.

setEnvironment

  • setEnvironment(environment: JobEnv): void

  • Sets the environment this job must run under.

    deprecated

    This object should not be able to be changed. I'm adding this for the purpose of dev speed.

    Parameters

    Returns void

Generated using TypeDoc