Skip to content

runOperationsJobCli — @gj-kit/nest-operations-jobs

A public function from @gj-kit/nest-operations-jobs. The signature below is taken directly from the 0.1.1 release declaration.

import { runOperationsJobCli } from '@gj-kit/nest-operations-jobs';
/**
* Shared entry point for container job runners, Kubernetes CronJobs and manual
* runs. The same runner as the HTTP trigger, so run records, overlap prevention
* and timeouts apply identically.
*
* Returns the exit code instead of setting a global, and never terminates the
* process: the caller decides. A context the CLI created is always closed,
* including on failure, so pooled database connections cannot leak.
*
* `SUCCEEDED` and `SKIPPED` exit 0 — a skipped duplicate is not an error.
* `FAILED`, `TIMED_OUT` and any throw exit 1. A missing job key exits 2 without
* booting the application. A run whose record is not `'settled'` still uses the
* status-derived code and reports the mismatch as a warning: that fact is for an
* operator to read, not a retry signal for the scheduler.
*/
declare function runOperationsJobCli(options: OperationsJobCliOptions): Promise<0 | 1 | 2>;

This declaration is the source of truth for parameters, optionality, generics, return values, and public union/type contracts. Check the package golden path and this subpath’s import conditions for required environment, permission, and error boundaries before calling it.

  • Package: @gj-kit/nest-operations-jobs
  • Version: 0.1.1
  • Public entry: .
  • Source: GitHub