Skip to content

WorkerOptions

Defined in: packages/core/src/workers/types.ts:21

Options for registering a worker. Retry options override scheduler defaults for this job name; omitted values inherit those defaults.

monque.register('send-email', emailHandler, {
  concurrency: 3,
});
  • RetryOptions
Type ParameterDefault type
Tunknown
optional baseRetryInterval?: number;

Defined in: packages/core/src/scheduler/types.ts:38

Base interval in milliseconds for exponential backoff calculation. Actual delay = 2^failCount * baseRetryInterval

1000

MonqueOptions.baseRetryInterval


optional concurrency?: number;

Defined in: packages/core/src/workers/types.ts:28

Number of concurrent jobs this worker can process.

5 (uses defaultConcurrency from MonqueOptions)

optional maxBackoffDelay?: number;

Defined in: packages/core/src/scheduler/types.ts:46

Maximum delay in milliseconds for exponential backoff. If calculated delay exceeds this value, it will be capped.

Defaults to 24 hours to prevent unbounded delays.

86400000 (24 hours)

MonqueOptions.maxBackoffDelay


optional maxRetries?: number;

Defined in: packages/core/src/scheduler/types.ts:32

Maximum number of retry attempts before marking a job as permanently failed.

10

MonqueOptions.maxRetries


optional replace?: boolean;

Defined in: packages/core/src/workers/types.ts:34

Allow replacing an existing worker for the same job name. If false (default) and a worker already exists, throws WorkerRegistrationError.

false

optional schema?: StandardSchemaV1<unknown, T>;

Defined in: packages/core/src/workers/types.ts:23

Validate persisted input before handling it; the handler receives the schema output.