cron-converter-u2q v1.1.0

cron-converter-u2q

Easily work with cron expressions using the cron-converter-u2q package. Effortlessly convert between Unix and Quartz formats and describe cron schedules in plain language for better understanding and usability.

Features

:arrows_counterclockwise: Two-way conversion

Effortlessly convert cron expressions:

• From Unix to Quartz
• From Quartz to Unix

:memo: Human-readable Descriptions

Translate cron schedules into plain, understandable text:

• Example: */5 * * * * -> "Every 5 minutes"

Installation

Using npm:

npm install cron-converter-u2q

Using yarn:

yarn add cron-converter-u2q

Usage

Firstly, import the CronConverterU2Q module:

var cron_converter_u2q = require("cron-converter-u2q");

var c2q = cron_converter_u2q.CronConverterU2Q;

If you're using ES6 Modules

import { CronConverterU2QModule as c2q } from "cron-converter-u2q";

Conversion Methods

Convert from Unix to Quartz:

const quartzExpression = c2q.unixToQuartz("5 * * * *");

Convert from Quartz to Unix:

const unixExpression = c2q.quartzToUnix("* */5 * ? * * *");

Description Methods

You can now generate human-readable descriptions for Unix and Quartz cron expressions.

Describe Unix Cron Expressions:

const description = c2q.describeUnix("5 * * * *");
console.log(description); // Outputs: "Every 5 minutes"

Describe Quartz Cron Expressions:

const description = c2q.describeQuartz("0 0 8 * * ?");
console.log(description); // Outputs: "At 8 o'clock"

Contribution Guide

1. Fork the repository.
2. Create a feature branch:

git checkout -b feature/xxxx

3. Commit changes:
4. Push the branch:
5. Open a Pull Request.

Development Notice

Any feedback, suggestions, or contributions are highly appreciated!

License

This project is licensed under the MIT License