yummies 7.11.0 → 7.13.0

package/vibrate.d.ts

@@ -1,5 +1,43 @@
 /**
- * Triggers vibration using the provided pattern.
+ * ---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).
+ *
+ * - **Single number** — vibrate for that many milliseconds, then stop.
+ * - **Array of numbers** — alternating vibration and pause lengths in ms: `[vibrate, pause, vibrate, ...]`.
+ *   Per the spec, values are clamped; odd-length arrays imply a trailing vibrate segment.
+ *
+ * If the API is unavailable or the user has disabled vibration, this function **does nothing**
+ * (no throw). Call sites should not rely on vibration for critical UX.
+ *
+ * @param pattern - Duration in ms, or a pattern array as described above.
+ *
+ * @example
+ * Short confirmation buzz (200 ms):
+ * ```ts
+ * vibrate(200);
+ * ```
+ *
+ * @example
+ * Double-pulse pattern: 100 ms on, 50 ms off, 100 ms on:
+ * ```ts
+ * vibrate([100, 50, 100]);
+ * ```
  */
 declare const vibrate: (pattern: number | number[]) => void;
 

package/vibrate.js

@@ -1,9 +1,49 @@
-const vibrate = (pattern) => {
-  if ("vibrate" in navigator) {
-    navigator.vibrate(pattern);
-  }
+//#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).
+*
+* - **Single number** — vibrate for that many milliseconds, then stop.
+* - **Array of numbers** — alternating vibration and pause lengths in ms: `[vibrate, pause, vibrate, ...]`.
+*   Per the spec, values are clamped; odd-length arrays imply a trailing vibrate segment.
+*
+* If the API is unavailable or the user has disabled vibration, this function **does nothing**
+* (no throw). Call sites should not rely on vibration for critical UX.
+*
+* @param pattern - Duration in ms, or a pattern array as described above.
+*
+* @example
+* Short confirmation buzz (200 ms):
+* ```ts
+* vibrate(200);
+* ```
+*
+* @example
+* Double-pulse pattern: 100 ms on, 50 ms off, 100 ms on:
+* ```ts
+* vibrate([100, 50, 100]);
+* ```
+*/
+var vibrate = (pattern) => {
+	if ("vibrate" in navigator) navigator.vibrate(pattern);
 };
-export {
-  vibrate
-};
-//# sourceMappingURL=vibrate.js.map
+//#endregion
+export { vibrate };
+
+//# sourceMappingURL=vibrate.js.map

package/vibrate.js.map

@@ -1 +1 @@
-{"version":3,"file":"vibrate.js","sources":["../src/vibrate.ts"],"sourcesContent":["/**\n * Triggers vibration using the provided pattern.\n */\nexport const vibrate = (pattern: number | number[]) => {\n  if ('vibrate' in navigator) {\n    navigator.vibrate(pattern);\n  }\n};\n"],"names":[],"mappings":"AAGO,MAAM,UAAU,CAAC,YAA+B;AACrD,MAAI,aAAa,WAAW;AAC1B,cAAU,QAAQ,OAAO;AAAA,EAC3B;AACF;"}
+{"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"}

package/types.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/types.global.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.global.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/types.global.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.global.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}