yummies 7.12.0 → 7.14.0

package/types.global.d.ts

@@ -1,4 +1,45 @@
 /** THIS IS AUTOGENERATED FILE FROM "utils/types.ts" */
+/**
+ * ---header-docs-section---
+ * # yummies/types
+ *
+ * ## Description
+ *
+ * This module collects **TypeScript-only** helpers: `ValueOf`, nullable aliases, branded types, and
+ * patterns for props and generics. Nothing here exists at runtime — use `import type` so bundlers
+ * drop the imports entirely. The same ideas are also published as **ambient** globals under a
+ * separate entry (see below) when you want types in scope without repeating imports in every file.
+ *
+ * ## `yummies/types.global`
+ *
+ * Use this subpath when you prefer **global** declarations (no per-file imports). After installing
+ * the package, reference the built `.d.ts` bundle — typically via a side-effect import that pulls
+ * ambient types into the compilation unit:
+ *
+ * ```ts
+ * import "yummies/types.global";
+ * ```
+ *
+ * Or list it under `compilerOptions.types` in **`tsconfig.json`** so `tsc` loads it for the project:
+ *
+ * ```json
+ * {
+ *   "compilerOptions": {
+ *     "types": ["yummies/types.global"]
+ *   }
+ * }
+ * ```
+ *
+ * ## `yummies/types` (library)
+ *
+ * Prefer this entry when you want **explicit**, traceable imports at each call site (tree-shaking
+ * friendly and clearer in reviews). The root package may re-export some symbols, but
+ * **`yummies/types`** is the dedicated surface for type-only utilities.
+ *
+ * ```ts
+ * import type { AnyObject, Maybe } from "yummies/types";
+ * ```
+ */
 /**
  * Extracts all values from an object or array type.
  *

package/vibrate.cjs

@@ -1,6 +1,22 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 //#region src/vibrate.ts
 /**
+* ---header-docs-section---
+* # yummies/vibrate
+*
+* ## Description
+*
+* Thin wrapper around **`navigator.vibrate`** for mobile-style haptics: single pulses or patterned
+* on/off sequences. It no-ops when the API is missing or disabled, so UI code stays simple. Do not
+* rely on vibration for critical feedback because iOS and many desktops omit the API entirely.
+*
+* ## Usage
+*
+* ```ts
+* import { vibrate } from "yummies/vibrate";
+* ```
+*/
+/**
 * Triggers haptic feedback via the {@link https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API | Vibration API}
 * when `navigator.vibrate` exists (common on Android Chrome; often missing on iOS Safari / desktop).
 *

package/vibrate.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"vibrate.cjs","names":[],"sources":["../src/vibrate.ts"],"sourcesContent":["/**\n * Triggers haptic feedback via the {@link https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API | Vibration API}\n * when `navigator.vibrate` exists (common on Android Chrome; often missing on iOS Safari / desktop).\n *\n * - **Single number** — vibrate for that many milliseconds, then stop.\n * - **Array of numbers** — alternating vibration and pause lengths in ms: `[vibrate, pause, vibrate, ...]`.\n *   Per the spec, values are clamped; odd-length arrays imply a trailing vibrate segment.\n *\n * If the API is unavailable or the user has disabled vibration, this function **does nothing**\n * (no throw). Call sites should not rely on vibration for critical UX.\n *\n * @param pattern - Duration in ms, or a pattern array as described above.\n *\n * @example\n * Short confirmation buzz (200 ms):\n * ```ts\n * vibrate(200);\n * ```\n *\n * @example\n * Double-pulse pattern: 100 ms on, 50 ms off, 100 ms on:\n * ```ts\n * vibrate([100, 50, 100]);\n * ```\n */\nexport const vibrate = (pattern: number | number[]) => {\n  if ('vibrate' in navigator) {\n    navigator.vibrate(pattern);\n  }\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,IAAa,WAAW,YAA+B;AACrD,KAAI,aAAa,UACf,WAAU,QAAQ,QAAQ"}
+{"version":3,"file":"vibrate.cjs","names":[],"sources":["../src/vibrate.ts"],"sourcesContent":["/**\n * ---header-docs-section---\n * # yummies/vibrate\n *\n * ## Description\n *\n * Thin wrapper around **`navigator.vibrate`** for mobile-style haptics: single pulses or patterned\n * on/off sequences. It no-ops when the API is missing or disabled, so UI code stays simple. Do not\n * rely on vibration for critical feedback because iOS and many desktops omit the API entirely.\n *\n * ## Usage\n *\n * ```ts\n * import { vibrate } from \"yummies/vibrate\";\n * ```\n */\n\n/**\n * Triggers haptic feedback via the {@link https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API | Vibration API}\n * when `navigator.vibrate` exists (common on Android Chrome; often missing on iOS Safari / desktop).\n *\n * - **Single number** — vibrate for that many milliseconds, then stop.\n * - **Array of numbers** — alternating vibration and pause lengths in ms: `[vibrate, pause, vibrate, ...]`.\n *   Per the spec, values are clamped; odd-length arrays imply a trailing vibrate segment.\n *\n * If the API is unavailable or the user has disabled vibration, this function **does nothing**\n * (no throw). Call sites should not rely on vibration for critical UX.\n *\n * @param pattern - Duration in ms, or a pattern array as described above.\n *\n * @example\n * Short confirmation buzz (200 ms):\n * ```ts\n * vibrate(200);\n * ```\n *\n * @example\n * Double-pulse pattern: 100 ms on, 50 ms off, 100 ms on:\n * ```ts\n * vibrate([100, 50, 100]);\n * ```\n */\nexport const vibrate = (pattern: number | number[]) => {\n  if ('vibrate' in navigator) {\n    navigator.vibrate(pattern);\n  }\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CA,IAAa,WAAW,YAA+B;AACrD,KAAI,aAAa,UACf,WAAU,QAAQ,QAAQ"}

package/vibrate.d.ts

@@ -1,3 +1,19 @@
+/**
+ * ---header-docs-section---
+ * # yummies/vibrate
+ *
+ * ## Description
+ *
+ * Thin wrapper around **`navigator.vibrate`** for mobile-style haptics: single pulses or patterned
+ * on/off sequences. It no-ops when the API is missing or disabled, so UI code stays simple. Do not
+ * rely on vibration for critical feedback because iOS and many desktops omit the API entirely.
+ *
+ * ## Usage
+ *
+ * ```ts
+ * import { vibrate } from "yummies/vibrate";
+ * ```
+ */
 /**
  * Triggers haptic feedback via the {@link https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API | Vibration API}
  * when `navigator.vibrate` exists (common on Android Chrome; often missing on iOS Safari / desktop).

package/vibrate.js

@@ -1,5 +1,21 @@
 //#region src/vibrate.ts
 /**
+* ---header-docs-section---
+* # yummies/vibrate
+*
+* ## Description
+*
+* Thin wrapper around **`navigator.vibrate`** for mobile-style haptics: single pulses or patterned
+* on/off sequences. It no-ops when the API is missing or disabled, so UI code stays simple. Do not
+* rely on vibration for critical feedback because iOS and many desktops omit the API entirely.
+*
+* ## Usage
+*
+* ```ts
+* import { vibrate } from "yummies/vibrate";
+* ```
+*/
+/**
 * Triggers haptic feedback via the {@link https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API | Vibration API}
 * when `navigator.vibrate` exists (common on Android Chrome; often missing on iOS Safari / desktop).
 *

package/vibrate.js.map

@@ -1 +1 @@
-{"version":3,"file":"vibrate.js","names":[],"sources":["../src/vibrate.ts"],"sourcesContent":["/**\n * Triggers haptic feedback via the {@link https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API | Vibration API}\n * when `navigator.vibrate` exists (common on Android Chrome; often missing on iOS Safari / desktop).\n *\n * - **Single number** — vibrate for that many milliseconds, then stop.\n * - **Array of numbers** — alternating vibration and pause lengths in ms: `[vibrate, pause, vibrate, ...]`.\n *   Per the spec, values are clamped; odd-length arrays imply a trailing vibrate segment.\n *\n * If the API is unavailable or the user has disabled vibration, this function **does nothing**\n * (no throw). Call sites should not rely on vibration for critical UX.\n *\n * @param pattern - Duration in ms, or a pattern array as described above.\n *\n * @example\n * Short confirmation buzz (200 ms):\n * ```ts\n * vibrate(200);\n * ```\n *\n * @example\n * Double-pulse pattern: 100 ms on, 50 ms off, 100 ms on:\n * ```ts\n * vibrate([100, 50, 100]);\n * ```\n */\nexport const vibrate = (pattern: number | number[]) => {\n  if ('vibrate' in navigator) {\n    navigator.vibrate(pattern);\n  }\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,IAAa,WAAW,YAA+B;AACrD,KAAI,aAAa,UACf,WAAU,QAAQ,QAAQ"}
+{"version":3,"file":"vibrate.js","names":[],"sources":["../src/vibrate.ts"],"sourcesContent":["/**\n * ---header-docs-section---\n * # yummies/vibrate\n *\n * ## Description\n *\n * Thin wrapper around **`navigator.vibrate`** for mobile-style haptics: single pulses or patterned\n * on/off sequences. It no-ops when the API is missing or disabled, so UI code stays simple. Do not\n * rely on vibration for critical feedback because iOS and many desktops omit the API entirely.\n *\n * ## Usage\n *\n * ```ts\n * import { vibrate } from \"yummies/vibrate\";\n * ```\n */\n\n/**\n * Triggers haptic feedback via the {@link https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API | Vibration API}\n * when `navigator.vibrate` exists (common on Android Chrome; often missing on iOS Safari / desktop).\n *\n * - **Single number** — vibrate for that many milliseconds, then stop.\n * - **Array of numbers** — alternating vibration and pause lengths in ms: `[vibrate, pause, vibrate, ...]`.\n *   Per the spec, values are clamped; odd-length arrays imply a trailing vibrate segment.\n *\n * If the API is unavailable or the user has disabled vibration, this function **does nothing**\n * (no throw). Call sites should not rely on vibration for critical UX.\n *\n * @param pattern - Duration in ms, or a pattern array as described above.\n *\n * @example\n * Short confirmation buzz (200 ms):\n * ```ts\n * vibrate(200);\n * ```\n *\n * @example\n * Double-pulse pattern: 100 ms on, 50 ms off, 100 ms on:\n * ```ts\n * vibrate([100, 50, 100]);\n * ```\n */\nexport const vibrate = (pattern: number | number[]) => {\n  if ('vibrate' in navigator) {\n    navigator.vibrate(pattern);\n  }\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CA,IAAa,WAAW,YAA+B;AACrD,KAAI,aAAa,UACf,WAAU,QAAQ,QAAQ"}