Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(readme): update nextDates documentation #702

Merged
merged 2 commits into from
Oct 12, 2023
Merged

docs(readme): update nextDates documentation #702

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5598a7c
docs(readme): update nextDates documentation
sheerlox Sep 30, 2023
4df9d71
docs(readme): fix typos
sheerlox Oct 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ For day-of-week indexing, we only added support for `7` as Sunday, so you don't

- **constructor no longer accepts an object as its first and only params. Use `CronJob.from(argsObject)` instead.**
- **callbacks are now called in the order they were registered.**
- **`nextDates(count?: number)` now always returns an array (empty if no argument is provided). Use `nextDate()` instead for a single date.**

### Removed methods

Expand Down Expand Up @@ -131,7 +132,8 @@ Parameter Based
- `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`.
- `nextDates(count)` - Provides an array of the next set of dates that will trigger an `onTick`.
- `count` - [OPTIONAL] - The number of next dates to return. Defaults to 0, returning an empty array.
- `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. Callbacks are run in the order they are registered.
- `CronTime`
Expand Down