cronstrue 3.13.0 → 3.18.0

package/README.md

@@ -105,18 +105,8 @@ By default, only the English translation (`en`) is included when you import and
 ### CLI Usage
 
 ```sh
-$ npm install -g cronstrue
-
-$ cronstrue 1 2 3 4 5
-At 02:01 AM, on day 3 of the month, and on Friday, only in April
-
-$ cronstrue 1 2 3
-Error: too few arguments (3): 1 2 3
-Usage (5 args): cronstrue minute hour day-of-month month day-of-week
-or
-Usage (6 args): cronstrue second minute hour day-of-month month day-of-week
-or
-Usage (7 args): cronstrue second minute hour day-of-month month day-of-week year
+❯ npx cronstrue "*/5 * * * *"
+Every 5 minutes
 ```
 
 ## Options
@@ -128,6 +118,7 @@ An options object can be passed as the second parameter to `cronstrue.toString`.
 - **dayOfWeekStartIndexZero: boolean** - Whether to interpret cron expression DOW `1` as Sunday or Monday. (Default: true)
 - **monthStartIndexZero: boolean** - Whether to interpret January as `0` or `1`. (Default: false)
 - **use24HourTimeFormat: boolean** - If true, descriptions will use a [24-hour clock](https://en.wikipedia.org/wiki/24-hour_clock) (Default: false but some translations will default to true)
+- **trimHoursLeadingZero: boolean** - Whether to trim the leading zero that may appear in the hours description; e.g. "02:00 AM" -> "2:00 AM", "08:00" -> "8:00" (Default: false)
 - **locale: string** - The locale to use (Default: "en")
 - **logicalAndDayFields: boolean** - If true, descriptions for cron expressions with both day of month and day of week specified will follow a logical-AND wording rather than logical-OR wording; e.g. "...between day 11 and 17 of the month, only on Friday" rather than "...between day 11 and 17 of the month, and on Friday" (Default: false)
 
@@ -227,25 +218,36 @@ The following locales can be passed in for the `locale` option.  Thank you to th
 
     This library does not do full validation of cron expressions and assumes the expression passed in is valid. If you need to validate an expression consider using a library like [cron-parser](https://www.npmjs.com/package/cron-parser).  Example validation with cron-parser:
 
-   ```
-   const cronParser = require("cron-parser");
-   const cronstrue = require("cronstrue");
+   ```javascript
+   import { CronExpressionParser } from "cron-parser";
+   import cronstrue from "cronstrue";
 
    const expression = "* * * * * *";
 
-   // Validate expression first
-   let isCronValid = true;
-   try { cronParser.parseExpression(expression) } catch(e) { isCronValid = false; }
+   const isCronValid = (() => {
+     try {
+       CronExpressionParser.parse(expression);
+       return true;
+     } catch {
+       return false;
+     }
+   })();
 
-   // If valid, then pass into cRonstrue
    if (isCronValid) {
-     console.log(cronstrue.toString("* * * * *"));
+     console.log(cronstrue.toString(expression));
    }
    ```
 
 2. Can cRonstrue output the next occurrence of the cron expression?
 
-    No, cRonstrue does not support this.  This library simply describes a cron expression that is passed in.
+    No, cRonstrue does not support this.  This library simply describes a cron expression that is passed in.  You can do with with a library like [croner](https://www.npmjs.com/package/croner).  Example:
+
+   ```javascript
+   import { Cron } from 'croner';
+   const job = new Cron('0 9 * * 1-5');
+   console.log(job.nextRun());      // next Date
+   console.log(job.nextRuns(5));    // next 5 Dates
+   ```
 
 ## Sponsors
 

package/dist/cronstrue-i18n.js

@@ -287,13 +287,14 @@ var ExpressionDescriptor = (function () {
         }
     }
     ExpressionDescriptor.toString = function (expression, _a) {
-        var _b = _a === void 0 ? {} : _a, _c = _b.throwExceptionOnParseError, throwExceptionOnParseError = _c === void 0 ? true : _c, _d = _b.verbose, verbose = _d === void 0 ? false : _d, _e = _b.dayOfWeekStartIndexZero, dayOfWeekStartIndexZero = _e === void 0 ? true : _e, _f = _b.monthStartIndexZero, monthStartIndexZero = _f === void 0 ? false : _f, use24HourTimeFormat = _b.use24HourTimeFormat, _g = _b.locale, locale = _g === void 0 ? null : _g, _h = _b.logicalAndDayFields, logicalAndDayFields = _h === void 0 ? false : _h;
+        var _b = _a === void 0 ? {} : _a, _c = _b.throwExceptionOnParseError, throwExceptionOnParseError = _c === void 0 ? true : _c, _d = _b.verbose, verbose = _d === void 0 ? false : _d, _e = _b.dayOfWeekStartIndexZero, dayOfWeekStartIndexZero = _e === void 0 ? true : _e, _f = _b.monthStartIndexZero, monthStartIndexZero = _f === void 0 ? false : _f, use24HourTimeFormat = _b.use24HourTimeFormat, _g = _b.trimHoursLeadingZero, trimHoursLeadingZero = _g === void 0 ? false : _g, _h = _b.locale, locale = _h === void 0 ? null : _h, _j = _b.logicalAndDayFields, logicalAndDayFields = _j === void 0 ? false : _j;
         var options = {
             throwExceptionOnParseError: throwExceptionOnParseError,
             verbose: verbose,
             dayOfWeekStartIndexZero: dayOfWeekStartIndexZero,
             monthStartIndexZero: monthStartIndexZero,
             use24HourTimeFormat: use24HourTimeFormat,
+            trimHoursLeadingZero: trimHoursLeadingZero,
             locale: locale,
             logicalAndDayFields: logicalAndDayFields,
         };
@@ -363,7 +364,9 @@ var ExpressionDescriptor = (function () {
             var hourParts = hourExpression.split(",");
             description += this.i18n.at();
             for (var i = 0; i < hourParts.length; i++) {
-                description += " ";
+                if (description) {
+                    description += " ";
+                }
                 description += this.formatTime(hourParts[i], minuteExpression, "");
                 if (i < hourParts.length - 2) {
                     description += ",";
@@ -651,6 +654,7 @@ var ExpressionDescriptor = (function () {
         else if (doesExpressionContainMultipleValues) {
             var segments = expression.split(",");
             var descriptionContent = "";
+            var conjunction = this.i18n.spaceAnd();
             for (var i = 0; i < segments.length; i++) {
                 if (i > 0 && segments.length > 2) {
                     descriptionContent += ",";
@@ -659,7 +663,7 @@ var ExpressionDescriptor = (function () {
                     }
                 }
                 if (i > 0 && segments.length > 1 && (i == segments.length - 1 || segments.length == 2)) {
-                    descriptionContent += "".concat(this.i18n.spaceAnd(), " ");
+                    descriptionContent += conjunction == "," && segments.length > 2 ? " " : "".concat(conjunction, " ");
                 }
                 if (segments[i].indexOf("/") > -1 || segments[i].indexOf("-") > -1) {
                     var isSegmentRangeWithoutIncrement = segments[i].indexOf("-") > -1 && segments[i].indexOf("/") == -1;
@@ -752,7 +756,12 @@ var ExpressionDescriptor = (function () {
         if (secondExpression) {
             second = ":".concat(("00" + secondExpression).substring(secondExpression.length));
         }
-        return "".concat(setPeriodBeforeTime ? period : "").concat(("00" + hour.toString()).substring(hour.toString().length), ":").concat(("00" + minute.toString()).substring(minute.toString().length)).concat(second).concat(!setPeriodBeforeTime ? period : "");
+        var hourStr = hour.toString();
+        var paddedHour = ("00" + hourStr).substring(hourStr.length);
+        var minuteStr = minute.toString();
+        var paddedMinute = ("00" + minuteStr).substring(minuteStr.length);
+        var displayHour = this.options.trimHoursLeadingZero ? hourStr : paddedHour;
+        return "".concat(setPeriodBeforeTime ? period : "").concat(displayHour, ":").concat(paddedMinute).concat(second).concat(!setPeriodBeforeTime ? period : "");
     };
     ExpressionDescriptor.prototype.transformVerbosity = function (description, useVerboseFormat) {
         if (!useVerboseFormat) {
@@ -785,7 +794,7 @@ exports.ExpressionDescriptor = ExpressionDescriptor;
 
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.sr = exports.hr = exports.bg = exports.my = exports.vi = exports.ar = exports.th = exports.af = exports.hu = exports.be = exports.ca = exports.fa = exports.sw = exports.sl = exports.fi = exports.sk = exports.cs = exports.he = exports.ja = exports.zh_TW = exports.zh_CN = exports.uk = exports.tr = exports.ru = exports.ro = exports.pt_PT = exports.pt_BR = exports.pl = exports.sv = exports.nb = exports.nl = exports.ko = exports.id = exports.it = exports.fr = exports.es = exports.de = exports.da = exports.en = void 0;
+exports.sr = exports.hr = exports.bg = exports.my = exports.vi = exports.ar = exports.th = exports.af = exports.hu = exports.be = exports.ca = exports.fa = exports.sw = exports.sl = exports.fi = exports.sk = exports.cs = exports.he = exports.ja = exports.zh_TW = exports.zh_CN = exports.uk = exports.tr = exports.ru = exports.ro = exports.pt_PT = exports.pt_BR = exports.pl = exports.sv = exports.nn = exports.nb = exports.nl = exports.ko = exports.id = exports.it = exports.fr = exports.es = exports.de = exports.da = exports.en = void 0;
 var en_1 = __webpack_require__(486);
 Object.defineProperty(exports, "en", ({ enumerable: true, get: function () { return en_1.en; } }));
 var da_1 = __webpack_require__(506);
@@ -806,6 +815,8 @@ var nl_1 = __webpack_require__(647);
 Object.defineProperty(exports, "nl", ({ enumerable: true, get: function () { return nl_1.nl; } }));
 var nb_1 = __webpack_require__(957);
 Object.defineProperty(exports, "nb", ({ enumerable: true, get: function () { return nb_1.nb; } }));
+var nn_1 = __webpack_require__(633);
+Object.defineProperty(exports, "nn", ({ enumerable: true, get: function () { return nn_1.nn; } }));
 var sv_1 = __webpack_require__(544);
 Object.defineProperty(exports, "sv", ({ enumerable: true, get: function () { return sv_1.sv; } }));
 var pl_1 = __webpack_require__(905);
@@ -4541,16 +4552,16 @@ var ko = (function () {
         return "1시간마다";
     };
     ko.prototype.atSpace = function () {
-        return "시간 ";
+        return "";
     };
     ko.prototype.everyMinuteBetweenX0AndX1 = function () {
         return "매분 %s~%s";
     };
     ko.prototype.at = function () {
-        return "시간";
+        return "";
     };
     ko.prototype.spaceAnd = function () {
-        return " 및";
+        return ",";
     };
     ko.prototype.everySecond = function () {
         return "1초마다";
@@ -4577,7 +4588,7 @@ var ko = (function () {
         return "%s시간마다";
     };
     ko.prototype.betweenX0AndX1 = function () {
-        return "%s에서 %s 사이";
+        return "%s부터 %s까지";
     };
     ko.prototype.atX0 = function () {
         return "%s에서";
@@ -4589,10 +4600,10 @@ var ko = (function () {
         return ", 주 중 %s일마다";
     };
     ko.prototype.commaX0ThroughX1 = function () {
-        return ", %s에서 %s까지";
+        return ", %s부터 %s까지";
     };
     ko.prototype.commaAndX0ThroughX1 = function () {
-        return ", 및 %s에서 %s까지";
+        return ", %s부터 %s까지";
     };
     ko.prototype.first = function () {
         return "첫 번째";
@@ -4625,7 +4636,7 @@ var ko = (function () {
         return ", %s에만";
     };
     ko.prototype.commaAndOnX0 = function () {
-        return ", 및 %s에";
+        return ", %s에";
     };
     ko.prototype.commaEveryX0Months = function () {
         return ", %s개월마다";
@@ -5253,6 +5264,194 @@ var nl = (function () {
 exports.nl = nl;
 
 
+/***/ },
+
+/***/ 633
+(__unused_webpack_module, exports) {
+
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.nn = void 0;
+var nn = (function () {
+    function nn() {
+    }
+    nn.prototype.atX0SecondsPastTheMinuteGt20 = function () {
+        return null;
+    };
+    nn.prototype.atX0MinutesPastTheHourGt20 = function () {
+        return null;
+    };
+    nn.prototype.commaMonthX0ThroughMonthX1 = function () {
+        return null;
+    };
+    nn.prototype.commaYearX0ThroughYearX1 = function () {
+        return null;
+    };
+    nn.prototype.use24HourTimeFormatByDefault = function () {
+        return true;
+    };
+    nn.prototype.anErrorOccuredWhenGeneratingTheExpressionD = function () {
+        return "Ein feil oppstod ved generering av uttrykksskildring. Sjekk cron-syntaksen.";
+    };
+    nn.prototype.at = function () {
+        return "Kl.";
+    };
+    nn.prototype.atSpace = function () {
+        return "Kl.";
+    };
+    nn.prototype.atX0 = function () {
+        return "på %s";
+    };
+    nn.prototype.atX0MinutesPastTheHour = function () {
+        return "på %s minutt etter timen";
+    };
+    nn.prototype.atX0SecondsPastTheMinute = function () {
+        return "på %s sekund etter minuttet";
+    };
+    nn.prototype.betweenX0AndX1 = function () {
+        return "mellom %s og %s";
+    };
+    nn.prototype.commaBetweenDayX0AndX1OfTheMonth = function () {
+        return ", mellom dag %s og %s av månaden";
+    };
+    nn.prototype.commaEveryDay = function () {
+        return ", kvar dag";
+    };
+    nn.prototype.commaEveryX0Days = function () {
+        return ", kvar %s dag";
+    };
+    nn.prototype.commaEveryX0DaysOfTheWeek = function () {
+        return ", kvar %s vekedag";
+    };
+    nn.prototype.commaEveryX0Months = function () {
+        return ", kvar %s månad";
+    };
+    nn.prototype.commaEveryX0Years = function () {
+        return ", kvart %s år";
+    };
+    nn.prototype.commaOnDayX0OfTheMonth = function () {
+        return ", på dag %s av månaden";
+    };
+    nn.prototype.commaOnlyInX0 = function () {
+        return ", berre i %s";
+    };
+    nn.prototype.commaOnlyOnX0 = function () {
+        return ", på %s";
+    };
+    nn.prototype.commaAndOnX0 = function () {
+        return ", og på %s";
+    };
+    nn.prototype.commaOnThe = function () {
+        return ", på ";
+    };
+    nn.prototype.commaOnTheLastDayOfTheMonth = function () {
+        return ", på den siste dagen i månaden";
+    };
+    nn.prototype.commaOnTheLastWeekdayOfTheMonth = function () {
+        return ", den siste vekedagen i månaden";
+    };
+    nn.prototype.commaDaysBeforeTheLastDayOfTheMonth = function () {
+        return ", %s dagar før den siste dagen i månaden";
+    };
+    nn.prototype.commaOnTheLastX0OfTheMonth = function () {
+        return ", på den siste %s av månaden";
+    };
+    nn.prototype.commaOnTheX0OfTheMonth = function () {
+        return ", på den %s av månaden";
+    };
+    nn.prototype.commaX0ThroughX1 = function () {
+        return ", %s til og med %s";
+    };
+    nn.prototype.commaAndX0ThroughX1 = function () {
+        return ", og %s til og med %s";
+    };
+    nn.prototype.everyHour = function () {
+        return "kvar time";
+    };
+    nn.prototype.everyMinute = function () {
+        return "kvart minutt";
+    };
+    nn.prototype.everyMinuteBetweenX0AndX1 = function () {
+        return "Kvart minutt mellom %s og %s";
+    };
+    nn.prototype.everySecond = function () {
+        return "kvart sekund";
+    };
+    nn.prototype.everyX0Hours = function () {
+        return "kvar %s time";
+    };
+    nn.prototype.everyX0Minutes = function () {
+        return "kvart %s minutt";
+    };
+    nn.prototype.everyX0Seconds = function () {
+        return "kvart %s sekund";
+    };
+    nn.prototype.fifth = function () {
+        return "femte";
+    };
+    nn.prototype.first = function () {
+        return "første";
+    };
+    nn.prototype.firstWeekday = function () {
+        return "første vekedag";
+    };
+    nn.prototype.fourth = function () {
+        return "fjerde";
+    };
+    nn.prototype.minutesX0ThroughX1PastTheHour = function () {
+        return "minutta frå %s til og med %s etter timen";
+    };
+    nn.prototype.second = function () {
+        return "andre";
+    };
+    nn.prototype.secondsX0ThroughX1PastTheMinute = function () {
+        return "sekunda frå %s til og med %s etter minuttet";
+    };
+    nn.prototype.spaceAnd = function () {
+        return " og";
+    };
+    nn.prototype.spaceX0OfTheMonth = function () {
+        return " %s i månaden";
+    };
+    nn.prototype.lastDay = function () {
+        return "den siste dagen";
+    };
+    nn.prototype.third = function () {
+        return "tredje";
+    };
+    nn.prototype.weekdayNearestDayX0 = function () {
+        return "vekedag nærmast dag %s";
+    };
+    nn.prototype.commaStartingX0 = function () {
+        return ", startar %s";
+    };
+    nn.prototype.daysOfTheWeek = function () {
+        return ["sundag", "måndag", "tysdag", "onsdag", "torsdag", "fredag", "laurdag"];
+    };
+    nn.prototype.monthsOfTheYear = function () {
+        return [
+            "januar",
+            "februar",
+            "mars",
+            "april",
+            "mai",
+            "juni",
+            "juli",
+            "august",
+            "september",
+            "oktober",
+            "november",
+            "desember",
+        ];
+    };
+    nn.prototype.onTheHour = function () {
+        return "på timen";
+    };
+    return nn;
+}());
+exports.nn = nn;
+
+
 /***/ },
 
 /***/ 905