'use strict';
const debug = require('debug')('agenda:every');
/**
* Creates a scheduled job with given interval and name/names of the job to run
* @name Agenda#every
* @function
* @param {Number} interval run every X interval
* @param {*} names String or strings of jobs to schedule
* @param {Object} data data to run for job
* @param {Object} options options to run job for
* @returns {Promise} Job/s created. Resolves when schedule fails or passes
*/
module.exports = async function(interval, names, data, options) {
/**
* Internal method to setup job that gets run every interval
* @param {Number} interval run every X interval
* @param {String} name String job to schedule
* @param {Object} data data to run for job
* @param {Object} options options to run job for
* @returns {Job} instance of job
*/
const createJob = async (interval, name, data, options) => {
const job = this.create(name, data);
job.attrs.type = 'single';
job.repeatEvery(interval, options);
job.computeNextRunAt();
await job.save();
return job;
};
/**
* Internal helper method that uses createJob to create jobs for an array of names
* @param {Number} interval run every X interval
* @param {Array<String>} names Strings of jobs to schedule
* @param {Object} data data to run for job
* @param {Object} options options to run job for
* @returns {Array<Job>} array of jobs created
*/
const createJobs = (interval, names, data, options) => {
try {
const jobs = names.map(name => createJob(interval, name, data, options));
debug('every() -> all jobs created successfully');
return Promise.all(jobs);
} catch (err) { // @TODO: catch - ignore :O
debug('every() -> error creating one or more of the jobs');
}
};
if (typeof names === 'string' || names instanceof String) {
debug('Agenda.every(%s, %O, %O)', interval, names, options);
const jobs = await createJob(interval, names, data, options);
return jobs;
} else if (Array.isArray(names)) {
debug('Agenda.every(%s, %s, %O)', interval, names, options);
const jobs = await createJobs(interval, names, data, options);
return jobs;
}
};