@siberiacancode/reactuse 0.0.115 → 0.0.117

package/dist/types/hooks/useSpeechSynthesis/useSpeechSynthesis.d.ts

@@ -0,0 +1,59 @@
+/** The use speech synthesis status type */
+export type UseSpeechSynthesisStatus = 'end' | 'init' | 'pause' | 'play';
+/** The use speech synthesis options type */
+export interface UseSpeechSynthesisOptions {
+    /** Language for SpeechSynthesis */
+    lang?: string;
+    /** Gets and sets the pitch at which the utterance will be spoken at. */
+    pitch?: number;
+    /** Gets and sets the speed at which the utterance will be spoken at. */
+    rate?: number;
+    /** The text to be spoken */
+    text?: string;
+    /** Gets and sets the voice that will be used to speak the utterance. */
+    voice?: SpeechSynthesisVoice | null;
+    /** Gets and sets the volume that the utterance will be spoken at. */
+    volume?: number;
+}
+/** The use speech synthesis return type */
+export interface UseSpeechSynthesisReturn {
+    /** Any error that occurred during speech synthesis. */
+    error: SpeechSynthesisErrorEvent | undefined;
+    /** Indicates if speech is currently playing. */
+    playing: boolean;
+    /** The current status of speech synthesis. */
+    status: UseSpeechSynthesisStatus;
+    /** Indicates if the SpeechSynthesis API is supported in the current environment. */
+    supported: boolean;
+    /** The SpeechSynthesisUtterance instance. */
+    utterance: SpeechSynthesisUtterance | null;
+    /** Function to pause speech synthesis. */
+    pause: () => void;
+    /** Function to resume speech synthesis. */
+    resume: () => void;
+    /** Function to start speech synthesis. */
+    speak: () => void;
+    /** Function to stop speech synthesis. */
+    stop: () => void;
+    /** Function to toggle between play and pause. */
+    toggle: (value?: boolean) => void;
+}
+/**
+ * @name useSpeechSynthesis
+ * @description - Hook that provides speech synthesis functionality
+ * @category Sensors
+ *
+ * @browserapi SpeechSynthesis https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis
+ *
+ * @params {string} [options.text] - The text to be spoken
+ * @params {string} [options.lang] - The language to be spoken
+ * @params {number} [options.pitch] - The pitch to be spoken
+ * @params {number} [options.rate] - The rate to be spoken
+ * @params {SpeechSynthesisVoice} [options.voice] - The voice to be spoken
+ * @params {number} [options.volume] - The volume to be spoken
+ * @returns {UseSpeechSynthesisReturn} An object containing the speech synthesis state and control methods
+ *
+ * @example
+ * const { supported, playing, status, utterance, error, stop, toggle, speak, resume, pause } = useSpeechSynthesis();
+ */
+export declare const useSpeechSynthesis: (options?: UseSpeechSynthesisOptions) => UseSpeechSynthesisReturn;

package/dist/types/hooks/useWakeLock/useWakeLock.d.ts

@@ -0,0 +1,32 @@
+/** The use wake lock options type */
+export interface UseWakeLockOptions {
+    /** Determines if the wake lock should be automatically reacquired when the document becomes visible. */
+    immediately?: boolean;
+    /** A string specifying the screen wake lock type. */
+    type?: WakeLockType;
+}
+/** The use wake lock return type */
+export interface UseWakeLockReturn {
+    /** Indicates if the wake lock is currently active. */
+    active: boolean;
+    /** Indicates if the Wake Lock API is supported in the current environment. */
+    supported: boolean;
+    /** Function to release the wake lock. */
+    release: () => Promise<void>;
+    /** Function to request the wake lock. */
+    request: () => Promise<void>;
+}
+/**
+ * @name useWakeLock
+ * @description - Hook that provides a wake lock functionality
+ * @category Browser
+ *
+ * @browserapi navigator.wakeLock https://developer.mozilla.org/en-US/docs/Web/API/WakeLock
+ *
+ * @param {immediately} [options] Configuration options for the hook.
+ * @returns {UseWakeLockReturn} An object containing the wake lock state and control methods.
+ *
+ * @example
+ * const { supported, active, request, release } = useWakeLock();
+ */
+export declare const useWakeLock: (options?: UseWakeLockOptions) => UseWakeLockReturn;

package/dist/types/hooks/useWindowFocus/useWindowFocus.d.ts

@@ -7,5 +7,7 @@
  *
  * @example
  * const focused = useWindowFocus();
+ *
+ * @see {@link https://siberiacancode.github.io/reactuse/functions/hooks/useWindowFocus.html}
  */
 export declare const useWindowFocus: () => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.0.115",
+  "version": "0.0.117",
   "description": "The ultimate collection of react hooks",
   "author": {
     "name": "SIBERIA CAN CODE 🧊",