@ultirequiem/six 0.0.0 → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+# 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,97 @@
+# six
+
+[![CI](https://github.com/UltiRequiem/six/actions/workflows/ci.yaml/badge.svg)](https://github.com/UltiRequiem/six/actions/workflows/ci.yaml)
+[![codecov](https://codecov.io/gh/ultirequiem/six/branch/main/graph/badge.svg)](https://codecov.io/gh/ultirequiem/six)
+[![deno doc](https://doc.deno.land/badge.svg)](https://doc.deno.land/https/deno.land/x/six/mod.ts)
+
+![Custom badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fdeno-visualizer.danopia.net%2Fshields%2Fdep-count%2Fx%2Fsix%2Fmod.ts)
+![Custom badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fdeno-visualizer.danopia.net%2Fshields%2Fupdates%2Fx%2Fsix%2Fmod.ts)
+[![Custom badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fdeno-visualizer.danopia.net%2Fshields%2Flatest-version%2Fx%2Fsix%2Fmod.ts)](https://deno.land/x/six)
+
+> Set Interval X
+
+Limit the amount of times that `setInterval` will fire.
+
+> Made for
+> [this StackOverflow Question](https://stackoverflow.com/questions/2956966) 😆
+
+## Usage
+
+### [Deno 🚀](https://deno.land/x/six)
+
+```javascript
+import { setInterval } from "https://deno.land/x/six/mod.ts";
+import { randomNumber } from "https://deno.land/x/random_number/mod.ts";
+
+const API_URL = "https://leap.deno.dev";
+
+async function checkAPIStatus() {
+  const startTime = performance.now();
+
+  const randomYear = randomNumber({ min: 2000, max: 10_000 });
+
+  const response = await fetch(`${API_URL}/${randomYear}`);
+
+  const data = await response.json();
+
+  console.log(`Is ${randomYear} a leap year? ${data.leapYear}.`);
+
+  const entTime = performance.now();
+
+  console.log(`Request took ${(entTime - startTime) / 1000} seconds.`);
+}
+
+setIntervalX(checkAPIStatus, 2000, 15);
+```
+
+### [Node.js 🐢](https://www.npmjs.com/package/@ultirequiem/six)
+
+```typescript
+import { setIntervalX } from "@ultirequiem/six";
+```
+
+### [Browser 🕸](https://developer.mozilla.org/en-US/docs/Glossary/Browser)
+
+You can use any [CDN](https://en.wikipedia.org/wiki/Content_delivery_network) 🔥
+
+Eg. [ESM](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules)
+▶ [SkyPack](https://cdn.skypack.dev/@ultirequiem/six) _/_
+[script tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script) ▶
+[JSDelivr](https://cdn.jsdelivr.net/npm/@ultirequiem/six).
+
+The API is the same on all this platforms.
+
+## API
+
+[Autogenerated Documentation](https://doc.deno.land/https://deno.land/x/six/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 ⭐
+
+## Versioning
+
+We use [SemVer](http://semver.org) for versioning. For the versions available,
+see the [tags](https://github.com/UltiRequiem/six/tags).
+
+## Authors
+
+[Eliaz Bobadilla (a.k.a UltiRequiem)](https://ultirequiem.com) - Creator and
+Maintainer 💪
+
+See also the full list of
+[contributors](https://github.com/UltiRequiem/six/contributors) who participated
+in this project.
+
+## Licence
+
+Released under the MIT Licence.

package/esm/mod.js

@@ -1,5 +1,27 @@
 // deno-lint-ignore-file no-explicit-any
-export default function setIntervalX(callback, delay, repetitions, ...args) {
+/**
+ * Limit the amount of times that setInterval will fire.
+ *
+ * @example
+ * ```javascript
+ * import { setInterval } from "https://deno.land/x/six/mod.ts";
+ * import { randomNumber } from "https://deno.land/x/random_number/mod.ts";
+ *
+ * const API_URL = "https://leap.deno.dev";
+ *
+ * async function checkAPIStatus() {
+ *    const randomYear = randomNumber({ min: 2000, max: 10_000});
+ *
+ *    const response = await fetch(`${API_URL}/${randomYear}`);
+ *    const data = await response.json();
+ *
+ *    console.log(`Is ${randomYear} a leap year? ${data.leapYear}.`);
+ * }
+ *
+ * setIntervalX(checkAPIStatus, 2000, 15);
+ * ```
+ */
+export function setIntervalX(callback, delay, repetitions, ...args) {
     let x = 0;
     const intervalID = setInterval(() => {
         callback(...args);

package/package.json

@@ -1,21 +1,29 @@
 {
   "module": "./esm/mod.js",
-  "main": "./umd/mod.js",
+  "main": "./script/mod.js",
   "types": "./types/mod.d.ts",
   "name": "@ultirequiem/six",
-  "description": "Limit the amount of times that setInterval will fire",
+  "description": "Limit the amount of times that setInterval will fire.",
+  "version": "1.0.0",
   "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ultirequiem/six.git"
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/ultirequiem"
   },
+  "repository": "github:ultirequiem/@ultirequiem/six",
+  "homepage": "https://ulti.js.org/six",
   "bugs": {
-    "url": "https://github.com/ultirequiem/six/issues"
+    "url": "https://github.com/ultirequiem/@ultirequiem/six/issues",
+    "email": "eliaz.bobadilladev@gmail.com"
   },
+  "keywords": [
+    "time",
+    "setInterval"
+  ],
   "exports": {
     ".": {
       "import": "./esm/mod.js",
-      "require": "./umd/mod.js",
+      "require": "./script/mod.js",
       "types": "./types/mod.d.ts"
     }
   },
@@ -24,9 +32,8 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "@deno/shim-deno": "~0.1.1",
-    "@types/node": "16.11.1",
-    "chalk": "4.1.2"
-  },
-  "version": "0.0.0"
-}
+    "@types/node": "16.11.26",
+    "chalk": "4.1.2",
+    "@deno/shim-deno": "~0.4.3"
+  }
+}

package/script/mod.js

@@ -0,0 +1,37 @@
+"use strict";
+// deno-lint-ignore-file no-explicit-any
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setIntervalX = void 0;
+/**
+ * Limit the amount of times that setInterval will fire.
+ *
+ * @example
+ * ```javascript
+ * import { setInterval } from "https://deno.land/x/six/mod.ts";
+ * import { randomNumber } from "https://deno.land/x/random_number/mod.ts";
+ *
+ * const API_URL = "https://leap.deno.dev";
+ *
+ * async function checkAPIStatus() {
+ *    const randomYear = randomNumber({ min: 2000, max: 10_000});
+ *
+ *    const response = await fetch(`${API_URL}/${randomYear}`);
+ *    const data = await response.json();
+ *
+ *    console.log(`Is ${randomYear} a leap year? ${data.leapYear}.`);
+ * }
+ *
+ * setIntervalX(checkAPIStatus, 2000, 15);
+ * ```
+ */
+function setIntervalX(callback, delay, repetitions, ...args) {
+    let x = 0;
+    const intervalID = setInterval(() => {
+        callback(...args);
+        if (++x === repetitions) {
+            clearInterval(intervalID);
+        }
+    }, delay);
+    return intervalID;
+}
+exports.setIntervalX = setIntervalX;

package/types/mod.d.ts

@@ -1,2 +1,24 @@
 /// <reference types="node" />
-export default function setIntervalX(callback: (...args: any[]) => any, delay: number, repetitions: number, ...args: any[]): NodeJS.Timer;
+/**
+ * Limit the amount of times that setInterval will fire.
+ *
+ * @example
+ * ```javascript
+ * import { setInterval } from "https://deno.land/x/six/mod.ts";
+ * import { randomNumber } from "https://deno.land/x/random_number/mod.ts";
+ *
+ * const API_URL = "https://leap.deno.dev";
+ *
+ * async function checkAPIStatus() {
+ *    const randomYear = randomNumber({ min: 2000, max: 10_000});
+ *
+ *    const response = await fetch(`${API_URL}/${randomYear}`);
+ *    const data = await response.json();
+ *
+ *    console.log(`Is ${randomYear} a leap year? ${data.leapYear}.`);
+ * }
+ *
+ * setIntervalX(checkAPIStatus, 2000, 15);
+ * ```
+ */
+export declare function setIntervalX(callback: (...args: any[]) => any, delay: number, repetitions: number, ...args: any[]): NodeJS.Timer;

package/license

@@ -1,21 +0,0 @@
-# MIT License
-
-Copyright (c) 2022 Eliaz Bobadilla (a.k.a UltiRequiem)
-
-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

@@ -1,36 +0,0 @@
-# six
-
-> Set Interval X
-
-Limit the amount of times that `setInterval` will fire.
-
-## Usage
-
-```typescript
-import setIntervalX from "https://deno.land/x/six/mod.ts";
-import randomNumber from "https://deno.land/x/random_number/mod.ts";
-
-const API_URL = "https://leap-year.ultirequiem.repl.co";
-
-async function checkAPIStatus() {
-  const startTime = performance.now();
-
-  const randomYear = randomNumber({ min: 2000, max: 10_000, integer: true });
-
-  const response = await fetch(`${API_URL}/${randomYear}`);
-
-  const data = await response.json();
-
-  console.log(`Is ${randomYear} a leap year? ${data.leapYear}.`);
-
-  const entTime = performance.now();
-
-  console.log(`Request took ${(entTime - startTime) / 1000} seconds.`);
-}
-
-setIntervalX(checkAPIStatus, 2000, 15);
-```
-
-## Licence
-
-Released under the MIT Licence.

package/umd/mod.js

@@ -1,24 +0,0 @@
-// deno-lint-ignore-file no-explicit-any
-(function (factory) {
-    if (typeof module === "object" && typeof module.exports === "object") {
-        var v = factory(require, exports);
-        if (v !== undefined) module.exports = v;
-    }
-    else if (typeof define === "function" && define.amd) {
-        define(["require", "exports"], factory);
-    }
-})(function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-    function setIntervalX(callback, delay, repetitions, ...args) {
-        let x = 0;
-        const intervalID = setInterval(() => {
-            callback(...args);
-            if (++x === repetitions) {
-                clearInterval(intervalID);
-            }
-        }, delay);
-        return intervalID;
-    }
-    exports.default = setIntervalX;
-});