Skip to content

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

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

import { OperationsJobsControllerOptions } from '@gj-kit/nest-operations-jobs';
interface OperationsJobsControllerOptions {
/** Route namespace this controller occupies, e.g. `'internal/jobs'`. */
readonly path: string;
/**
* Request header naming the scheduler job that fired, recorded as
* `trigger.triggeredBy`. No default: no header is read unless one is named.
* Google Cloud Scheduler sends `'x-cloudscheduler-jobname'`.
*/
readonly triggeredByHeader?: string | undefined;
}

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