Features
Docs
CLI
Benchmarks
Examples

© 2024 MoroJs

@morojs/moro


@morojs/moro / JobOptions

Interface: JobOptions

Defined in: src/core/jobs/job-scheduler.ts:21

Properties

enableCircuitBreaker?

optional enableCircuitBreaker: boolean

Defined in: src/core/jobs/job-scheduler.ts:32


enabled?

optional enabled: boolean

Defined in: src/core/jobs/job-scheduler.ts:24


maxConcurrent?

optional maxConcurrent: number

Defined in: src/core/jobs/job-scheduler.ts:27


maxRetries?

optional maxRetries: number

Defined in: src/core/jobs/job-scheduler.ts:29


metadata?

optional metadata: Record<string, any>

Defined in: src/core/jobs/job-scheduler.ts:33


name?

optional name: string

Defined in: src/core/jobs/job-scheduler.ts:22


onComplete()?

optional onComplete: (context, result) => void | Promise<void>

Defined in: src/core/jobs/job-scheduler.ts:35

Parameters

context

ExecutionContext

result

any

Returns

void | Promise<void>


onError()?

optional onError: (context, error) => void | Promise<void>

Defined in: src/core/jobs/job-scheduler.ts:36

Parameters

context

ExecutionContext

error

Error

Returns

void | Promise<void>


onStart()?

optional onStart: (context) => void | Promise<void>

Defined in: src/core/jobs/job-scheduler.ts:34

Parameters

context

ExecutionContext

Returns

void | Promise<void>


priority?

optional priority: number

Defined in: src/core/jobs/job-scheduler.ts:25


retryBackoff?

optional retryBackoff: "linear" | "exponential"

Defined in: src/core/jobs/job-scheduler.ts:31


retryDelay?

optional retryDelay: number

Defined in: src/core/jobs/job-scheduler.ts:30


schedule

schedule: JobSchedule

Defined in: src/core/jobs/job-scheduler.ts:23


timeout?

optional timeout: number

Defined in: src/core/jobs/job-scheduler.ts:28


timezone?

optional timezone: string

Defined in: src/core/jobs/job-scheduler.ts:26