Interface IJobDefinition<DATA>

interface IJobDefinition<DATA = unknown> {
    concurrency?: number;
    filePath: undefined | string;
    fn: DefinitionProcessor<DATA, void | (error?: Error) => void>;
    lockLifetime: number;
    lockLimit: number;
    priority?: number;
}

Type Parameters

  • DATA = unknown

Properties

concurrency? filePath fn lockLifetime lockLimit priority?

Properties

Optionalconcurrency

concurrency?: number

how many jobs of this kind can run in parallel/simultanously per Agenda instance

filePath

filePath: undefined | string

fn

fn: DefinitionProcessor<DATA, void | (error?: Error) => void>

lockLifetime

lockLifetime: number

lock lifetime in milliseconds

lockLimit

lockLimit: number

max number of locked jobs of this kind

Optionalpriority

priority?: number

Higher priority jobs will run first.

Settings

Member Visibility

On This Page

Properties