sandboxed-job.d.ts 1.2 KB

12345678910111213141516171819202122232425262728293031323334
  1. import { JobJsonSandbox, JobProgress, JobsOptions } from '../types';
  2. import { MoveToWaitingChildrenOpts } from './minimal-job';
  3. /**
  4. * @see {@link https://docs.bullmq.io/guide/workers/sandboxed-processors}
  5. */
  6. export interface SandboxedJob<T = any, R = any> extends Omit<JobJsonSandbox, 'data' | 'opts' | 'returnvalue'> {
  7. data: T;
  8. opts: JobsOptions;
  9. queueQualifiedName: string;
  10. moveToDelayed: (timestamp: number, token?: string) => Promise<void>;
  11. moveToWait: (token?: string) => Promise<void>;
  12. moveToWaitingChildren: (token?: string, opts?: MoveToWaitingChildrenOpts) => Promise<boolean>;
  13. log: (row: string) => void;
  14. updateData: (data: T) => Promise<void>;
  15. updateProgress: (value: JobProgress) => Promise<void>;
  16. getChildrenValues: <CT = any>() => Promise<{
  17. [jobKey: string]: CT;
  18. }>;
  19. getIgnoredChildrenFailures: () => Promise<{
  20. [jobKey: string]: string;
  21. }>;
  22. getDependenciesCount: (opts?: {
  23. failed?: boolean;
  24. ignored?: boolean;
  25. processed?: boolean;
  26. unprocessed?: boolean;
  27. }) => Promise<{
  28. failed?: number;
  29. ignored?: number;
  30. processed?: number;
  31. unprocessed?: number;
  32. }>;
  33. returnValue: R;
  34. }