waiit 0.0.1 → 2.0.0

package/README.md

@@ -3,24 +3,15 @@
 [![npm version](https://img.shields.io/npm/v/waiit.svg)](https://www.npmjs.com/package/waiit)
 [![license](https://img.shields.io/npm/l/waiit.svg)](https://github.com/Raju/waiit/blob/main/LICENSE)
 
-A lightweight, zero-dependency utility to wait for any amount of time in milliseconds. Returns a promise that resolves after the specified delay, or immediately if no value is passed.
+Promise-based delay utility. Tiny, typed, zero dependencies.
 
-## Features
 
-- 🪶 **Lightweight** - Single line of code, zero dependencies
-- ⚡ **Simple API** - Easy to use with async/await
-- 📦 **TypeScript Support** - Includes type definitions
-- 🔧 **Flexible** - Pass any millisecond value or omit for immediate resolution
-- 🌐 **Universal** - Works in Node.js and browsers
+## Features
 
-## Platform Support
+🪶 Lightweight (1 line) · ⚡ Simple async/await API · 📦 TypeScript ready · 🔧 Flexible · 🌐 Universal (Node.js & Browser) · 💻 CLI support
 
-| Platform | Supported |
-|----------|-----------|
-| Node.js  | ✅        |
-| Browser  | ✅        |
 
-## Installation
+## Install
 
 ```bash
 npm install waiit
@@ -28,108 +19,67 @@ npm install waiit
 
 ## API
 
-```js
+```ts
 wait(ms?: number): Promise<void>
 ```
 
 | Parameter | Type     | Default | Description                          |
 |-----------|----------|---------|--------------------------------------|
-| `ms`      | `number` | `0`     | Time to wait in milliseconds         |
+| `ms`      | `number` | `0`     | Delay in milliseconds                |
 
 **Returns:** A `Promise` that resolves after the specified time.
 
-## Examples
-
-```js
-wait()      // Returns a promise that resolves immediately
-wait(1000)  // Returns a promise that resolves after 1 second
-wait(5000)  // Returns a promise that resolves after 5 seconds
-```
 
 ## Usage
 
-### CommonJS
-
 ```js
+// CommonJS
 const wait = require('waiit');
 
-const doSomething = async () => {
-  console.log('Start');
-
-  await wait(5000);
-  console.log('Waited 5 seconds');
-
-  await wait();
-  console.log('Finish');
-};
-
-doSomething();
-```
-
-### ES Modules
-
-```js
+// ES Modules
 import wait from 'waiit';
 
-async function example() {
-  console.log('Starting...');
-  await wait(2000);
-  console.log('Done after 2 seconds!');
-}
-
-example();
+// Browser (CDN)
+import wait from 'https://unpkg.com/waiit/app.js';
 ```
 
-### Browser (via CDN)
-
-```html
-<script type="module">
-  // Using unpkg
-  import wait from 'https://unpkg.com/waiit/app.js';
-
-  await wait(1000);
-  console.log('Waited 1 second!');
-</script>
+```js
+await wait(2000);  // Wait 2 seconds
+await wait();      // Resolve immediately
 ```
 
-### Practical Examples
-
-#### Retry with delay
-
+### Retry with delay
 ```js
-const wait = require('waiit');
-
-async function fetchWithRetry(url, retries = 3, delay = 1000) {
+async function fetchWithRetry(url, retries = 3) {
   for (let i = 0; i < retries; i++) {
     try {
       return await fetch(url);
-    } catch (error) {
-      if (i < retries - 1) {
-        await wait(delay);
-      }
+    } catch (e) {
+      if (i < retries - 1) await wait(1000);
     }
   }
-  throw new Error('Max retries reached');
+  throw new Error('Failed');
 }
 ```
 
-#### Sequential execution with delays
-
+### Sequential execution
 ```js
-const wait = require('waiit');
-
-async function animateSteps(steps) {
-  for (const step of steps) {
-    console.log(step.message);
-    await wait(step.delay);
-  }
+for (const step of steps) {
+  console.log(step.message);
+  await wait(step.delay);
 }
+```
+
+## CLI
+
+```bash
+# Via npx
+npx waiit 2000   # Wait 2 seconds
 
-animateSteps([
-  { message: 'Step 1', delay: 1000 },
-  { message: 'Step 2', delay: 2000 },
-  { message: 'Step 3', delay: 1000 },
-]);
+# Or install globally
+npm i -g waiit
+waiit 3000       # Wait 3 seconds
+waiit            # Exit immediately
 ```
 
 ## License

package/app.js

@@ -1 +1 @@
-module.exports=t=>new Promise(r=>setTimeout(r,t));
+module.exports=t=>new Promise(r=>setTimeout(r,t))

package/cli.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+setTimeout(()=>{},process.argv[2]|0)

package/index.d.ts

@@ -1,10 +1,8 @@
 /**
- * Wait for a specified amount of time.
- * @param ms - Time to wait in milliseconds. Defaults to 0 (resolves immediately).
- * @returns A promise that resolves after the specified time.
- * @example
- * await wait(2000); // Wait for 2 seconds
- * await wait(); // Resolve immediately
+ * Promise-based delay utility. Tiny, typed, zero dependencies.
+ * @param ms Delay in ms (default: 0)
+ * @returns Promise that resolves after the specified delay
+ * @example wait(2000); // Wait for 2 seconds
  */
 declare function wait(ms?: number): Promise<void>;
 export = wait;

package/package.json

@@ -1,49 +1,20 @@
 {
   "name": "waiit",
-  "version": "0.0.1",
-  "description": "Wait for any amount of time in milliseconds or resolve immediately if no value passed",
+  "version": "2.0.0",
+  "description": "Promise-based delay utility. Tiny, typed, zero dependencies.",
   "main": "app.js",
   "types": "index.d.ts",
+  "bin": "cli.js",
   "exports": {
     ".": {
+      "types": "./index.d.ts",
       "require": "./app.js",
       "import": "./app.js"
     }
   },
-  "scripts": {
-    "test": "node test.js && node test.mjs",
-    "test:cjs": "node test.js",
-    "test:esm": "node test.mjs"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Raju/waiit.git"
-  },
-  "keywords": [
-    "wait",
-    "delay",
-    "sleep",
-    "timeout",
-    "promise",
-    "async",
-    "await",
-    "setTimeout",
-    "timer",
-    "pause",
-    "browser",
-    "node"
-  ],
+  "repository": "Raju/waiit",
+  "keywords": ["wait","delay","sleep","timeout","promise","async","await","setTimeout","timer","pause","browser","node","cli"],
   "author": "Raju Dhami",
   "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/Raju/waiit/issues"
-  },
-  "homepage": "https://github.com/Raju/waiit#readme",
-  "engines": {
-    "node": ">=10.0.0"
-  },
-  "files": [
-    "app.js",
-    "index.d.ts"
-  ]
-}
+  "files": ["app.js", "index.d.ts", "cli.js"]
+}