feat(useSpeechRecognition): support maxAlternatives option (#4067)

vueuse · Jul 17, 2024 · 9eda885 · 9eda885
1 parent 5f58470
commit 9eda885
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/packages/core/useSpeechRecognition/index.ts b/packages/core/useSpeechRecognition/index.ts
@@ -29,6 +29,13 @@ export interface UseSpeechRecognitionOptions extends ConfigurableWindow {
    * @default 'en-US'
    */
   lang?: MaybeRefOrGetter<string>
+  /**
+   * A number representing the maximum returned alternatives for each result.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition/maxAlternatives
+   * @default 1
+   */
+  maxAlternatives?: number
 }
 
 /**
@@ -42,6 +49,7 @@ export function useSpeechRecognition(options: UseSpeechRecognitionOptions = {})
   const {
     interimResults = true,
     continuous = true,
+    maxAlternatives = 1,
     window = defaultWindow,
   } = options
 
@@ -74,6 +82,7 @@ export function useSpeechRecognition(options: UseSpeechRecognitionOptions = {})
     recognition.continuous = continuous
     recognition.interimResults = interimResults
     recognition.lang = toValue(lang)
+    recognition.maxAlternatives = maxAlternatives
 
     recognition.onstart = () => {
       isFinal.value = false