@ultirequiem/leap-year 2.0.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2022 Eliaz Bobadilla  <eliaz.bobadilla@gmail.com> (https://ultirequiem.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,70 @@
+# 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/branch/main/graph/badge.svg)](https://codecov.io/gh/ultirequiem/leap-year)
+[![deno doc](https://doc.deno.land/badge.svg)](https://doc.deno.land/https/deno.land/x/leap_year/mod.ts)
+
+![Custom badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fdeno-visualizer.danopia.net%2Fshields%2Fdep-count%2Fx%2Fleap_year%2Fmod.ts)
+![Custom badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fdeno-visualizer.danopia.net%2Fshields%2Fupdates%2Fx%2Fleap_year%2Fmod.ts)
+[![Custom badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fdeno-visualizer.danopia.net%2Fshields%2Flatest-version%2Fx%2Fleap_year%2Fmod.ts)](https://deno.land/x/leap_year)
+
+Check if a year is a [leap year](https://en.wikipedia.org/wiki/Leap_year).
+
+## Usage
+
+### [Deno 🚀](https://deno.land/x/leap_year)
+
+```javascript
+import { isLeapYear } from "https://deno.land/x/leap_year/mod.ts";
+
+isLeapYear(2014); //=> false
+isLeapYear(2016); //=> true
+isLeapYear("6 October 2006 00:07:00 GMT"); //=> false
+isLeapYear("2000"); //=> false
+isLeapYear(new Date(2016, 1, 1)); //=> true
+```
+
+### [Node.js 🐢](https://www.npmjs.com/package/@ultirequiem/leap-year)
+
+```typescript
+import { isLeapYear } from "@ultirequiem/leap-year";
+```
+
+### [Browser 🕸](https://developer.mozilla.org/en-US/docs/Glossary/Browser)
+
+You can use any [CDN](https://en.wikipedia.org/wiki/Content_delivery_network)
+that you like.
+
+As an example, for
+[type module](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules)
+👇
+
+- [SkyPack](https://cdn.skypack.dev/@ultirequiem/leap-year)
+
+Or for a plain
+[script tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script) 🦔
+
+- [jsdelivr](https://cdn.jsdelivr.net/npm/@ultirequiem/leap-year)
+
+The API is the same on all this platforms.
+
+## API
+
+[Autogenerated Documentation](https://doc.deno.land/https://deno.land/x/leap_year/mod.ts)
+🚀
+
+## Support
+
+Open an Issue, I will check it a soon as possible 👀
+
+If you want to hurry me up a bit
+[send me a tweet](https://twitter.com/intent/tweet?text=%40UltiRequiem%20) 😆
+
+Consider [supporting me on Patreon](https://patreon.com/UltiRequiem) if you like
+my work 🚀
+
+Don't forget to start the repo ⭐
+
+## Licence
+
+Licensed under the MIT License.

package/esm/mod.js

@@ -0,0 +1,40 @@
+/**
+ * Check if a year is a [leap year](https://en.wikipedia.org/wiki/Leap_year).
+ *
+ * @param year - Default: `new Date()`.
+ *
+ * @example
+ * ```javascript
+ * import { isLeapYear } from "https://deno.land/x/leap_year/mod.ts";
+ *
+ * isLeapYear(2014); //=> false
+ * isLeapYear(2016); //=> true
+ * isLeapYear("6 October 2006 00:07:00 GMT") //=> false
+ * isLeapYear("200"); //=> false
+ * isLeapYear(new Date(2016, 1, 1)); //=> true
+ * ```
+ */
+export function isLeapYear(year = new Date()) {
+    year = internalParse(year);
+    return (year % 4 === 0 && year % 100 !== 0) ?? year % 400 === 0;
+}
+export function generateLeapYear(config) {
+    const { min = 0, max = new Date() } = config;
+    const maxYear = internalParse(max);
+    const leapYears = [];
+    for (let year = min; year <= maxYear; year++) {
+        if (isLeapYear(year)) {
+            leapYears.push(year);
+        }
+    }
+    return leapYears;
+}
+function internalParse(date) {
+    if (typeof date === "string") {
+        date = new Date(date);
+    }
+    if (!(date instanceof Date) && typeof date !== "number") {
+        throw new TypeError(`Expected "year" type to be "Date" | "number" | "string" and got ${typeof date}.`);
+    }
+    return date instanceof Date ? date.getUTCFullYear() : date;
+}

package/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "module": "./esm/mod.js",
+  "main": "./script/mod.js",
+  "types": "./types/mod.d.ts",
+  "name": "@ultirequiem/leap-year",
+  "description": "Check if a year is leap.",
+  "version": "2.0.0",
+  "license": "MIT",
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/ultirequiem"
+  },
+  "repository": "github:ultirequiem/@ultirequiem/leap-year",
+  "homepage": "https://leap-year.js.org",
+  "bugs": {
+    "url": "https://github.com/ultirequiem/@ultirequiem/leap-year/issues",
+    "email": "eliaz.bobadilladev@gmail.com"
+  },
+  "keywords": [
+    "leap",
+    "year",
+    "date"
+  ],
+  "exports": {
+    ".": {
+      "import": "./esm/mod.js",
+      "require": "./script/mod.js",
+      "types": "./types/mod.d.ts"
+    }
+  },
+  "scripts": {
+    "test": "node test_runner.js"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@types/node": "16.11.26",
+    "chalk": "4.1.2",
+    "@deno/shim-deno": "~0.4.3"
+  }
+}

package/script/mod.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateLeapYear = exports.isLeapYear = void 0;
+/**
+ * Check if a year is a [leap year](https://en.wikipedia.org/wiki/Leap_year).
+ *
+ * @param year - Default: `new Date()`.
+ *
+ * @example
+ * ```javascript
+ * import { isLeapYear } from "https://deno.land/x/leap_year/mod.ts";
+ *
+ * isLeapYear(2014); //=> false
+ * isLeapYear(2016); //=> true
+ * isLeapYear("6 October 2006 00:07:00 GMT") //=> false
+ * isLeapYear("200"); //=> false
+ * isLeapYear(new Date(2016, 1, 1)); //=> true
+ * ```
+ */
+function isLeapYear(year = new Date()) {
+    year = internalParse(year);
+    return (year % 4 === 0 && year % 100 !== 0) ?? year % 400 === 0;
+}
+exports.isLeapYear = isLeapYear;
+function generateLeapYear(config) {
+    const { min = 0, max = new Date() } = config;
+    const maxYear = internalParse(max);
+    const leapYears = [];
+    for (let year = min; year <= maxYear; year++) {
+        if (isLeapYear(year)) {
+            leapYears.push(year);
+        }
+    }
+    return leapYears;
+}
+exports.generateLeapYear = generateLeapYear;
+function internalParse(date) {
+    if (typeof date === "string") {
+        date = new Date(date);
+    }
+    if (!(date instanceof Date) && typeof date !== "number") {
+        throw new TypeError(`Expected "year" type to be "Date" | "number" | "string" and got ${typeof date}.`);
+    }
+    return date instanceof Date ? date.getUTCFullYear() : date;
+}

package/script/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/types/mod.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Check if a year is a [leap year](https://en.wikipedia.org/wiki/Leap_year).
+ *
+ * @param year - Default: `new Date()`.
+ *
+ * @example
+ * ```javascript
+ * import { isLeapYear } from "https://deno.land/x/leap_year/mod.ts";
+ *
+ * isLeapYear(2014); //=> false
+ * isLeapYear(2016); //=> true
+ * isLeapYear("6 October 2006 00:07:00 GMT") //=> false
+ * isLeapYear("200"); //=> false
+ * isLeapYear(new Date(2016, 1, 1)); //=> true
+ * ```
+ */
+export declare function isLeapYear(year?: DateLike): boolean;
+export declare function generateLeapYear(config: {
+    min?: number;
+    max?: DateLike;
+}): number[];
+export declare type DateLike = Date | number | string;