Documentation / @zerotal/queue / index / PendingBatch

Class: PendingBatch

Defined in: queue/src/PendingBatch.ts:15

Constructors

Constructor

new PendingBatch(_jobs, _dispatcher): PendingBatch

Defined in: queue/src/PendingBatch.ts:21

Parameters

_jobs

Job[]

_dispatcher

BatchDispatcher

Returns

PendingBatch

Accessors

jobs

Get Signature

get jobs(): Job[]

Defined in: queue/src/PendingBatch.ts:50

Returns

Job[]

batchName

Get Signature

get batchName(): string

Defined in: queue/src/PendingBatch.ts:53

Returns

string

options

Get Signature

get options(): BatchOptions

Defined in: queue/src/PendingBatch.ts:56

Returns

BatchOptions

Methods

name()

name(n): this

Defined in: queue/src/PendingBatch.ts:26

Parameters

n

string

Returns

this

then()

then(job): this

Defined in: queue/src/PendingBatch.ts:31

Parameters

job

Job | Job[]

Returns

this

catch()

catch(job): this

Defined in: queue/src/PendingBatch.ts:35

Parameters

job

Job | Job[]

Returns

this

finally()

finally(job): this

Defined in: queue/src/PendingBatch.ts:39

Parameters

job

Job | Job[]

Returns

this

dispatch()

dispatch(): Promise<Batch>

Defined in: queue/src/PendingBatch.ts:44

Returns

Promise<Batch>