Agenda | @hokify/agenda

Hierarchy

EventEmitter
- Agenda

Index

Constructors

constructor

Properties

Constructors

constructor

new Agenda(config?: { defaultConcurrency?: undefined | number; defaultLockLifetime?: undefined | number; defaultLockLimit?: undefined | number; lockLimit?: undefined | number; maxConcurrency?: undefined | number; name?: undefined | string; processEvery?: string | number } & IDatabaseOptions | IMongoOptions | {} & IDbConfig, cb?: undefined | ((error?: Error) => void)): Agenda

Overrides EventEmitter.__constructor
- Defined in src/index.ts:59
Parameters
- Default value config: { defaultConcurrency?: undefined | number; defaultLockLifetime?: undefined | number; defaultLockLimit?: undefined | number; lockLimit?: undefined | number; maxConcurrency?: undefined | number; name?: undefined | string; processEvery?: string | number } & IDatabaseOptions | IMongoOptions | {} & IDbConfig = {}
  
  Agenda Config
- Optional cb: undefined | ((error?: Error) => void)
  
  Callback after Agenda has started and connected to mongo
Returns Agenda

Properties

Readonly attrs

attrs: IAgendaConfig & IDbConfig

db

db: JobDbRepository

Readonly definitions

definitions: {}

Type declaration

[name: string]: IJobDefinition

Private Optional jobProcessor

jobProcessor: JobProcessor

Readonly ready

ready: Promise<void>

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: unique symbol

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Agenda.addListener
- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

cancel

cancel(query: FilterQuery<IJobParameters>): Promise<number>

- Defined in src/index.ts:151
Cancels any jobs matching the passed MongoDB query, and removes them from the database.

Parameters
- query: FilterQuery<IJobParameters>
Returns Promise<number>

create

create(name: string): Job<void>
create<DATA>(name: string, data: DATA): Job<DATA>

- Defined in src/index.ts:339
Given a name and some data, create a new job

Parameters
- name: string
Returns Job<void>
- Defined in src/index.ts:340
Type parameters
- DATA = unknown
Parameters
- name: string
- data: DATA
Returns Job<DATA>

Private createJobs

createJobs<DATA>(names: string[], createJob: (name: string) => Promise<Job<DATA>>): Promise<Job<DATA>[]>

- Defined in src/index.ts:319
Internal helper method that uses createJob to create jobs for an array of names

Type parameters
- DATA = unknown
Parameters
- names: string[]
  
  Strings of jobs to schedule
- createJob: (name: string) => Promise<Job<DATA>>
  - - (name: string): Promise<Job<DATA>>
    - Parameters
      - name: string
      Returns Promise<Job<DATA>>
Returns Promise<Job<DATA>[]>

array of jobs created

database

database(address: string, collection?: undefined | string, options?: MongoClientOptions): Promise<Agenda>

- Defined in src/index.ts:109
Connect to the spec'd MongoDB server and database.

Parameters
- address: string
- Optional collection: undefined | string
- Optional options: MongoClientOptions
Returns Promise<Agenda>

defaultConcurrency

defaultConcurrency(num: number): Agenda

- Defined in src/index.ts:202
Set the default concurrency for each job

Parameters
- num: number
  
  number of max concurrency
Returns Agenda

defaultLockLifetime

defaultLockLifetime(ms: number): Agenda

- Defined in src/index.ts:233
Set the default lock time (in ms) Default is 10 * 60 * 1000 ms (10 minutes)

Parameters
- ms: number
Returns Agenda

defaultLockLimit

defaultLockLimit(num: number): Agenda

- Defined in src/index.ts:222
Set default lock limit per job type

Parameters
- num: number
Returns Agenda

define

define<DATA>(name: string, processor: (agendaJob: Job<DATA>, done: (error?: Error) => void) => void, options?: Partial<Pick<IJobDefinition, "lockLimit" | "lockLifetime" | "concurrency">> & { priority?: JobPriority }): void
define<DATA>(name: string, processor: (agendaJob: Job<DATA>) => Promise<void>, options?: Partial<Pick<IJobDefinition, "lockLimit" | "lockLifetime" | "concurrency">> & { priority?: JobPriority }): void

- Defined in src/index.ts:276
Setup definition for job Method is used by consumers of lib to setup their functions BREAKING CHANGE in v4: options moved from 2nd to 3rd parameter!

Type parameters
- DATA = any
Parameters
- name: string
- processor: (agendaJob: Job<DATA>, done: (error?: Error) => void) => void
  - - (agendaJob: Job<DATA>, done: (error?: Error) => void): void
    - Parameters
      - agendaJob: Job<DATA>
      - done: (error?: Error) => void
        
        (error?: Error): void
        
        Parameters
        
        Optional error: Error
        
        Returns void
      Returns void
- Optional options: Partial<Pick<IJobDefinition, "lockLimit" | "lockLifetime" | "concurrency">> & { priority?: JobPriority }
Returns void
- Defined in src/index.ts:284
Type parameters
- DATA = any
Parameters
- name: string
- processor: (agendaJob: Job<DATA>) => Promise<void>
  - - (agendaJob: Job<DATA>): Promise<void>
    - Parameters
      - agendaJob: Job<DATA>
      Returns Promise<void>
- Optional options: Partial<Pick<IJobDefinition, "lockLimit" | "lockLifetime" | "concurrency">> & { priority?: JobPriority }
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from Agenda.emit
- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from Agenda.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

every

every(interval: string | number, names: string[], data?: undefined, options?: undefined | { skipImmediate?: undefined | false | true; timezone?: undefined | string }): Promise<Job<void>[]>
every(interval: string | number, name: string, data?: undefined, options?: undefined | { skipImmediate?: undefined | false | true; timezone?: undefined | string }): Promise<Job<void>>
every<DATA>(interval: string | number, names: string[], data: DATA, options?: undefined | { skipImmediate?: undefined | false | true; timezone?: undefined | string }): Promise<Job<DATA>[]>
every<DATA>(interval: string | number, name: string, data: DATA, options?: undefined | { skipImmediate?: undefined | false | true; timezone?: undefined | string }): Promise<Job<DATA>>

- Defined in src/index.ts:355
Creates a scheduled job with given interval and name/names of the job to run

Parameters
- interval: string | number
- names: string[]
- Optional data: undefined
- Optional options: undefined | { skipImmediate?: undefined | false | true; timezone?: undefined | string }
Returns Promise<Job<void>[]>
- Defined in src/index.ts:361
Parameters
- interval: string | number
- name: string
- Optional data: undefined
- Optional options: undefined | { skipImmediate?: undefined | false | true; timezone?: undefined | string }
Returns Promise<Job<void>>
- Defined in src/index.ts:367
Type parameters
- DATA = unknown
Parameters
- interval: string | number
- names: string[]
- data: DATA
- Optional options: undefined | { skipImmediate?: undefined | false | true; timezone?: undefined | string }
Returns Promise<Job<DATA>[]>
- Defined in src/index.ts:373
Type parameters
- DATA = unknown
Parameters
- interval: string | number
- name: string
- data: DATA
- Optional options: undefined | { skipImmediate?: undefined | false | true; timezone?: undefined | string }
Returns Promise<Job<DATA>>

getMaxListeners

getMaxListeners(): number

Inherited from Agenda.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

getRunningStats

getRunningStats(fullDetails?: boolean): Promise<IAgendaStatus>

- Defined in src/index.ts:54
Parameters
- Default value fullDetails: boolean = false
Returns Promise<IAgendaStatus>

Private hasDatabaseConfig

hasDatabaseConfig(config: unknown): config is IDatabaseOptions | IMongoOptions & IDbConfig

- Defined in src/index.ts:141
Parameters
- config: unknown
Returns config is IDatabaseOptions | IMongoOptions & IDbConfig

isActiveJobProcessor

isActiveJobProcessor(): boolean

- Defined in src/index.ts:50
Returns boolean

jobs

jobs(query?: FilterQuery<IJobParameters>, sort?: FilterQuery<IJobParameters>, limit?: number, skip?: number): Promise<Job[]>

- Defined in src/index.ts:246
Finds all jobs matching 'query'

Parameters
- Default value query: FilterQuery<IJobParameters> = {}
- Default value sort: FilterQuery<IJobParameters> = {}
- Default value limit: number = 0
- Default value skip: number = 0
Returns Promise<Job[]>

listenerCount

listenerCount(event: string | symbol): number

Inherited from Agenda.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from Agenda.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

lockLimit

lockLimit(num: number): Agenda

- Defined in src/index.ts:212
Set the default amount jobs that are allowed to be locked at one time (GLOBAL)

Parameters
- num: number
Returns Agenda

maxConcurrency

maxConcurrency(num: number): Agenda

- Defined in src/index.ts:192
Set the concurrency for jobs (globally), type does not matter

Parameters
- num: number
Returns Agenda

mongo

mongo(mongo: Db, collection?: undefined | string): Promise<Agenda>

- Defined in src/index.ts:124
Use existing mongo connectino to pass into agenda

Parameters
- mongo: Db
- Optional collection: undefined | string
Returns Promise<Agenda>

name

name(name: string): Agenda

- Defined in src/index.ts:167
Set name of queue

Parameters
- name: string
Returns Agenda

now

now<DATA>(name: string): Promise<Job<DATA>>
now<DATA>(name: string, data: DATA): Promise<Job<DATA>>

- Defined in src/index.ts:455
Create a job for this exact moment

Type parameters
- DATA = void
Parameters
- name: string
Returns Promise<Job<DATA>>
- Defined in src/index.ts:456
Type parameters
- DATA = unknown
Parameters
- name: string
- data: DATA
Returns Promise<Job<DATA>>

off

off(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Agenda.off
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: "processJob", listener: (job: JobWithId) => void): this
on(event: "fail", listener: (error: Error, job: JobWithId) => void): this
on(event: "success", listener: (job: JobWithId) => void): this
on(event: "start", listener: (job: JobWithId) => void): this
on(event: "complete", listener: (job: JobWithId) => void): this
on(event: string, listener: (job: JobWithId) => void): this
on(event: string, listener: (error: Error, job: JobWithId) => void): this
on(event: "ready", listener: () => void): this
on(event: "error", listener: (error: Error) => void): this

Overrides EventEmitter.on
- Defined in src/index.ts:28
Parameters
- event: "processJob"
- listener: (job: JobWithId) => void
  - - (job: JobWithId): void
    - Parameters
      - job: JobWithId
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in src/index.ts:30
Parameters
- event: "fail"
- listener: (error: Error, job: JobWithId) => void
  - - (error: Error, job: JobWithId): void
    - Parameters
      - error: Error
      - job: JobWithId
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in src/index.ts:31
Parameters
- event: "success"
- listener: (job: JobWithId) => void
  - - (job: JobWithId): void
    - Parameters
      - job: JobWithId
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in src/index.ts:32
Parameters
- event: "start"
- listener: (job: JobWithId) => void
  - - (job: JobWithId): void
    - Parameters
      - job: JobWithId
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in src/index.ts:33
Parameters
- event: "complete"
- listener: (job: JobWithId) => void
  - - (job: JobWithId): void
    - Parameters
      - job: JobWithId
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in src/index.ts:34
Parameters
- event: string
- listener: (job: JobWithId) => void
  - - (job: JobWithId): void
    - Parameters
      - job: JobWithId
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in src/index.ts:35
Parameters
- event: string
- listener: (error: Error, job: JobWithId) => void
  - - (error: Error, job: JobWithId): void
    - Parameters
      - error: Error
      - job: JobWithId
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in src/index.ts:36
Parameters
- event: "ready"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.on
- Defined in src/index.ts:37
Parameters
- event: "error"
- listener: (error: Error) => void
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns this

once

once(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Agenda.once
- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Agenda.prependListener
- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Agenda.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

processEvery

processEvery(time: string | number): Agenda

- Defined in src/index.ts:177
Set the time how often the job processor checks for new jobs to process

Parameters
- time: string | number
Returns Agenda

purge

purge(): Promise<number>

- Defined in src/index.ts:261
Removes all jobs from queue

note:

Only use after defining your jobs

Returns Promise<number>

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from Agenda.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from Agenda.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Agenda.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

schedule

schedule<DATA>(when: string | Date, names: string[]): Promise<Job<DATA>[]>
schedule<DATA>(when: string | Date, names: string): Promise<Job<DATA>>
schedule<DATA>(when: string | Date, names: string[], data: DATA): Promise<Job<DATA>[]>
schedule<DATA>(when: string | Date, name: string, data: DATA): Promise<Job<DATA>>

- Defined in src/index.ts:421
Schedule a job or jobs at a specific time

Type parameters
- DATA = void
Parameters
- when: string | Date
- names: string[]
Returns Promise<Job<DATA>[]>
- Defined in src/index.ts:422
Type parameters
- DATA = void
Parameters
- when: string | Date
- names: string
Returns Promise<Job<DATA>>
- Defined in src/index.ts:423
Type parameters
- DATA = unknown
Parameters
- when: string | Date
- names: string[]
- data: DATA
Returns Promise<Job<DATA>[]>
- Defined in src/index.ts:428
Type parameters
- DATA = unknown
Parameters
- when: string | Date
- name: string
- data: DATA
Returns Promise<Job<DATA>>

setMaxListeners

setMaxListeners(n: number): this

Inherited from Agenda.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

sort

sort(query: SortOptionObject<IJobParameters>): Agenda

- Defined in src/index.ts:135
Set the sort query for finding next job Default is { nextRunAt: 1, priority: -1 }

Parameters
- query: SortOptionObject<IJobParameters>
Returns Agenda

start

start(): Promise<void>

- Defined in src/index.ts:476
Starts processing jobs using processJobs() methods, storing an interval ID This method will only resolve if a db has been set up beforehand.

Returns Promise<void>

stop

stop(): Promise<void>

- Defined in src/index.ts:500
Clear the interval that processes the jobs

Returns Promise<void>

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from Agenda.listenerCount
- Defined in node_modules/@types/node/events.d.ts:44
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional cb: undefined | ((error?: Error) => void)

Returns Agenda

Properties

Readonly attrs

db

Readonly definitions

Type declaration

[name: string]: IJobDefinition

Private Optional jobProcessor

Readonly ready

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns this

cancel

Parameters

query: FilterQuery<IJobParameters>

Returns Promise<number>

create

Parameters

name: string

Returns Job<void>

Type parameters

DATA = unknown

Parameters

name: string

data: DATA

Returns Job<DATA>

Private createJobs

Type parameters

DATA = unknown

Parameters

names: string[]

createJob: (name: string) => Promise<Job<DATA>>

Parameters

name: string

Returns Promise<Job<DATA>>

Returns Promise<Job<DATA>[]>

database

Parameters

address: string

Optional collection: undefined | string

Optional options: MongoClientOptions

Returns Promise<Agenda>

defaultConcurrency

Parameters

num: number

Returns Agenda

defaultLockLifetime

Parameters

ms: number

Returns Agenda

defaultLockLimit

Parameters

num: number

Returns Agenda

define

Type parameters

DATA = any

Parameters

name: string

processor: (agendaJob: Job<DATA>, done: (error?: Error) => void) => void

Parameters

agendaJob: Job<DATA>

done: (error?: Error) => void