Skip to content

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

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

import { OperationsJobsModule } from '@gj-kit/nest-operations-jobs';
/**
* The operations job platform. Job definitions live as providers in the host's
* own domain modules (`@OperationsJobDefinition()`); this module owns only the
* execution environment: registry collection, the runner, trigger
* authentication and — optionally — the trigger controller.
*/
declare class OperationsJobsModule {
/**
* Synchronous wiring. Authentication is validated here, at assembly time: a
* deployment with neither a shared secret nor a token verifier fails to boot
* instead of failing on the scheduler's first call.
*
* The registry and the runner are bound as **factories**, so each DI container
* built from the returned module gets its own pair. Binding instances would
* make the returned object stateful: the host module that holds this call is
* evaluated once, and every later application built from it — an e2e suite's
* second `Test.createTestingModule`, a warm serverless re-init, HMR — would
* re-register the same jobs into the already-populated registry and die with
* `ERR_JOB_DUPLICATE_KEY` blaming the job class.
*/
static forRoot(options: OperationsJobsModuleOptions): DynamicModule;
/**
* Asynchronous wiring, for hosts whose store or secret comes from another
* provider. `auth` is validated immediately after the factory resolves, so the
* boot-failure guarantee survives this path.
*
* The trigger controller cannot be registered from here — a Nest module's
* controller list is fixed before the factory runs. Async hosts put
* `createOperationsJobsController({ path })` in their own module's
* `controllers` array.
*/
static forRootAsync(options: OperationsJobsModuleAsyncOptions): DynamicModule;
}

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