@forgrit/shared-contracts-jobs-queue

v0.1.0

Published

Type-only contracts + NestJS DI Symbol tokens for ForGrit job + queue services — IJobsService, IQueueService, IJobStepService.

Readme

@forgrit/shared-contracts-jobs-queue

Type-only contracts + NestJS DI Symbol tokens for ForGrit job + queue services — IJobsService (3 methods), IQueueService (1 method), IJobStepService (2 methods).

npm version license: MIT

Status: early-access (v0.x). Internal-monorepo seam package. Pre-1.0 may include breaking changes in minor bumps.

Narrow-surface contracts: 3 + 1 + 2 = 6 total method signatures across the 3 interfaces. ForGrit's internal implementations may have many more methods; the contracts capture only what cross-domain consumers depend on.


Install

npm install @forgrit/shared-contracts-jobs-queue

Peer: @nestjs/common.

Sub-modules

import { IJobsService, JOBS_SERVICE } from '@forgrit/shared-contracts-jobs-queue/jobs';
import { IQueueService, QUEUE_SERVICE } from '@forgrit/shared-contracts-jobs-queue/queue';

Pattern

Use useExisting so DI never creates a duplicate BullMQ Queue/Worker:

@Module({
  providers: [MyJobsService, { provide: JOBS_SERVICE, useExisting: MyJobsService }],
})
export class MyModule {}

License

MIT — see LICENSE.

Sibling packages