Documentation / @zerotal/queue / index / Batch
Class: Batch
Defined in: queue/src/Batch.ts:21
Constructors
Constructor
new Batch(
_r):Batch
Defined in: queue/src/Batch.ts:22
Parameters
_r
Returns
Batch
Accessors
id
Get Signature
get id():
string
Defined in: queue/src/Batch.ts:24
Returns
string
name
Get Signature
get name():
string
Defined in: queue/src/Batch.ts:27
Returns
string
totalJobs
Get Signature
get totalJobs():
number
Defined in: queue/src/Batch.ts:30
Returns
number
pendingJobs
Get Signature
get pendingJobs():
number
Defined in: queue/src/Batch.ts:33
Returns
number
failedJobs
Get Signature
get failedJobs():
number
Defined in: queue/src/Batch.ts:36
Returns
number
failedJobIds
Get Signature
get failedJobIds():
number[]
Defined in: queue/src/Batch.ts:39
Returns
number[]
options
Get Signature
get options():
BatchOptions
Defined in: queue/src/Batch.ts:42
Returns
createdAt
Get Signature
get createdAt():
string
Defined in: queue/src/Batch.ts:45
Returns
string
finishedAt
Get Signature
get finishedAt():
string|undefined
Defined in: queue/src/Batch.ts:48
Returns
string | undefined
Methods
finished()
finished():
boolean
Defined in: queue/src/Batch.ts:52
Returns
boolean
failed()
failed():
boolean
Defined in: queue/src/Batch.ts:55
Returns
boolean
progress()
progress():
number
Defined in: queue/src/Batch.ts:58
Returns
number