@useless-engineer/utils 0.1.2 → 0.1.3

package/README.md

@@ -155,6 +155,78 @@ Returns a function with `.cancel()`.
 
 </details>
 
+<details>
+<summary><code>delay(ms, options?)</code> &nbsp; <img alt="live" src="https://img.shields.io/badge/-live-22c55e?style=flat-square"> <img alt="async" src="https://img.shields.io/badge/-async-6366f1?style=flat-square"></summary>
+
+<br>
+
+`await`-able sleep that rejects bad input (negative, `NaN`, `Infinity`) instead of silently firing instantly, and can be cancelled.
+
+```ts
+await delay(500);
+
+const ctrl = new AbortController();
+delay(5000, { signal: ctrl.signal }).catch(() => {});
+ctrl.abort(); // stops waiting; the promise rejects with the signal's reason
+```
+
+</details>
+
+<details>
+<summary><code>withTimeout(promise, ms, message?)</code> &nbsp; <img alt="live" src="https://img.shields.io/badge/-live-22c55e?style=flat-square"> <img alt="async" src="https://img.shields.io/badge/-async-6366f1?style=flat-square"></summary>
+
+<br>
+
+Rejects with a `TimeoutError` if the promise takes too long. Clears its timer once the promise settles.
+
+```ts
+try {
+  const user = await withTimeout(fetchUser(id), 3000);
+} catch (e) {
+  if (e instanceof TimeoutError) showRetry();
+}
+```
+
+> ⚠️ This stops _waiting_, not the work. A timed-out `fetch` keeps running unless you also pass it an `AbortSignal`.
+
+</details>
+
+<details>
+<summary><code>safeParseJSON(text, fallback?)</code> &nbsp; <img alt="live" src="https://img.shields.io/badge/-live-22c55e?style=flat-square"> <img alt="json" src="https://img.shields.io/badge/-json-f97316?style=flat-square"></summary>
+
+<br>
+
+`JSON.parse` that never throws. Returns the fallback for invalid JSON or for `null`/`undefined` input (like a missing `AsyncStorage` key).
+
+```ts
+const settings = safeParseJSON(raw, { theme: "light" });
+safeParseJSON("0", 99); // 0, valid falsy values are kept
+safeParseJSON("{oops", 1); // 1
+```
+
+> The type `T` is a promise from you, not a check. Validate untrusted data before relying on its shape.
+
+</details>
+
+<details>
+<summary><code>safeStringify(value, options?)</code> &nbsp; <img alt="live" src="https://img.shields.io/badge/-live-22c55e?style=flat-square"> <img alt="json" src="https://img.shields.io/badge/-json-f97316?style=flat-square"></summary>
+
+<br>
+
+`JSON.stringify` that never throws on circular references or `BigInt`.
+
+```ts
+const a = { name: "a" };
+a.self = a;
+safeStringify(a); // '{"name":"a","self":"[Circular]"}'
+safeStringify({ n: 10n }); // '{"n":"10"}'
+safeStringify(data, { space: 2 });
+```
+
+Shared (non-circular) references are kept as they are. Returns `undefined` when there's no JSON form, like `JSON.stringify`.
+
+</details>
+
 ### React Native
 
 <details>
@@ -178,11 +250,11 @@ const behavior = isIOS ? "padding" : "height";
 
 Released one or two at a time, each matching a post that's already live.
 
-| Next up                                                                                                                  | Entry        | Origin                               |
-| ------------------------------------------------------------------------------------------------------------------------ | ------------ | ------------------------------------ |
-| ![next](https://img.shields.io/badge/-next-f59e0b?style=flat-square)`safeParseJSON`, `safeStringify`, `deepClone`        | core         | JSON and shallow-copy gotchas        |
-| ![planned](https://img.shields.io/badge/-planned-64748b?style=flat-square) `getAccessibilityProps`, `createShadow`       | react-native | Accessibility and iOS-only shadows   |
-| ![planned](https://img.shields.io/badge/-planned-64748b?style=flat-square) `useInterval`, `useCountdown`, `useIsMounted` | react        | Stale closures and unmounted updates |
+| Next up                                                                                                                  | Entry        | Origin                                 |
+| ------------------------------------------------------------------------------------------------------------------------ | ------------ | -------------------------------------- |
+| ![next](https://img.shields.io/badge/-next-f59e0b?style=flat-square) `deepClone`, `settle` helpers                       | core         | Shallow-copy and `Promise.all` gotchas |
+| ![planned](https://img.shields.io/badge/-planned-64748b?style=flat-square) `getAccessibilityProps`, `createShadow`       | react-native | Accessibility and iOS-only shadows     |
+| ![planned](https://img.shields.io/badge/-planned-64748b?style=flat-square) `useInterval`, `useCountdown`, `useIsMounted` | react        | Stale closures and unmounted updates   |
 
 ---
 

package/dist/index.cjs

@@ -108,8 +108,40 @@ function withTimeout(promise, ms, message) {
   });
 }
 
+// src/json/safeParseJSON.ts
+function safeParseJSON(text, fallback) {
+  if (typeof text !== "string") return fallback;
+  try {
+    return JSON.parse(text);
+  } catch {
+    return fallback;
+  }
+}
+
+// src/json/safeStringify.ts
+function safeStringify(value, { space } = {}) {
+  const ancestors = [];
+  function replacer(_key, val) {
+    if (typeof val === "bigint") return val.toString();
+    if (typeof val !== "object" || val === null) return val;
+    while (ancestors.length > 0 && ancestors[ancestors.length - 1] !== this) {
+      ancestors.pop();
+    }
+    if (ancestors.includes(val)) return "[Circular]";
+    ancestors.push(val);
+    return val;
+  }
+  try {
+    return JSON.stringify(value, replacer, space);
+  } catch {
+    return void 0;
+  }
+}
+
 exports.TimeoutError = TimeoutError;
 exports.debounce = debounce;
 exports.delay = delay;
+exports.safeParseJSON = safeParseJSON;
+exports.safeStringify = safeStringify;
 exports.throttle = throttle;
 exports.withTimeout = withTimeout;

package/dist/index.d.cts

@@ -49,4 +49,29 @@ declare class TimeoutError extends Error {
  */
 declare function withTimeout<T>(promise: PromiseLike<T>, ms: number, message?: string): Promise<T>;
 
-export { type Debounced, type DelayOptions, type ThrottleOptions, type Throttled, TimeoutError, debounce, delay, throttle, withTimeout };
+/**
+ * Parses JSON without throwing. Returns `fallback` (or `undefined`) when the
+ * input is not a string or is not valid JSON.
+ *
+ * The result is NOT validated: `T` is a promise from you, not a check.
+ * Validate untrusted data before relying on its shape.
+ */
+declare function safeParseJSON<T>(text: string | null | undefined, fallback: T): T;
+declare function safeParseJSON<T = unknown>(text: string | null | undefined): T | undefined;
+
+interface SafeStringifyOptions {
+    /** Indentation, same as the third argument of JSON.stringify. */
+    space?: string | number;
+}
+/**
+ * Like JSON.stringify, but never throws:
+ * - circular references become "[Circular]" (shared, non-circular references are kept)
+ * - BigInt values become strings
+ * - anything else that throws (e.g. a failing toJSON) returns `undefined`
+ *
+ * Like JSON.stringify, returns `undefined` for top-level values with no JSON form
+ * (undefined, functions, symbols).
+ */
+declare function safeStringify(value: unknown, { space }?: SafeStringifyOptions): string | undefined;
+
+export { type Debounced, type DelayOptions, type SafeStringifyOptions, type ThrottleOptions, type Throttled, TimeoutError, debounce, delay, safeParseJSON, safeStringify, throttle, withTimeout };

package/dist/index.d.ts

@@ -49,4 +49,29 @@ declare class TimeoutError extends Error {
  */
 declare function withTimeout<T>(promise: PromiseLike<T>, ms: number, message?: string): Promise<T>;
 
-export { type Debounced, type DelayOptions, type ThrottleOptions, type Throttled, TimeoutError, debounce, delay, throttle, withTimeout };
+/**
+ * Parses JSON without throwing. Returns `fallback` (or `undefined`) when the
+ * input is not a string or is not valid JSON.
+ *
+ * The result is NOT validated: `T` is a promise from you, not a check.
+ * Validate untrusted data before relying on its shape.
+ */
+declare function safeParseJSON<T>(text: string | null | undefined, fallback: T): T;
+declare function safeParseJSON<T = unknown>(text: string | null | undefined): T | undefined;
+
+interface SafeStringifyOptions {
+    /** Indentation, same as the third argument of JSON.stringify. */
+    space?: string | number;
+}
+/**
+ * Like JSON.stringify, but never throws:
+ * - circular references become "[Circular]" (shared, non-circular references are kept)
+ * - BigInt values become strings
+ * - anything else that throws (e.g. a failing toJSON) returns `undefined`
+ *
+ * Like JSON.stringify, returns `undefined` for top-level values with no JSON form
+ * (undefined, functions, symbols).
+ */
+declare function safeStringify(value: unknown, { space }?: SafeStringifyOptions): string | undefined;
+
+export { type Debounced, type DelayOptions, type SafeStringifyOptions, type ThrottleOptions, type Throttled, TimeoutError, debounce, delay, safeParseJSON, safeStringify, throttle, withTimeout };

package/dist/index.js

@@ -106,4 +106,34 @@ function withTimeout(promise, ms, message) {
   });
 }
 
-export { TimeoutError, debounce, delay, throttle, withTimeout };
+// src/json/safeParseJSON.ts
+function safeParseJSON(text, fallback) {
+  if (typeof text !== "string") return fallback;
+  try {
+    return JSON.parse(text);
+  } catch {
+    return fallback;
+  }
+}
+
+// src/json/safeStringify.ts
+function safeStringify(value, { space } = {}) {
+  const ancestors = [];
+  function replacer(_key, val) {
+    if (typeof val === "bigint") return val.toString();
+    if (typeof val !== "object" || val === null) return val;
+    while (ancestors.length > 0 && ancestors[ancestors.length - 1] !== this) {
+      ancestors.pop();
+    }
+    if (ancestors.includes(val)) return "[Circular]";
+    ancestors.push(val);
+    return val;
+  }
+  try {
+    return JSON.stringify(value, replacer, space);
+  } catch {
+    return void 0;
+  }
+}
+
+export { TimeoutError, debounce, delay, safeParseJSON, safeStringify, throttle, withTimeout };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@useless-engineer/utils",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "repo for small, utility functions by useless engineer",
   "author": "Useless Engineer",
   "keywords": [