comments

Author: muniter

src/interfaces/job.ts

@@ -1,30 +1,44 @@
+import type { Queue } from "../core/queue.ts";
+
 export type JobStatus = 'waiting' | 'delayed' | 'reserved' | 'done' | 'failed';
 
 export interface JobMeta {
+  /** Time to run - number of seconds to run the job */ 
   ttr?: number;
+  /** Number of seconds to delay job execution from now */
   delay?: number;
+  /** Job priority - higher numbers = higher priority (processed first) */
   priority?: number;
+  /** Job pushed at */
   pushedAt?: Date;
+  /** Job reserved at */
   reservedAt?: Date;
+  /** Job done at */
   doneAt?: Date;
+  /** SQS receipt handle */
   receiptHandle?: string;  // For SQS
 }
 
 /**
  * Job context object passed to handlers containing full job information.
  */
 export interface JobContext<T> {
+  /** Job ID */
   id: string;
+  /** Job payload */
   payload: T;
+  /** Job meta: ttr, delay, priority, pushedAt, reservedAt, doneAt, receiptHandle */
   meta: JobMeta;
+  /** Job pushed at */
   pushedAt?: Date;
+  /** Job reserved at */
   reservedAt?: Date;
 }
 
 /**
  * Type for a single job handler function.
  */
-export type JobHandler<T> = (job: JobContext<T>, queue: any) => Promise<void> | void;
+export type JobHandler<T, Q = Queue> = (job: JobContext<T>, queue: Queue) => Promise<void> | void;
 
 /**
  * Type mapping all job types to their corresponding handlers.
@@ -36,12 +50,18 @@ export type JobHandlers<TJobMap> = {
 
 export interface QueueMessage {
   id: string;
+  /** Job name */
+  name: string;
+  /** Job payload */
   payload: string;
+  /** Job meta: ttr, delay, priority, pushedAt, reservedAt, doneAt, receiptHandle */
   meta: JobMeta;
 }
 
 export interface JobData {
+  /** Job name */
   name: string;
+  /** Job payload */
   payload: any;
 }
 
@@ -54,59 +74,68 @@ export type QueueEvent =
 
 // Base options supported by all drivers (without payload)
 export interface BaseJobOptions {
+  /** Time to run - number of seconds to run the job */ 
   ttr?: number;
 }
 
 // Full options interface (for internal use)
 export interface JobOptions extends BaseJobOptions {
+  /** Number of seconds to delay job execution from now */
   delay?: number;
+  /** Job priority - higher numbers = higher priority (processed first) */
   priority?: number;
 }
 
 // Driver-specific options interfaces (without payload)
 export interface DbJobOptions extends BaseJobOptions {
   // DB adapters may or may not support delay/priority - we allow them for flexibility
   // The specific DatabaseAdapter implementation determines actual support
+  /** Number of seconds to delay job execution from now. Support varies by database adapter. */
   delay?: number;
+  /** Job priority - higher numbers = higher priority. Support varies by database adapter. */
   priority?: number;
 }
 
 export interface SqsJobOptions extends BaseJobOptions {
+  /** Number of seconds to delay job execution from now (0-900 seconds max for SQS) */
   delay?: number;
-  // SQS supports delay natively via DelaySeconds
-  // Priority is not supported (would require FIFO queues + message group IDs)
 }
 
 export interface FileJobOptions extends BaseJobOptions {
+  /** Number of seconds to delay job execution from now */
   delay?: number;
-  // File queue implements delay functionality  
-  // Priority ordering is not implemented in current FileQueue
 }
 
 export interface InMemoryJobOptions extends BaseJobOptions {
+  /** Number of seconds to delay job execution from now */
   delay?: number;
+  /** Job priority - higher numbers = higher priority (processed first) */
   priority?: number;
-  // InMemory queue supports both delay and priority
 }
 
 // Combined interfaces that include payload for the new API
 export interface BaseJobRequest<TPayload> extends BaseJobOptions {
+  /** Job payload */
   payload: TPayload;
 }
 
 export interface DbJobRequest<TPayload> extends DbJobOptions {
+  /** Job payload */
   payload: TPayload;
 }
 
 export interface SqsJobRequest<TPayload> extends SqsJobOptions {
+  /** Job payload */
   payload: TPayload;
 }
 
 export interface FileJobRequest<TPayload> extends FileJobOptions {
+  /** Job payload */
   payload: TPayload;
 }
 
 export interface InMemoryJobRequest<TPayload> extends InMemoryJobOptions {
+  /** Job payload */
   payload: TPayload;
 }