Documentation / @andrew_l/app / WorkerStrategy

Interface: WorkerStrategy<C>

Pluggable trigger source. Drives when tasks are enqueued.

Type Parameters

C

C extends Context = { }

Methods

availableSignal()?

optional availableSignal(): void

Returns

void

---

completeSignal()?

optional completeSignal(ctx, result): Awaitable<void>

Parameters

ctx

EntryContext<WorkerStrategy<C>>

result

WorkerResult | WorkerResult[]

Returns

Awaitable<void>

---

createTask()

createTask(...args): C

Parameters

args

...any[]

Returns

C

---

doSetup()

doSetup(opts): Awaitable<void>

Parameters

opts

worker

WorkerInstance

Returns

Awaitable<void>

---

doShutdown()

doShutdown(): Awaitable<void>

Returns

Awaitable<void>

---

executeSignal()?

optional executeSignal(ctx): Awaitable<ExecResult>

Parameters

ctx

EntryContext<WorkerStrategy<C>>

Returns

Awaitable<ExecResult>

---

handleEntryError()?

optional handleEntryError(err): WorkerResult

Parameters

err

Error

Returns

WorkerResult

---

overloadedSignal()?

optional overloadedSignal(): void

Returns

void

---

startSignal()

startSignal(): void

Returns

void

---

stopSignal()

stopSignal(done): void

Parameters

done

() => void

Returns

void