Interface RepeatOptions

Settings for repeatable jobs

interface RepeatOptions {
    count?: number;
    every?: number;
    immediately?: boolean;
    jobId?: string;
    limit?: number;
    offset?: number;
    pattern?: string;
    prevMillis?: number;
}

Hierarchy

  • Omit<ParserOptions, "iterator">
    • RepeatOptions

Properties

count?: number

The start value for the repeat iteration count.

every?: number

Repeat after this amount of milliseconds (pattern setting cannot be used together with this setting.)

immediately?: boolean

Repeated job should start right now ( work only with every settings)

jobId?: string
limit?: number

Number of times the job should repeat at max.

offset?: number
pattern?: string

A repeat pattern

prevMillis?: number

Generated using TypeDoc