@ultirequiem/six 1.0.0 → 2.0.0

package/{types/mod.d.ts → lib/index.d.ts}

@@ -1,13 +1,12 @@
-/// <reference types="node" />
 /**
  * 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";
+ * import { setIntervalX } from "@ultirequiem/six";
+ * import { randomNumber } from "@ultirequiem/random-number";
  *
- * const API_URL = "https://leap.deno.dev";
+ * const API_URL = "https://example.com/api/leap";
  *
  * async function checkAPIStatus() {
  *    const randomYear = randomNumber({ min: 2000, max: 10_000});
@@ -21,4 +20,5 @@
  * setIntervalX(checkAPIStatus, 2000, 15);
  * ```
  */
-export declare function setIntervalX(callback: (...args: any[]) => any, delay: number, repetitions: number, ...args: any[]): NodeJS.Timer;
+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/{esm/mod.js → lib/index.js}

@@ -1,13 +1,13 @@
-// deno-lint-ignore-file no-explicit-any
+/* eslint-disable @typescript-eslint/no-explicit-any */
 /**
  * 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";
+ * import { setIntervalX } from "@ultirequiem/six";
+ * import { randomNumber } from "@ultirequiem/random-number";
  *
- * const API_URL = "https://leap.deno.dev";
+ * const API_URL = "https://example.com/api/leap";
  *
  * async function checkAPIStatus() {
  *    const randomYear = randomNumber({ min: 2000, max: 10_000});
@@ -21,13 +21,13 @@
  * setIntervalX(checkAPIStatus, 2000, 15);
  * ```
  */
-export function setIntervalX(callback, delay, repetitions, ...args) {
+export function setIntervalX(handler, timeout, repetitions, ...args) {
     let x = 0;
-    const intervalID = setInterval(() => {
-        callback(...args);
+    const interval = setInterval(() => {
+        handler(...args);
         if (++x === repetitions) {
-            clearInterval(intervalID);
+            clearInterval(interval);
         }
-    }, delay);
-    return intervalID;
+    }, timeout);
+    return interval;
 }

package/package.json

@@ -1,39 +1,53 @@
 {
-  "module": "./esm/mod.js",
-  "main": "./script/mod.js",
-  "types": "./types/mod.d.ts",
   "name": "@ultirequiem/six",
+  "version": "2.0.0",
   "description": "Limit the amount of times that setInterval will fire.",
-  "version": "1.0.0",
-  "license": "MIT",
-  "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/ultirequiem"
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js"
+    }
   },
-  "repository": "github:ultirequiem/@ultirequiem/six",
-  "homepage": "https://ulti.js.org/six",
-  "bugs": {
-    "url": "https://github.com/ultirequiem/@ultirequiem/six/issues",
-    "email": "eliaz.bobadilladev@gmail.com"
+  "files": [
+    "lib/**/*"
+  ],
+  "engines": {
+    "node": ">=20"
   },
   "keywords": [
     "time",
     "setInterval"
   ],
-  "exports": {
-    ".": {
-      "import": "./esm/mod.js",
-      "require": "./script/mod.js",
-      "types": "./types/mod.d.ts"
-    }
+  "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": {
-    "@types/node": "16.11.26",
-    "chalk": "4.1.2",
-    "@deno/shim-deno": "~0.4.3"
-  }
-}
+    "@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"
+  },
+  "packageManager": "pnpm@12.6.0"
+}

package/readme.md

@@ -0,0 +1,50 @@
+# 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
+
+ESM only, types included: the same import works in Node.js, Bun and browsers.
+
+## Support
+
+Open an Issue, I will check it as soon as possible 👀
+
+If you want to hurry me up a bit
+[send me a tweet](https://twitter.com/intent/tweet?text=%40UltiRequiem%20) 😆
+
+Don't forget to star 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/README.md

@@ -1,97 +0,0 @@
-# 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/package.json

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

package/script/mod.js

@@ -1,37 +0,0 @@
-"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/script/package.json

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