@navios/schedule 0.4.0 → 0.7.0

package/dist/src/decorators/cron.decorator.d.mts

@@ -1,6 +1,54 @@
 import type { CronJobParams } from 'cron';
+/**
+ * Options for configuring a cron job.
+ *
+ * @public
+ */
 export interface CronOptions {
+    /**
+     * Whether the job should be disabled by default.
+     * Disabled jobs won't start automatically but can be manually started later.
+     *
+     * @default false
+     */
     disabled?: boolean;
 }
+/**
+ * Decorator that marks a method to run on a cron schedule.
+ *
+ * The method must be in a class decorated with `@Schedulable()`.
+ * The method will be automatically executed according to the provided cron expression.
+ *
+ * @param cronTime - Cron expression (5 or 6 fields) or a pre-defined Schedule constant
+ * @param options - Optional configuration for the cron job
+ *
+ * @example
+ * ```typescript
+ * @Schedulable()
+ * class TaskService {
+ *   // Run daily at midnight
+ *   @Cron('0 0 * * *')
+ *   async dailyTask() {
+ *     console.log('Running daily task')
+ *   }
+ *
+ *   // Use pre-defined schedule
+ *   @Cron(Schedule.EveryFiveMinutes)
+ *   async frequentTask() {
+ *     console.log('Running every 5 minutes')
+ *   }
+ *
+ *   // Disabled job (won't start automatically)
+ *   @Cron('0 2 * * *', { disabled: true })
+ *   async maintenanceTask() {
+ *     console.log('Maintenance task')
+ *   }
+ * }
+ * ```
+ *
+ * @throws {Error} If applied to something other than a method
+ *
+ * @public
+ */
 export declare function Cron(cronTime: CronJobParams['cronTime'], options?: CronOptions): (target: () => Promise<void>, context: ClassMethodDecoratorContext) => () => Promise<void>;
 //# sourceMappingURL=cron.decorator.d.mts.map

package/dist/src/decorators/cron.decorator.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"cron.decorator.d.mts","sourceRoot":"","sources":["../../../src/decorators/cron.decorator.mts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,MAAM,CAAA;AAIzC,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,wBAAgB,IAAI,CAClB,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,EACnC,OAAO,CAAC,EAAE,WAAW,IAGnB,QAAQ,MAAM,OAAO,CAAC,IAAI,CAAC,EAC3B,SAAS,2BAA2B,WADtB,OAAO,CAAC,IAAI,CAAC,CAe9B"}
+{"version":3,"file":"cron.decorator.d.mts","sourceRoot":"","sources":["../../../src/decorators/cron.decorator.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,MAAM,CAAA;AAIzC;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,IAAI,CAClB,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,EACnC,OAAO,CAAC,EAAE,WAAW,IAGnB,QAAQ,MAAM,OAAO,CAAC,IAAI,CAAC,EAC3B,SAAS,2BAA2B,WADtB,OAAO,CAAC,IAAI,CAAC,CAe9B"}

package/dist/src/decorators/schedulable.decorator.d.mts

@@ -1,3 +1,28 @@
 import type { ClassType } from '@navios/core';
+/**
+ * Decorator that marks a class as schedulable and makes it injectable.
+ *
+ * Classes decorated with `@Schedulable()` can contain methods decorated with `@Cron()`
+ * that will be automatically scheduled and executed. This decorator also applies
+ * the `@Injectable()` decorator, making the class available for dependency injection.
+ *
+ * @example
+ * ```typescript
+ * @Schedulable()
+ * class TaskService {
+ *   @Cron('0 0 * * *')
+ *   async dailyTask() {
+ *     // This will run daily at midnight
+ *   }
+ * }
+ *
+ * // Register the service
+ * schedulerService.register(TaskService)
+ * ```
+ *
+ * @throws {Error} If applied to something other than a class
+ *
+ * @public
+ */
 export declare function Schedulable(): (target: ClassType, context: ClassDecoratorContext) => ClassType;
 //# sourceMappingURL=schedulable.decorator.d.mts.map

package/dist/src/decorators/schedulable.decorator.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"schedulable.decorator.d.mts","sourceRoot":"","sources":["../../../src/decorators/schedulable.decorator.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAM7C,wBAAgB,WAAW,KACjB,QAAQ,SAAS,EAAE,SAAS,qBAAqB,eAW1D"}
+{"version":3,"file":"schedulable.decorator.d.mts","sourceRoot":"","sources":["../../../src/decorators/schedulable.decorator.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAM7C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,WAAW,KACjB,QAAQ,SAAS,EAAE,SAAS,qBAAqB,eAW1D"}

package/dist/src/scheduler.service.d.mts

@@ -1,12 +1,114 @@
 import type { ClassType } from '@navios/core';
 import { CronJob } from 'cron';
+/**
+ * Service responsible for managing and executing scheduled cron jobs.
+ *
+ * The SchedulerService registers schedulable services decorated with `@Schedulable()`
+ * and automatically starts their cron jobs based on the `@Cron()` decorator configuration.
+ *
+ * @example
+ * ```typescript
+ * import { inject, Injectable } from '@navios/core'
+ * import { SchedulerService } from '@navios/schedule'
+ *
+ * @Injectable()
+ * class AppModule {
+ *   private readonly scheduler = inject(SchedulerService)
+ *
+ *   async onModuleInit() {
+ *     this.scheduler.register(MySchedulableService)
+ *   }
+ * }
+ * ```
+ *
+ * @public
+ */
 export declare class SchedulerService {
     private readonly logger;
+    private readonly container;
     private readonly jobs;
+    /**
+     * Registers a schedulable service and starts all its cron jobs.
+     *
+     * The service must be decorated with `@Schedulable()` and contain methods
+     * decorated with `@Cron()` to be registered successfully.
+     *
+     * @param service - The schedulable service class to register
+     * @throws {Error} If the service is not decorated with `@Schedulable()`
+     *
+     * @example
+     * ```typescript
+     * @Schedulable()
+     * class TaskService {
+     *   @Cron('0 0 * * *')
+     *   async dailyTask() {
+     *     // Runs daily at midnight
+     *   }
+     * }
+     *
+     * schedulerService.register(TaskService)
+     * ```
+     *
+     * @public
+     */
     register(service: ClassType): void;
+    /**
+     * Retrieves a specific cron job instance for a method in a schedulable service.
+     *
+     * @param service - The schedulable service class
+     * @param method - The name of the method decorated with `@Cron()`
+     * @returns The CronJob instance if found, undefined otherwise
+     *
+     * @example
+     * ```typescript
+     * const job = schedulerService.getJob(TaskService, 'dailyTask')
+     * if (job) {
+     *   console.log('Job is active:', job.isActive)
+     *   job.start() // Manually start the job
+     *   job.stop()  // Manually stop the job
+     * }
+     * ```
+     *
+     * @public
+     */
     getJob<T extends ClassType>(service: T, method: keyof InstanceType<T>): CronJob | undefined;
     private registerJobs;
+    /**
+     * Starts all registered cron jobs that are currently inactive.
+     *
+     * Only jobs that are not already active will be started. This method
+     * is useful for resuming all jobs after calling `stopAll()`.
+     *
+     * @example
+     * ```typescript
+     * // Stop all jobs
+     * schedulerService.stopAll()
+     *
+     * // Later, resume all jobs
+     * schedulerService.startAll()
+     * ```
+     *
+     * @public
+     */
     startAll(): void;
+    /**
+     * Stops all registered cron jobs that are currently active.
+     *
+     * Only jobs that are currently active will be stopped. This method
+     * is useful for pausing all scheduled tasks, for example during
+     * application shutdown or maintenance.
+     *
+     * @example
+     * ```typescript
+     * // Pause all scheduled jobs
+     * schedulerService.stopAll()
+     *
+     * // Jobs can be resumed later with startAll()
+     * schedulerService.startAll()
+     * ```
+     *
+     * @public
+     */
     stopAll(): void;
 }
 //# sourceMappingURL=scheduler.service.d.mts.map

package/dist/src/scheduler.service.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"scheduler.service.d.mts","sourceRoot":"","sources":["../../src/scheduler.service.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAU7C,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAS9B,qBACa,gBAAgB;IAE3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAErB;IACF,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAkC;IAEvD,QAAQ,CAAC,OAAO,EAAE,SAAS;IAW3B,MAAM,CAAC,CAAC,SAAS,SAAS,EACxB,OAAO,EAAE,CAAC,EACV,MAAM,EAAE,MAAM,YAAY,CAAC,CAAC,CAAC,GAC5B,OAAO,GAAG,SAAS;IAMtB,OAAO,CAAC,YAAY;IA4BpB,QAAQ;IASR,OAAO;CAQR"}
+{"version":3,"file":"scheduler.service.d.mts","sourceRoot":"","sources":["../../src/scheduler.service.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAI7C,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAS9B;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBACa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAErB;IACF,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAkC;IAEvD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS;IAW3B;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,CAAC,SAAS,SAAS,EACxB,OAAO,EAAE,CAAC,EACV,MAAM,EAAE,MAAM,YAAY,CAAC,CAAC,CAAC,GAC5B,OAAO,GAAG,SAAS;IAMtB,OAAO,CAAC,YAAY;IA4BpB;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ;IASR;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO;CAQR"}