Skip to content

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

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

import { SchedulerHttpTargetOptions } from '@gj-kit/nest-operations-jobs/core';
interface SchedulerHttpTargetOptions {
/** Absolute http(s) origin, no trailing slash required. */
readonly baseUrl: string;
/** Defaults to `'internal/jobs'`; must match the trigger controller's path. */
readonly routePrefix?: string | undefined;
/** Defaults to 60_000. Head room between the job deadline and the HTTP deadline. */
readonly attemptDeadlineMarginMs?: number | undefined;
/**
* Defaults to 1_800 seconds. That number is the most common documented ceiling
* rather than a statement about any one scheduler — hosts on a different
* platform pass their own.
*
* A job whose deadline plus margin does not fit under it raises
* `ERR_JOB_INVALID` naming the key: either lower that job's `timeoutMs` or
* raise this ceiling to whatever the platform actually allows.
*/
readonly maxAttemptDeadlineSeconds?: number | 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: ./core
  • Source: GitHub