@aquarela/time-to-cron is a utility library designed to convert time intervals into cron expressions. This package is particularly useful for developers looking to schedule tasks in environments that require cron syntax, providing a simple interface to generate accurate cron schedules.
Install the package using npm:
npm install @aquarela/time-to-cronYou can also use it directly in the browser via jsDelivr:
<!-- Latest version -->
<script src="https://cdn.jsdelivr.net/npm/@aquarela/time-to-cron"></script>
<!-- Specific version -->
<script src="https://cdn.jsdelivr.net/npm/@aquarela/time-to-cron@2.1.1"></script>
<!-- ES Module version -->
<script type="module">
import { timeToCron } from "https://cdn.jsdelivr.net/npm/@aquarela/time-to-cron/dist/index.esm.js";
</script>When using via jsDelivr in the browser with a script tag, the function is available globally as timeToCron.
Use the timeToCron function to convert time values into cron expressions. Below are some examples of how to utilize this function effectively.
First, import the timeToCron function:
import { timeToCron } from "@aquarela/time-to-cron";Convert a number of seconds to a cron expression. The value can be less than 60 or a multiple of 60.
const cronExpression = timeToCron(30);
console.log(cronExpression); // "*/30 * * * * *"Convert a number of minutes to a cron expression. The value can be less than 60 or a multiple of 60.
const cronExpression = timeToCron(15, "minutes");
console.log(cronExpression); // "0 */15 * * * *"Convert a number of hours to a cron expression. The value must be less than 24 or a multiple of 24.
const cronExpression = timeToCron(4, "hours");
console.log(cronExpression); // "0 0 */4 * * *"Convert a number of days to a cron expression. The value is the number of days between executions.
const cronExpression = timeToCron(2, "days");
console.log(cronExpression); // "0 0 0 */2 * *"You can also use predefined schedule expressions for common time patterns:
// Common time intervals
timeToCron("@hourly"); // "0 0 * * * *"
timeToCron("@daily"); // "0 0 0 * * *"
timeToCron("@weekly"); // "0 0 0 * * 0"
timeToCron("@monthly"); // "0 0 0 1 * *"
timeToCron("@yearly"); // "0 0 0 1 1 *"
// Additional schedules
timeToCron("@midnight"); // "0 0 0 * * *" (same as @daily)
timeToCron("@annually"); // "0 0 0 1 1 *" (same as @yearly)
timeToCron("@every12hours"); // "0 0 0/12 * * *"
timeToCron("@biweekly"); // "0 0 0 * * 0/2"Converts a time value or predefined schedule to a cron expression.
- value: Either a numeric time value or a predefined schedule string. When using a number, it must be a positive integer. When using a predefined schedule, it must be one of the supported schedule expressions.
- unit: The unit of the time value (only used when
valueis a number). Can be"seconds","minutes","hours", or"days". Default is"seconds".
Supported predefined schedules:
@yearlyor@annually: Run once a year at midnight of January 1@monthly: Run once a month at midnight of the first day@weekly: Run once a week at midnight on Sunday@dailyor@midnight: Run once a day at midnight@hourly: Run once an hour at the beginning of the hour@every12hours: Run every 12 hours@biweekly: Run every two weeks
Returns the corresponding cron expression as a string.
Throws an error if the value is not a positive integer, does not meet the unit constraints (such as being a multiple of 60 for minutes), or if an invalid time unit is provided.
- Seconds: Must be less than 60 or a multiple of 60.
- Minutes: Must be less than 60 or a multiple of 60.
- Hours: Must be less than 24 or a multiple of 24.
- Days: Any positive integer value is valid.
To run the tests, execute the following command:
npm testWe welcome contributions! Please follow these steps:
- Fork the repository.
- Create a feature branch.
- Add your changes.
- Run
npm testto ensure all tests pass. - Submit a pull request.
For more information and to contribute, visit the GitHub repository.
This project is licensed under the MIT License. See the LICENSE file for details.
Diego Peixoto - @diegopeixoto on GitHub