PURISTA API

---

PURISTA API / @purista/core / QueueWorkerBuilder

Class: QueueWorkerBuilder

Defined in: QueueWorkerBuilder/QueueWorkerBuilder.impl.ts:10

Constructors

Constructor

new QueueWorkerBuilder(queueName, workerName): QueueWorkerBuilder

Defined in: QueueWorkerBuilder/QueueWorkerBuilder.impl.ts:18

Parameters

queueName

string

workerName

string

Returns

QueueWorkerBuilder

Methods

getAfterGuardHook()

getAfterGuardHook(name): QueueWorkerAfterGuardHook

Defined in: QueueWorkerBuilder/QueueWorkerBuilder.impl.ts:63

Return a previously registered after-guard hook by name.

Parameters

name

string

Returns

QueueWorkerAfterGuardHook

---

getBeforeGuardHook()

getBeforeGuardHook(name): QueueWorkerBeforeGuardHook

Defined in: QueueWorkerBuilder/QueueWorkerBuilder.impl.ts:51

Return a previously registered before-guard hook by name.

Parameters

name

string

Returns

QueueWorkerBeforeGuardHook

---

getDefinition()

getDefinition(): Promise<QueueWorkerDefinition>

Defined in: QueueWorkerBuilder/QueueWorkerBuilder.impl.ts:67

Returns

Promise<QueueWorkerDefinition>

---

setAfterGuardHooks()

setAfterGuardHooks(hooks): QueueWorkerBuilder

Defined in: QueueWorkerBuilder/QueueWorkerBuilder.impl.ts:55

Parameters

hooks

Record<string, QueueWorkerAfterGuardHook>

Returns

QueueWorkerBuilder

---

setBeforeGuardHooks()

setBeforeGuardHooks(hooks): QueueWorkerBuilder

Defined in: QueueWorkerBuilder/QueueWorkerBuilder.impl.ts:43

Parameters

hooks

Record<string, QueueWorkerBeforeGuardHook>

Returns

QueueWorkerBuilder

---

setHandler()

setHandler(handler): QueueWorkerBuilder

Defined in: QueueWorkerBuilder/QueueWorkerBuilder.impl.ts:38

Parameters

handler

QueueWorkerHandler

Returns

QueueWorkerBuilder

---

setIntervalMs()

setIntervalMs(intervalMs): QueueWorkerBuilder

Defined in: QueueWorkerBuilder/QueueWorkerBuilder.impl.ts:28

Parameters

intervalMs

number

Returns

QueueWorkerBuilder

---

setMaxParallelHandlers()

setMaxParallelHandlers(count): QueueWorkerBuilder

Defined in: QueueWorkerBuilder/QueueWorkerBuilder.impl.ts:33

Parameters

count

number

Returns

QueueWorkerBuilder

---

setMode()

setMode(mode): QueueWorkerBuilder

Defined in: QueueWorkerBuilder/QueueWorkerBuilder.impl.ts:23

Parameters

mode

QueueWorkerMode

Returns

QueueWorkerBuilder