Class QueueJob<T>

Type parameters

T: IQueueWorkload

Hierarchy

QueueJob

Index

Constructors

constructor

Properties

Accessors

id

Methods

Constructors

constructor

new QueueJob<T>(queue: IQueue, workload: T): QueueJob<T>

- Defined in src/libs/queue/QueueJob.ts:26
Type parameters
- T: IQueueWorkload
Parameters
- queue: IQueue
- workload: T
Returns QueueJob<T>

Properties

Private _duration

_duration: number

Private _enqueued

_enqueued: Date = null

Private _error

_error: Error = null

Private _id

_id: string

Private _queue

_queue: IQueue

Private _result

_result: any = null

Private _start

_start: Date = null

Private _stop

_stop: Date = null

Private _workload

_workload: T

Static Private _INC

_INC: number = 0

Accessors

id

get id(): string

- Defined in src/libs/queue/QueueJob.ts:35
Returns string

Methods

doEnqueue

doEnqueue(): void

- Defined in src/libs/queue/QueueJob.ts:106
Fire event that the job was enqueued

Returns void

doStart

doStart(): void

- Defined in src/libs/queue/QueueJob.ts:114
Fire event that the job was started

Returns void

doStop

doStop(err?: Error): void

- Defined in src/libs/queue/QueueJob.ts:122
Fire event that the job was stopped

Parameters
- err: Error = null
Returns void

done

done(): Promise<QueueJob<T>>

- Defined in src/libs/queue/QueueJob.ts:86
Wait till the job is finished

Returns Promise<QueueJob<T>>

enqueued

enqueued(): Promise<QueueJob<T>>

- Defined in src/libs/queue/QueueJob.ts:43
Returns Promise<QueueJob<T>>

finalize

finalize(): void

- Defined in src/libs/queue/QueueJob.ts:162
Clear references to the _queue object

Returns void

getError

getError(): Error

- Defined in src/libs/queue/QueueJob.ts:63
Returns Error

getResult

getResult(): any

- Defined in src/libs/queue/QueueJob.ts:55
Returns any

isEnqueued

isEnqueued(): boolean

- Defined in src/libs/queue/QueueJob.ts:132
Check if the job is enqueued

Returns boolean

isFinished

isFinished(): boolean

- Defined in src/libs/queue/QueueJob.ts:146
Check if the job is finished

Returns boolean

isStarted

isStarted(): boolean

- Defined in src/libs/queue/QueueJob.ts:139
Check if the job is started

Returns boolean

Private jobEventName

jobEventName(type: "start" | "stop" | "enqueued"): string

- Defined in src/libs/queue/QueueJob.ts:178
Helper generating the event names for different jobs id and states

Parameters
- type: "start" | "stop" | "enqueued"
Returns string

Private onDone

onDone(): void

- Defined in src/libs/queue/QueueJob.ts:154
Fired when the job is finished

Returns void

setResult

setResult(v: any): void

- Defined in src/libs/queue/QueueJob.ts:59
Parameters
- v: any
Returns void

starting

starting(): Promise<QueueJob<T>>

- Defined in src/libs/queue/QueueJob.ts:70
Wait till the job is begins

Returns Promise<QueueJob<T>>

workload

workload(): T

- Defined in src/libs/queue/QueueJob.ts:39
Returns T

Generated using TypeDoc