JobContext.ts 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. import BaseModule from "./BaseModule";
  2. import Job from "./Job";
  3. import JobQueue from "./JobQueue";
  4. import { Log } from "./LogBook";
  5. import { JobOptions } from "./types/JobOptions";
  6. import { Jobs, Modules } from "./types/Modules";
  7. export default class JobContext {
  8. public readonly job: Job;
  9. public readonly jobQueue: JobQueue;
  10. public constructor(job: Job) {
  11. this.job = job;
  12. this.jobQueue = JobQueue.getPrimaryInstance();
  13. }
  14. /**
  15. * Log a message in the context of the current job, which automatically sets the category and data
  16. *
  17. * @param log - Log message or object
  18. */
  19. public log(log: string | Omit<Log, "timestamp" | "category">) {
  20. return this.job.log(log);
  21. }
  22. /**
  23. * executeJob - Execute a job
  24. *
  25. * @param moduleName - Module name
  26. * @param jobName - Job name
  27. * @param params - Params
  28. */
  29. public async executeJob<
  30. ModuleNameType extends keyof Jobs & keyof Modules,
  31. JobNameType extends keyof Jobs[ModuleNameType] &
  32. keyof Omit<Modules[ModuleNameType], keyof BaseModule>,
  33. PayloadType extends "payload" extends keyof Jobs[ModuleNameType][JobNameType]
  34. ? Jobs[ModuleNameType][JobNameType]["payload"] extends undefined
  35. ? Record<string, never>
  36. : Jobs[ModuleNameType][JobNameType]["payload"]
  37. : Record<string, never>,
  38. ReturnType = "returns" extends keyof Jobs[ModuleNameType][JobNameType]
  39. ? Jobs[ModuleNameType][JobNameType]["returns"]
  40. : never
  41. >(
  42. moduleName: ModuleNameType,
  43. jobName: JobNameType,
  44. payload: PayloadType,
  45. options?: JobOptions
  46. ): Promise<ReturnType> {
  47. return new Job(
  48. jobName.toString(),
  49. moduleName,
  50. payload,
  51. options
  52. ).execute();
  53. }
  54. }