fix!: return empty array from nextDates when called without argument (#…

…519)
kelektiv · Sep 30, 2023 · c2891ba · c2891ba
1 parent 4a406c1
commit c2891ba
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -52,7 +52,7 @@ As goes with semver, breaking backwards compatibility should be explicit in the
 var CronJob = require('cron').CronJob;
 var job = new CronJob(
     '* * * * * *',
-    function() {
+    function () {
         console.log('You will see this message every second');
     },
     null,
@@ -125,6 +125,7 @@ Parameter Based
     - `stop` - Stops your job.
     - `setTime` - Stops and changes the time for the `CronJob`. Param must be a `CronTime`.
     - `lastDate` - Tells you the last execution date.
+    - `nextDate` - Provides the next date that will trigger an `onTick`.
     - `nextDates` - Provides an array of the next set of dates that will trigger an `onTick`.
     - `fireOnTick` - Allows you to override the `onTick` calling behavior. This matters so only do this if you have a really good reason to do so.
     - `addCallback` - Allows you to add `onTick` callbacks.

diff --git a/lib/job.js b/lib/job.js
@@ -106,7 +106,7 @@ function CronJob(CronTime, spawn) {
 	CJ.prototype.fireOnTick = fireOnTick;
 
 	CJ.prototype.nextDates = function (i) {
-		return this.cronTime.sendAt(i);
+		return this.cronTime.sendAt(i || 0);
 	};
 
 	const start = function () {

diff --git a/tests/cron.test.js b/tests/cron.test.js
@@ -1049,32 +1049,44 @@ describe('cron', () => {
 		});
 	});
 
-	it('should give the next date to run at', () => {
-		const callback = jest.fn();
-		const clock = sinon.useFakeTimers();
-		const job = new cron.CronJob('* * * * * *', callback);
-		const d = Date.now();
+	describe('nextDate(s)', () => {
+		it('should give the next date to run at', () => {
+			const callback = jest.fn();
+			const clock = sinon.useFakeTimers();
+			const job = new cron.CronJob('* * * * * *', callback);
+			const d = Date.now();
 
-		expect(job.nextDate().toMillis()).toEqual(d + 1000);
+			expect(job.nextDate().toMillis()).toEqual(d + 1000);
 
-		clock.restore();
-	});
+			clock.restore();
+		});
 
-	it('should give the next dates to run at', () => {
-		const callback = jest.fn();
-		const clock = sinon.useFakeTimers();
-		const job = new cron.CronJob('* * * * * *', callback);
-		const d = Date.now();
+		it('should give the next 5 dates to run at', () => {
+			const callback = jest.fn();
+			const clock = sinon.useFakeTimers();
+			const job = new cron.CronJob('* * * * * *', callback);
+			const d = Date.now();
 
-		expect(job.nextDates(5).map(d => d.toMillis())).toEqual([
-			d + 1000,
-			d + 2000,
-			d + 3000,
-			d + 4000,
-			d + 5000
-		]);
+			expect(job.nextDates(5).map(d => d.toMillis())).toEqual([
+				d + 1000,
+				d + 2000,
+				d + 3000,
+				d + 4000,
+				d + 5000
+			]);
 
-		clock.restore();
+			clock.restore();
+		});
+
+		it('should give an empty array when called without argument', () => {
+			const callback = jest.fn();
+			const clock = sinon.useFakeTimers();
+			const job = new cron.CronJob('* * * * * *', callback);
+
+			expect(job.nextDates()).toHaveLength(0);
+
+			clock.restore();
+		});
 	});
 
 	it('should automatically setup a new timeout if we roll past the max timeout delay', () => {