@ultirequiem/leap-year 3.0.1 → 3.1.0

package/lib/index.d.ts

@@ -19,4 +19,18 @@ export declare function isLeapYear(year?: Date | string | number, returnValue?:
     year: number;
     result: boolean;
 };
+/**
+ * List every leap year in a range, both ends included.
+ *
+ * @param min - First year to check, defaults to `0`.
+ * @param max - Last year to check, defaults to the current year.
+ *
+ * @example
+ * ```javascript
+ * import { leapYearsInRange } from "@ultirequiem/leap-year";
+ *
+ * leapYearsInRange(2000, 2020); //=> [2000, 2004, 2008, 2012, 2016, 2020]
+ * ```
+ */
+export declare function leapYearsInRange(min?: Date | string | number, max?: Date | string | number): number[];
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AACnE,wBAAgB,UAAU,CACxB,IAAI,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,EAC7B,WAAW,CAAC,EAAE,OAAO,GACpB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AACnE,wBAAgB,UAAU,CACxB,IAAI,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,EAC7B,WAAW,CAAC,EAAE,OAAO,GACpB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,CAAC;AAYrC;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,GAAE,IAAI,GAAG,MAAM,GAAG,MAAU,EAC/B,GAAG,GAAE,IAAI,GAAG,MAAM,GAAG,MAAmB,GACvC,MAAM,EAAE,CAWV"}

package/lib/index.js

@@ -4,3 +4,26 @@ export function isLeapYear(year = new Date(), returnValue = false) {
     const result = (year % 4 === 0 && year % 100 !== 0) || year % 400 === 0;
     return returnValue ? { result, year } : result;
 }
+/**
+ * List every leap year in a range, both ends included.
+ *
+ * @param min - First year to check, defaults to `0`.
+ * @param max - Last year to check, defaults to the current year.
+ *
+ * @example
+ * ```javascript
+ * import { leapYearsInRange } from "@ultirequiem/leap-year";
+ *
+ * leapYearsInRange(2000, 2020); //=> [2000, 2004, 2008, 2012, 2016, 2020]
+ * ```
+ */
+export function leapYearsInRange(min = 0, max = new Date()) {
+    const maxYear = parseDateLike(max);
+    const years = [];
+    for (let year = parseDateLike(min); year <= maxYear; year++) {
+        if (isLeapYear(year)) {
+            years.push(year);
+        }
+    }
+    return years;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ultirequiem/leap-year",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "Check whether a year is a leap year.",
   "type": "module",
   "main": "lib/index.js",

package/readme.md

@@ -1,12 +1,13 @@
 # leap-year
 
-Check if a year is a [leap year](https://en.wikipedia.org/wiki/Leap_year),
+Check whether a year is a leap year.
 
 [![npm](https://img.shields.io/npm/v/@ultirequiem/leap-year?logo=npm&color=cb3837)](https://www.npmjs.com/package/@ultirequiem/leap-year)
 [![npm downloads](https://img.shields.io/npm/dm/@ultirequiem/leap-year?color=cb3837)](https://www.npmjs.com/package/@ultirequiem/leap-year)
 [![CI](https://github.com/UltiRequiem/leap-year/actions/workflows/ci.yaml/badge.svg)](https://github.com/UltiRequiem/leap-year/actions/workflows/ci.yaml)
 [![codecov](https://codecov.io/gh/UltiRequiem/leap-year/graph/badge.svg)](https://codecov.io/gh/UltiRequiem/leap-year)
 
+Check if a year is a [leap year](https://en.wikipedia.org/wiki/Leap_year),
 that's a calendar year that contains an additional day added to keep the
 calendar year synchronized with the astronomical year or seasonal year.
 
@@ -25,16 +26,13 @@ isLeapYear(new Date(2016, 1, 1)); //=> true
 isLeapYear("13 December 400 00:07:00 GMT", true); //=> { year: 400, result: true }
 ```
 
-## Related
-
-- [leap_year_utils](https://github.com/UltiRequiem/leap_year_utils): Utilities
-  around this package.
+List the leap years in a range (both ends included):
 
-- [parse_datelike](https://github.com/UltiRequiem/parse_datelike): Parse a
-  number/string/date to a number/string/date.
+```javascript
+import { leapYearsInRange } from "@ultirequiem/leap-year";
 
-- [leap-year-api](https://github.com/UltiRequiem/leap-year-api): A REST API to
-  know if a year is leap or not.
+leapYearsInRange(2000, 2020); //=> [2000, 2004, 2008, 2012, 2016, 2020]
+```
 
 ## Support