# Class JobDispatcher
ClassModule | import { JobDispatcher } from "@tsed/bullmq" |
---|---|
Source | /packages/third-parties/bullmq/src/types/dispatchers/JobDispatcher.ts |
# Overview
class JobDispatcher {
<span class="token keyword">constructor</span><span class="token punctuation">(</span>injector<span class="token punctuation">:</span> <a href="/api/di/types/common/services/InjectorService.html"><span class="token">InjectorService</span></a><span class="token punctuation">)</span><span class="token punctuation">;</span>
dispatch<T <span class="token keyword">extends</span> <a href="/api/third-parties/bullmq/types/contracts/JobMethods.html"><span class="token">JobMethods</span></a>><span class="token punctuation">(</span>job<span class="token punctuation">:</span> <a href="/api/core/types/domain/Type.html"><span class="token">Type</span></a><T><span class="token punctuation">,</span> payload?<span class="token punctuation">:</span> Parameters<T<span class="token punctuation">[</span>"handle"<span class="token punctuation">]</span>><span class="token punctuation">[</span>0<span class="token punctuation">]</span><span class="token punctuation">,</span> options?<span class="token punctuation">:</span> JobsOptions<span class="token punctuation">)</span><span class="token punctuation">:</span> Promise<BullMQJob><span class="token punctuation">;</span>
dispatch<P<span class="token punctuation"> = </span>unknown><span class="token punctuation">(</span>job<span class="token punctuation">:</span> <a href="/api/third-parties/bullmq/types/dispatchers/JobDispatcherOptions.html"><span class="token">JobDispatcherOptions</span></a><span class="token punctuation">,</span> payload?<span class="token punctuation">:</span> P<span class="token punctuation">,</span> options?<span class="token punctuation">:</span> JobsOptions<span class="token punctuation">)</span><span class="token punctuation">:</span> Promise<BullMQJob><span class="token punctuation">;</span>
dispatch<P<span class="token punctuation"> = </span>unknown><span class="token punctuation">(</span>job<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">,</span> payload?<span class="token punctuation">:</span> P<span class="token punctuation">,</span> options?<span class="token punctuation">:</span> JobsOptions<span class="token punctuation">)</span><span class="token punctuation">:</span> Promise<BullMQJob><span class="token punctuation">;</span>
}
# Members
dispatch<T extends JobMethods>(job: Type<T>, payload?: Parameters<T["handle"]>[0], options?: JobsOptions): Promise<BullMQJob>;
dispatch<P = unknown>(job: JobDispatcherOptions, payload?: P, options?: JobsOptions): Promise<BullMQJob>;
dispatch<P = unknown>(job: string, payload?: P, options?: JobsOptions): Promise<BullMQJob>;