Class JobDbRepository

Hierarchy

JobDbRepository

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new JobDbRepository(agenda: Agenda, connectOptions: IDatabaseOptions | IMongoOptions & IDbConfig): JobDbRepository

- Defined in src/JobDbRepository.ts:25
Parameters
- agenda: Agenda
- connectOptions: IDatabaseOptions | IMongoOptions & IDbConfig
Returns JobDbRepository

Properties

Private agenda

agenda: Agenda

collection

collection: Collection

Private connectOptions

connectOptions: IDatabaseOptions | IMongoOptions & IDbConfig

Methods

connect

connect(): Promise<void>

- Defined in src/JobDbRepository.ts:164
Returns Promise<void>

Private createConnection

createConnection(): Promise<Db>

- Defined in src/JobDbRepository.ts:34
Returns Promise<Db>

Private database

database(url: string, options?: MongoClientOptions): Promise<Db>

- Defined in src/JobDbRepository.ts:205
Parameters
- url: string
- Optional options: MongoClientOptions
Returns Promise<Db>

getJobs

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

- Defined in src/JobDbRepository.ts:57
Parameters
- query: FilterQuery<IJobParameters>
- Default value sort: SortOptionObject<IJobParameters> = {}
- Default value limit: number = 0
- Default value skip: number = 0
Returns Promise<IJobParameters[]>

getNextJobToRun

getNextJobToRun(jobName: string, nextScanAt: Date, lockDeadline: Date, now?: Date): Promise<IJobParameters | undefined>

- Defined in src/JobDbRepository.ts:110
Parameters
- jobName: string
- nextScanAt: Date
- lockDeadline: Date
- Default value now: Date = new Date()
Returns Promise<IJobParameters | undefined>

getQueueSize

getQueueSize(): Promise<number>

- Defined in src/JobDbRepository.ts:71
Returns Promise<number>

Private hasDatabaseConfig

hasDatabaseConfig(connectOptions: unknown): connectOptions is IDatabaseOptions

- Defined in src/JobDbRepository.ts:53
Parameters
- connectOptions: unknown
Returns connectOptions is IDatabaseOptions

Private hasMongoConnection

hasMongoConnection(connectOptions: unknown): connectOptions is IMongoOptions

- Defined in src/JobDbRepository.ts:49
Parameters
- connectOptions: unknown
Returns connectOptions is IMongoOptions

lockJob

lockJob(job: JobWithId): Promise<IJobParameters | undefined>

- Defined in src/JobDbRepository.ts:86
Parameters
- job: JobWithId
Returns Promise<IJobParameters | undefined>

Private processDbResult

processDbResult<DATA>(job: Job<DATA>, res?: IJobParameters<DATA>): Job<DATA>

- Defined in src/JobDbRepository.ts:221
Type parameters
- DATA = unknown | void
Parameters
- job: Job<DATA>
- Optional res: IJobParameters<DATA>
Returns Job<DATA>

removeJobs

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

- Defined in src/JobDbRepository.ts:66
Parameters
- query: FilterQuery<IJobParameters>
Returns Promise<number>

saveJob

saveJob<DATA>(job: Job<DATA>): Promise<Job<DATA>>

- Defined in src/JobDbRepository.ts:252
Save the properties on a job to MongoDB

name

Agenda#saveJob

function

Type parameters
- DATA = unknown | void
Parameters
- job: Job<DATA>
  
  job to save into MongoDB
Returns Promise<Job<DATA>>

resolves when job is saved or errors

unlockJob

unlockJob(job: Job): Promise<void>

- Defined in src/JobDbRepository.ts:75
Parameters
- job: Job
Returns Promise<void>

unlockJobs

unlockJobs(jobIds: ObjectId[]): Promise<void>

- Defined in src/JobDbRepository.ts:82
Internal method to unlock jobs so that they can be re-run

Parameters
- jobIds: ObjectId[]
Returns Promise<void>

Generated using TypeDoc