upd types

agenda · Jul 29, 2022 · 42e9191 · 42e9191
1 parent 4e38e6d
commit 42e9191
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 9 deletions.
diff --git a/lib/agenda/every.ts b/lib/agenda/every.ts
@@ -1,6 +1,6 @@
 import createDebugger from "debug";
 import { Agenda } from ".";
-import { Job } from "../job";
+import { Job, JobAttributesData } from "../job";
 import { JobOptions } from "../job/repeat-every";
 
 const debug = createDebugger("agenda:every");
@@ -15,11 +15,11 @@ const debug = createDebugger("agenda:every");
  * @param options - options to run job for
  * @returns Job/s created. Resolves when schedule fails or passes
  */
-export const every = async function (
+export const every = async function<T extends JobAttributesData> (
   this: Agenda,
   interval: string,
   names: string | string[],
-  data?: unknown,
+  data?: T,
   options?: JobOptions
 ): Promise<any> {
   /**
@@ -30,13 +30,13 @@ export const every = async function (
    * @param [options] options to run job for
    * @returns instance of job
    */
-  const createJob = async (
+  const createJob = async<T extends JobAttributesData> (
     interval: string,
     name: string,
-    data?: unknown,
+    data?: T,
     options?: JobOptions
   ): Promise<Job> => {
-    const job = this.create(name, data);
+    const job = this.create(name, data || {});
 
     job.attrs.type = "single";
     job.repeatEvery(interval, options);
@@ -54,7 +54,7 @@ export const every = async function (
   const createJobs = async (
     interval: string,
     names: string[],
-    data?: unknown,
+    data?: T,
     options?: JobOptions
   ): Promise<Job[] | undefined> => {
     try {

diff --git a/lib/job/index.ts b/lib/job/index.ts
@@ -19,6 +19,8 @@ import { Agenda } from "../agenda";
 import { JobPriority } from "../agenda/define";
 import * as mongodb from "mongodb";
 
+type Modify<T, R> = Omit<T, keyof R> & R
+
 export interface JobAttributesData {
   [key: string]: any;
 }
@@ -28,7 +30,7 @@ export interface JobAttributes<
   /**
    * The record identity.
    */
-  _id?: mongodb.ObjectId;
+  _id: mongodb.ObjectId;
 
   agenda: Agenda;
 
@@ -163,7 +165,7 @@ class Job<T extends JobAttributesData = JobAttributesData> {
   touch!: typeof touch;
   setShouldSaveResult!: typeof setShouldSaveResult;
 
-  constructor(options: JobAttributes<T>) {
+  constructor(options: Modify<JobAttributes<T>, { _id?: mongodb.ObjectId; }>) {
     const { agenda, type, nextRunAt, ...args } = options ?? {};
 
     // Save Agenda instance