Interface EnqueueManyItem
interface EnqueueManyItem {
delayMs?: number;
groupKey?: string;
kind: string;
maxAttempts?: number;
maxStalledCount?: number;
metadata?: any;
payload: any;
priority?: number;
queue?: string;
removeOnComplete?: number | boolean | { age?: number; count?: number };
removeOnFail?: number | boolean | { age?: number; count?: number };
scheduledAtMs?: number;
tags?: string[];
uniqueKey?: string;
}
delayMs?: number;
groupKey?: string;
kind: string;
maxAttempts?: number;
maxStalledCount?: number;
metadata?: any;
payload: any;
priority?: number;
queue?: string;
removeOnComplete?: number | boolean | { age?: number; count?: number };
removeOnFail?: number | boolean | { age?: number; count?: number };
scheduledAtMs?: number;
tags?: string[];
uniqueKey?: string;
}
Properties
OptionaldelayMs
delayMs?: number
Delay this job by N milliseconds relative to batch-submit time.
Mutually exclusive with scheduledAtMs.
OptionalgroupKey
groupKey?: string
kind
kind: string
Job kind — matches @JobHandler(kind) on the worker side.
OptionalmaxAttempts
maxAttempts?: number
OptionalmaxStalledCount
maxStalledCount?: number
See EnqueueOptions.maxStalledCount.
Optionalmetadata
metadata?: any
payload
payload: any
Optionalpriority
priority?: number
Optionalqueue
queue?: string
OptionalremoveOnComplete
removeOnComplete?: number | boolean | { age?: number; count?: number }
See EnqueueOptions.removeOnComplete.
OptionalremoveOnFail
removeOnFail?: number | boolean | { age?: number; count?: number }
See EnqueueOptions.removeOnFail.
OptionalscheduledAtMs
scheduledAtMs?: number
Run no earlier than this time (epoch milliseconds). Default now.
Mutually exclusive with delayMs.
Optionaltags
tags?: string[]
Admin-visible tags (stored on the job row, queryable via listJobs).
OptionaluniqueKey
uniqueKey?: string
One item in an
enqueueManybatch. Mixedkindis supported across items.