Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Daemon/RunJob

Index

Type aliases

Type aliases

RunJob

RunJob: (request: JobRequest, workdir: string, channel: ServerChannel) => Promise<void>

Function interface for telling a daemon how to run jobs. Follows the strategy design pattern.

remarks

If the job fails to execute, the promise will be rejected. This is distinct from when the job completes successfully with a failing exit status.

param

Description of the job to be run.

param

Absolute path to the Make project directory. It must contain all needed inputs and the Makefile.

param

The SSH client waiting for the response.

returns

Asynchronously, when the job is complete.

Type declaration

    • (request: JobRequest, workdir: string, channel: ServerChannel): Promise<void>
    • Parameters

      • request: JobRequest
      • workdir: string
      • channel: ServerChannel

      Returns Promise<void>

Generated using TypeDoc