@parasrp/delay 1.0.1 → 2.0.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Paras R Poshiya
+
+Permission is hereby granted, free of charge, to any person obtaining a copyof 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,19 +1,96 @@
 # @parasrp/delay
 
-A small and simple JavaScript utility to pause execution for a specified number of milliseconds.
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+![npm version](https://img.shields.io/npm/v/@parasrp/delay)
+![npm downloads](https://img.shields.io/npm/dw/@parasrp/delay)
+![install size](https://packagephobia.com/badge?p=@parasrp/delay)
+![bundle size](https://img.shields.io/bundlephobia/min/@parasrp/delay)
 
+A lightweight, promise-based JavaScript utility to pause execution for a specified duration. Perfect for adding timeouts, staggering API calls, or building simple animations.
+
+---
 ## ✨ Features
 
-- Lightweight and fast
-- Promise-based
-- No dependencies
-- Works in any modern JavaScript environment
+- 🪶 **Lightweight & Fast**: Zero overhead, minimal footprint.
+- 🤝 **Promise-based**: Works seamlessly with `async/await`.
+- 📦 **Zero Dependencies**: Keeps your node_modules clean.
+- 🌍 **Universal**: Works in Node.js, browsers, and modern JS environments.
+- ⏱️ **Flexible Units**: Supports `milliseconds`, `seconds`, `minutes`, and `hours`.
 
 ---
-
 ## 📦 Installation
 
-Install using npm:
-
+Install the package via npm:
 ```bash
 npm install @parasrp/delay
+```
+
+Install the package via yarn:
+```bash
+yarn add @parasrp/delay
+```
+
+---
+## ✨ Features
+You can use @parasrp/delay with both CommonJS and ES Modules.
+
+ES6 Modules:
+```js
+import delay from "@parasrp/delay";
+```
+
+CommonJS:
+```js
+const delay = require("@parasrp/delay");
+```
+
+---
+## 📖 API
+
+```js
+/**
+    * Sleep (pause execution) for a given time with unit
+    * @param {number} value - The amount of time to wait
+    * @param {'milliseconds'|'seconds'|'minutes'|'hours'} [unit='milliseconds'] - The unit of time (default is milliseconds)
+    * @returns {Promise<void>} - A Promise that resolves after the specified delay
+**/
+await delay(value, unit?);
+```
+
+---
+## Examples
+
+Using async/await:
+```js
+async function demo() {
+  console.log("Waiting 2 seconds...");
+  await delay(2, "seconds"); // waits 2000 ms
+  console.log("Done!");
+
+  console.log("Waiting 1 minute...");
+  await delay(1, "minutes"); // waits 60000 ms
+  console.log("Finished!");
+}
+
+demo();
+```
+
+Using .then():
+```js
+console.log("Start waiting...");
+
+delay(1000).then(() => {
+  console.log("Finished waiting 1000 milliseconds");
+});
+
+delay(0.5, "hours").then(() => {
+  console.log("Finished waiting 30 minutes");
+});
+
+```
+
+---
+## 👤 Author
+**Paras R Poshiya**
+* [GitHub](https://github.com/parasposhiya)
+* [GitLab](https://gitlab.com/parasposhiya)

package/index.js

@@ -1,10 +1,31 @@
 /**
- * Sleep for given milliseconds
- * @param {number} ms
- * @returns {Promise<void>}
- */
+    * Sleep (pause execution) for a given time with unit
+    * @param {number} value - The amount of time to wait
+    * @param {'milliseconds'|'seconds'|'minutes'|'hours'} [unit='milliseconds'] - The unit of time (default is milliseconds)
+    * @returns {Promise<void>} - A Promise that resolves after the specified delay
+**/
+const delay = (value, unit = 'milliseconds') => {
+    let ms; // variable to hold the converted time in milliseconds
 
-const delay = (ms) =>
-    new Promise((resolve) => setTimeout(resolve, ms));
+    // Convert the given value into milliseconds based on the unit
+    switch (unit) {
+        case 'seconds':
+            ms = value * 1000; // 1 second = 1000 ms
+            break;
+        case 'minutes':
+            ms = value * 1000 * 60; // 1 minute = 60,000 ms
+            break;
+        case 'hours':
+            ms = value * 1000 * 60 * 60; // 1 hour = 3,600,000 ms
+            break;
+        case 'milliseconds':
+        default:
+            ms = value; // already in milliseconds
+    }
 
-export default delay
+    // Return a Promise that resolves after the calculated milliseconds
+    return new Promise((resolve) => setTimeout(resolve, ms));
+};
+
+// Export the function so it can be imported in other files
+export default delay;

package/package.json

@@ -1,16 +1,35 @@
-{
-  "name": "@parasrp/delay",
-  "version": "1.0.1",
-  "description": "sleep function",
-  "author": "Paras R Poshiya",
-  "keywords": [
-    "sleep",
-    "delay"
-  ],
-  "license": "MIT",
-  "main": "index.js",
-  "type": "module",
-  "exports": {
-    ".": "./index.js"
-  }
-}
+{
+  "name": "@parasrp/delay",
+  "version": "2.0.0",
+  "description": "A simple sleep/delay function with support for milliseconds, seconds, minutes, and hours.",
+  "author": "Paras R Poshiya",
+  "keywords": [
+    "sleep",
+    "delay",
+    "wait",
+    "timeout",
+    "pause"
+  ],
+  "license": "MIT",
+  "main": "index.js",
+  "type": "module",
+  "exports": {
+    ".": "./index.js"
+  },
+  "scripts": {
+    "test": "node --test",
+    "build": "echo 'No build step yet' && exit 0"
+  },
+  "files": [
+    "index.js",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/parasrp-npm/delay.git"
+  },
+  "bugs": {
+    "url": "https://gitlab.com/parasrp-npm/delay/issues"
+  },
+  "homepage": "https://gitlab.com/parasrp-npm/delay#readme"
+}