@nazaire/orchestra/src/types/Job/Job.ts

A framework for distributing work over many machines, integrated with Node.js workers to utilise many threads per machine.

import { Workspace, WorkspaceParams, WorkspaceScript } from "../Workspace.js";

type JobStatus = "waiting" | "active" | "completed";

export interface Job {
  id: string;

  status: JobStatus;

  options: JobOptions;

  priority: 0 | 1;

  // passed when the job is complete
  result: any | null | undefined;

  // passed when the job fails
  error: string | null | undefined;
}

export interface JobOptions {
  /**
   * The path to the worker script.
   */
  script: string;

  /**
   * Params to pass to the worker.
   */
  params: any;
}

export interface StrictJobOptions<
  W extends Workspace<any, any>,
  S extends WorkspaceScript<W>
> {
  /**
   * The path to the worker script.
   */
  script: S;

  /**
   * Params to pass to the worker.
   */
  params: WorkspaceParams<W, S>;
}