@useless-engineer/utils 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 saurabh bandkar
+
+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,3 +1,11 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# @useless-engineer/utils
+
+Small, typed utilities from [@useless_engineer.dev](https://www.instagram.com/useless_engineer.dev/).
+One package, multiple entry points, so React Native code never pulls in what it doesn't use.
+
+```ts
+import { debounce, throttle } from "@useless-engineer/utils";
+import { isIOS, isAndroid } from "@useless-engineer/utils/react-native";
+```
+
+`react` and `react-native` are optional peer dependencies.

package/dist/index.cjs

@@ -0,0 +1,60 @@
+'use strict';
+
+// src/async/debounce.ts
+function debounce(fn, delay) {
+  let timer;
+  const debounced = (...args) => {
+    if (timer !== void 0) clearTimeout(timer);
+    timer = setTimeout(() => {
+      timer = void 0;
+      fn(...args);
+    }, delay);
+  };
+  debounced.cancel = () => {
+    if (timer !== void 0) clearTimeout(timer);
+    timer = void 0;
+  };
+  return debounced;
+}
+
+// src/async/throttle.ts
+function throttle(fn, interval, { leading = true, trailing = true } = {}) {
+  let timer;
+  let lastArgs;
+  let lastRun = 0;
+  const run = (args) => {
+    lastRun = Date.now();
+    fn(...args);
+  };
+  const throttled = (...args) => {
+    const now = Date.now();
+    if (lastRun === 0 && !leading) lastRun = now;
+    const remaining = interval - (now - lastRun);
+    if (remaining <= 0) {
+      if (timer !== void 0) clearTimeout(timer);
+      timer = void 0;
+      lastArgs = void 0;
+      run(args);
+    } else if (trailing) {
+      lastArgs = args;
+      if (timer === void 0) {
+        timer = setTimeout(() => {
+          timer = void 0;
+          const a = lastArgs;
+          lastArgs = void 0;
+          if (a) run(a);
+        }, remaining);
+      }
+    }
+  };
+  throttled.cancel = () => {
+    if (timer !== void 0) clearTimeout(timer);
+    timer = void 0;
+    lastArgs = void 0;
+    lastRun = 0;
+  };
+  return throttled;
+}
+
+exports.debounce = debounce;
+exports.throttle = throttle;

package/dist/index.d.cts

@@ -0,0 +1,29 @@
+interface Debounced<A extends unknown[]> {
+    (...args: A): void;
+    /** Drop any pending call. Call this from your effect cleanup. */
+    cancel: () => void;
+}
+/**
+ * Delays `fn` until `delay` ms have passed with no new calls.
+ * Every call resets the timer; only the last one fires.
+ */
+declare function debounce<A extends unknown[]>(fn: (...args: A) => void, delay: number): Debounced<A>;
+
+interface ThrottleOptions {
+    /** Fire immediately on the first call of a burst. Default: true */
+    leading?: boolean;
+    /** Fire once more at the end of the burst with the latest args. Default: true */
+    trailing?: boolean;
+}
+interface Throttled<A extends unknown[]> {
+    (...args: A): void;
+    /** Drop any pending trailing call and reset. */
+    cancel: () => void;
+}
+/**
+ * Runs `fn` at most once per `interval` ms, however often it's called.
+ * Leading edge keeps UI snappy; trailing edge preserves the final update.
+ */
+declare function throttle<A extends unknown[]>(fn: (...args: A) => void, interval: number, { leading, trailing }?: ThrottleOptions): Throttled<A>;
+
+export { type Debounced, type ThrottleOptions, type Throttled, debounce, throttle };

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+interface Debounced<A extends unknown[]> {
+    (...args: A): void;
+    /** Drop any pending call. Call this from your effect cleanup. */
+    cancel: () => void;
+}
+/**
+ * Delays `fn` until `delay` ms have passed with no new calls.
+ * Every call resets the timer; only the last one fires.
+ */
+declare function debounce<A extends unknown[]>(fn: (...args: A) => void, delay: number): Debounced<A>;
+
+interface ThrottleOptions {
+    /** Fire immediately on the first call of a burst. Default: true */
+    leading?: boolean;
+    /** Fire once more at the end of the burst with the latest args. Default: true */
+    trailing?: boolean;
+}
+interface Throttled<A extends unknown[]> {
+    (...args: A): void;
+    /** Drop any pending trailing call and reset. */
+    cancel: () => void;
+}
+/**
+ * Runs `fn` at most once per `interval` ms, however often it's called.
+ * Leading edge keeps UI snappy; trailing edge preserves the final update.
+ */
+declare function throttle<A extends unknown[]>(fn: (...args: A) => void, interval: number, { leading, trailing }?: ThrottleOptions): Throttled<A>;
+
+export { type Debounced, type ThrottleOptions, type Throttled, debounce, throttle };

package/dist/index.js

@@ -0,0 +1,57 @@
+// src/async/debounce.ts
+function debounce(fn, delay) {
+  let timer;
+  const debounced = (...args) => {
+    if (timer !== void 0) clearTimeout(timer);
+    timer = setTimeout(() => {
+      timer = void 0;
+      fn(...args);
+    }, delay);
+  };
+  debounced.cancel = () => {
+    if (timer !== void 0) clearTimeout(timer);
+    timer = void 0;
+  };
+  return debounced;
+}
+
+// src/async/throttle.ts
+function throttle(fn, interval, { leading = true, trailing = true } = {}) {
+  let timer;
+  let lastArgs;
+  let lastRun = 0;
+  const run = (args) => {
+    lastRun = Date.now();
+    fn(...args);
+  };
+  const throttled = (...args) => {
+    const now = Date.now();
+    if (lastRun === 0 && !leading) lastRun = now;
+    const remaining = interval - (now - lastRun);
+    if (remaining <= 0) {
+      if (timer !== void 0) clearTimeout(timer);
+      timer = void 0;
+      lastArgs = void 0;
+      run(args);
+    } else if (trailing) {
+      lastArgs = args;
+      if (timer === void 0) {
+        timer = setTimeout(() => {
+          timer = void 0;
+          const a = lastArgs;
+          lastArgs = void 0;
+          if (a) run(a);
+        }, remaining);
+      }
+    }
+  };
+  throttled.cancel = () => {
+    if (timer !== void 0) clearTimeout(timer);
+    timer = void 0;
+    lastArgs = void 0;
+    lastRun = 0;
+  };
+  return throttled;
+}
+
+export { debounce, throttle };

package/dist/react-native/index.cjs

@@ -0,0 +1,10 @@
+'use strict';
+
+var reactNative = require('react-native');
+
+// src/react-native/index.ts
+var isIOS = reactNative.Platform.OS === "ios";
+var isAndroid = reactNative.Platform.OS === "android";
+
+exports.isAndroid = isAndroid;
+exports.isIOS = isIOS;

package/dist/react-native/index.d.cts

@@ -0,0 +1,4 @@
+declare const isIOS: boolean;
+declare const isAndroid: boolean;
+
+export { isAndroid, isIOS };

package/dist/react-native/index.d.ts

@@ -0,0 +1,4 @@
+declare const isIOS: boolean;
+declare const isAndroid: boolean;
+
+export { isAndroid, isIOS };

package/dist/react-native/index.js

@@ -0,0 +1,7 @@
+import { Platform } from 'react-native';
+
+// src/react-native/index.ts
+var isIOS = Platform.OS === "ios";
+var isAndroid = Platform.OS === "android";
+
+export { isAndroid, isIOS };

package/package.json

@@ -1,6 +1,93 @@
 {
   "name": "@useless-engineer/utils",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "repo for small, utility functions by useless engineer",
+  "author": "Useless Engineer",
+  "keywords": [
+    "utils",
+    "typescript",
+    "react-native",
+    "debounce",
+    "throttle"
+  ],
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/saurabhbandkar/useless-engineer.git"
+  },
+  "license": "MIT",
+  "type": "module",
+  "bugs": {
+    "url": "https://github.com/saurabhbandkar/useless-engineer/issues"
+  },
+  "homepage": "https://github.com/saurabhbandkar/useless-engineer#readme",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./react-native": {
+      "import": {
+        "types": "./dist/react-native/index.d.ts",
+        "default": "./dist/react-native/index.js"
+      },
+      "require": {
+        "types": "./dist/react-native/index.d.cts",
+        "default": "./dist/react-native/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "react-native": [
+        "./dist/react-native/index.d.ts"
+      ]
+    }
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "test": "node --import tsx --test test/*.test.ts",
+    "prepublishOnly": "npm run typecheck && npm test && npm run build"
+  },
+  "peerDependencies": {
+    "react": ">=18",
+    "react-native": ">=0.72"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "react-native": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "tsup": "^8.0.0",
+    "tsx": "^4.0.0",
+    "typescript": "^5.5.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "allowScripts": {
+    "esbuild": true
+  },
+  "overrides": {
+    "esbuild": "^0.28.2"
+  }
+}