@ultirequiem/six 0.0.0 → 2.0.0

package/lib/index.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Limit the amount of times that setInterval will fire.
+ *
+ * @example
+ * ```javascript
+ * import { setIntervalX } from "@ultirequiem/six";
+ * import { randomNumber } from "@ultirequiem/random-number";
+ *
+ * const API_URL = "https://example.com/api/leap";
+ *
+ * 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(handler: (...args: any[]) => any, timeout: number, repetitions: number, ...args: any[]): NodeJS.Timeout;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAChC,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,GAAG,IAAI,EAAE,GAAG,EAAE,kBAaf"}

package/lib/index.js

@@ -0,0 +1,33 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * Limit the amount of times that setInterval will fire.
+ *
+ * @example
+ * ```javascript
+ * import { setIntervalX } from "@ultirequiem/six";
+ * import { randomNumber } from "@ultirequiem/random-number";
+ *
+ * const API_URL = "https://example.com/api/leap";
+ *
+ * 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(handler, timeout, repetitions, ...args) {
+    let x = 0;
+    const interval = setInterval(() => {
+        handler(...args);
+        if (++x === repetitions) {
+            clearInterval(interval);
+        }
+    }, timeout);
+    return interval;
+}

package/license.md

@@ -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/package.json

@@ -1,32 +1,53 @@
 {
-  "module": "./esm/mod.js",
-  "main": "./umd/mod.js",
-  "types": "./types/mod.d.ts",
   "name": "@ultirequiem/six",
-  "description": "Limit the amount of times that setInterval will fire",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ultirequiem/six.git"
-  },
-  "bugs": {
-    "url": "https://github.com/ultirequiem/six/issues"
-  },
+  "version": "2.0.0",
+  "description": "Limit the amount of times that setInterval will fire.",
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "exports": {
     ".": {
-      "import": "./esm/mod.js",
-      "require": "./umd/mod.js",
-      "types": "./types/mod.d.ts"
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js"
     }
   },
+  "files": [
+    "lib/**/*"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "keywords": [
+    "time",
+    "setInterval"
+  ],
+  "license": "MIT",
+  "homepage": "https://ulti.js.org/six",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/UltiRequiem/six.git"
+  },
   "scripts": {
-    "test": "node test_runner.js"
+    "build": "tsc",
+    "lint": "eslint 'src/**/*.ts' && prettier --check 'src/**/*.ts'",
+    "fmt": "prettier --write 'src/**/*.ts'",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage"
   },
-  "dependencies": {},
   "devDependencies": {
-    "@deno/shim-deno": "~0.1.1",
-    "@types/node": "16.11.1",
-    "chalk": "4.1.2"
+    "@types/node": "^26.6.5",
+    "@vitest/coverage-v8": "^5.0.5",
+    "eslint": "^10.13.0",
+    "eslint-plugin-tsdoc": "^0.5.4",
+    "eslint-plugin-unicorn": "^78.0.0",
+    "prettier": "^3.9.10",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.72.0",
+    "vitest": "^5.0.5"
+  },
+  "dependencies": {
+    "@ultirequiem/random-number": "^2.0.0",
+    "@ultirequiem/six": "^1.0.0"
   },
-  "version": "0.0.0"
+  "packageManager": "pnpm@12.6.0"
 }

package/readme.md

@@ -1,35 +1,49 @@
 # six
 
+[![npm](https://img.shields.io/npm/v/@ultirequiem/six?logo=npm&color=cb3837)](https://www.npmjs.com/package/@ultirequiem/six)
+[![npm downloads](https://img.shields.io/npm/dm/@ultirequiem/six?color=cb3837)](https://www.npmjs.com/package/@ultirequiem/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/graph/badge.svg)](https://codecov.io/gh/UltiRequiem/six)
+
 > Set Interval X
 
 Limit the amount of times that `setInterval` will fire.
 
+> Made for
+> [this StackOverflow Question](https://stackoverflow.com/questions/2956966) 😆
+
+## Install
+
+```sh
+npm install @ultirequiem/six
+```
+
 ## Usage
 
-```typescript
-import setIntervalX from "https://deno.land/x/six/mod.ts";
-import randomNumber from "https://deno.land/x/random_number/mod.ts";
+ESM only, types included: the same import works in Node.js, Bun and browsers.
 
-const API_URL = "https://leap-year.ultirequiem.repl.co";
+## Support
 
-async function checkAPIStatus() {
-  const startTime = performance.now();
+Open an Issue, I will check it as soon as possible 👀
 
-  const randomYear = randomNumber({ min: 2000, max: 10_000, integer: true });
+If you want to hurry me up a bit
+[send me a tweet](https://twitter.com/intent/tweet?text=%40UltiRequiem%20) 😆
 
-  const response = await fetch(`${API_URL}/${randomYear}`);
+Don't forget to star the repo ⭐
 
-  const data = await response.json();
+## Versioning
 
-  console.log(`Is ${randomYear} a leap year? ${data.leapYear}.`);
+We use [SemVer](http://semver.org) for versioning. For the versions available,
+see the [tags](https://github.com/UltiRequiem/six/tags).
 
-  const entTime = performance.now();
+## Authors
 
-  console.log(`Request took ${(entTime - startTime) / 1000} seconds.`);
-}
+[Eliaz Bobadilla (a.k.a UltiRequiem)](https://ultirequiem.com) - Creator and
+Maintainer 💪
 
-setIntervalX(checkAPIStatus, 2000, 15);
-```
+See also the full list of
+[contributors](https://github.com/UltiRequiem/six/contributors) who participated
+in this project.
 
 ## Licence
 

package/esm/mod.js

@@ -1,11 +0,0 @@
-// deno-lint-ignore-file no-explicit-any
-export default function setIntervalX(callback, delay, repetitions, ...args) {
-    let x = 0;
-    const intervalID = setInterval(() => {
-        callback(...args);
-        if (++x === repetitions) {
-            clearInterval(intervalID);
-        }
-    }, delay);
-    return intervalID;
-}

package/esm/package.json

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

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/types/mod.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="node" />
-export default function setIntervalX(callback: (...args: any[]) => any, delay: number, repetitions: number, ...args: any[]): NodeJS.Timer;

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;
-});

package/umd/package.json

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