PURISTA

Appearance

PURISTA API

PURISTA API / @purista/core / QueueJobControls

Type Alias: QueueJobControls ​

QueueJobControls = object

Defined in: core/types/queue/QueueJobContext.ts:13

Methods ​

cancelRequested() ​

cancelRequested(): boolean

Defined in: core/types/queue/QueueJobContext.ts:19

Returns ​

boolean

complete() ​

complete(output?, headers?): Promise<void>

Defined in: core/types/queue/QueueJobContext.ts:14

Parameters ​

output? ​

unknown

headers? ​

Record<string, string>

Returns ​

Promise<void>

extendLease() ​

extendLease(durationMs): Promise<void>

Defined in: core/types/queue/QueueJobContext.ts:18

Parameters ​

durationMs ​

number

Returns ​

Promise<void>

fail() ​

fail(reason, fatal?): Promise<void>

Defined in: core/types/queue/QueueJobContext.ts:16

Parameters ​

reason ​

string

fatal? ​

boolean

Returns ​

Promise<void>

moveToDeadLetter() ​

moveToDeadLetter(reason?): Promise<void>

Defined in: core/types/queue/QueueJobContext.ts:17

Parameters ​

reason? ​

string

Returns ​

Promise<void>

retry() ​

retry(request?): Promise<void>

Defined in: core/types/queue/QueueJobContext.ts:15

Parameters ​

request? ​

QueueRetryRequest

Returns ​

Promise<void>