OperationsJobsModuleOptions — @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.

Verified import example

import { OperationsJobsModuleOptions } from '@gj-kit/nest-operations-jobs';

Signature, parameters, and return type

interface OperationsJobsModuleOptions {
    readonly store: JobRunStore;
    /** Required. Wiring a trigger surface with no authentication is a boot error. */
    readonly auth: JobTriggerAuthOptions;
    /**
     * Registers the trigger controller at this path (e.g. `'internal/jobs'`).
     * Omit it for CLI-only hosts or hosts that expose their own controllers.
     */
    readonly trigger?: {
        readonly path: string;
        readonly triggeredByHeader?: string | undefined;
    } | undefined;
    /** Defaults to the Nest logger under the `OperationsJob` context. */
    readonly logger?: JobLogger | undefined;
    readonly clock?: JobClock | undefined;
    readonly heartbeatIntervalMs?: number | undefined;
    readonly staleRunAfterMs?: number | undefined;
    readonly defaultTimeoutMs?: number | undefined;
    readonly reapScope?: JobReapScope | undefined;
    readonly reapLimit?: number | undefined;
    readonly serviceRevision?: string | null | undefined;
    /** Defaults to true — one runner per application is the natural unit. */
    readonly global?: boolean | 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.

Release context

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