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

Add missed options in documentation #412

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add missed options in documentation #412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ Arguments:

#### Options

- **runOnInit**: run task once after creation;
- **scheduled**: A `boolean` to set if the created task is scheduled. Default `true`;
- **recoverMissedExecutions**: A `boolean` to set if the created task should be able to recover missed executions. Default `false`;
- **timezone**: The timezone that is used for job scheduling. See [IANA time zone database](https://www.iana.org/time-zones) for valid values, such as `Asia/Shanghai`, `Asia/Kolkata`, `America/Sao_Paulo`.
Expand Down
4 changes: 4 additions & 0 deletions src/node-cron.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@ const storage = require('./storage');
* @typedef {Object} CronScheduleOptions
* @prop {boolean} [scheduled] if a scheduled task is ready and running to be
* performed when the time matches the cron expression.
* @prop {string} [name] tasks name to make it easier to identify them in the logs.
* @prop {string} [timezone] the timezone to execute the task in.
* @prop {boolean} [runOnInit] run task once after creation.
* @prop {boolean} [recoverMissedExecutions] if the created task should be able
* to recover missed executions. Default false;
*/

/**
Expand Down