Skip to content

SchedulerHttpTarget — @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 { SchedulerHttpTarget } from '@gj-kit/nest-operations-jobs';
interface SchedulerHttpTarget {
readonly key: string;
readonly description: string;
/** `${baseUrl}/${routePrefix}/${key}/run` with duplicate slashes collapsed. */
readonly uri: string;
readonly httpMethod: 'POST';
readonly cron: string;
readonly timeZone: string;
/**
* `ceil(timeoutMs / 1000) + margin` — the job must finish first.
*
* Never clamped down to `maxAttemptDeadlineSeconds`: a target that gives up
* before the runner does is a contradiction, not a compromise, so
* {@link schedulerHttpTargets} raises `ERR_JOB_INVALID` instead of emitting one.
*/
readonly attemptDeadlineSeconds: number;
}

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