Permalink
Browse files

Fix JSDoc for .every: data & options are optional params (#761)

* Fix JSDoc for .every: data & options are optional params

* Be more specific about the type of `names`
  • Loading branch information...
dandv committed Feb 5, 2019
1 parent e1bf9c9 commit 159496f90c20debeee85465a84be1c04d66b61b7
Showing with 4 additions and 4 deletions.
  1. +4 −4 lib/agenda/every.js
@@ -5,10 +5,10 @@ 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
* @param {String|Number} interval - run every X interval
* @param {String|Array<String>} 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) {

0 comments on commit 159496f

Please sign in to comment.