Interface BackgroundJobsAdapter<TImplementation>

implementation

enqueue

• enqueue<T>(
      handler: string | HandlerClassOrInstance<T>,
      data: T,
      options?: TImplementation extends "mongo"
          ? MongoEnqueueOptions
          : TImplementation extends "postgres"
              ? PostgresEnqueueOptions
              : EnqueueOptions,
  ): Promise<unknown>

  Enqueue a job to be processed.

  Type Parameters

  • T

  Parameters

  • handler: string | HandlerClassOrInstance<T>

    The handler class or instance that will process the job

  • data: T

    The data to be processed by the handler

  • Optionaloptions: TImplementation extends "mongo"
        ? MongoEnqueueOptions
        : TImplementation extends "postgres"
            ? PostgresEnqueueOptions
            : EnqueueOptions

    Optional configuration for the job

  Returns Promise<unknown>

  A promise that resolves to the enqueued job or undefined (implementation-specific)