chore: update types

dist/index.d.ts

@@ -1,3 +1,4 @@
+import { ERROR_TYPES } from './types';
 declare class STT {
     private recognition;
     private isRecognizing;
@@ -15,9 +16,15 @@ declare class STT {
     abort: () => void;
     onStart: () => void;
     onEnd: () => void;
-    onResult: (event: any) => boolean;
-    onError: (event: any) => void;
+    onResult: (event: {
+        results: any[];
+        resultIndex: number;
+    }) => void;
+    onError: (event: {
+        error: string;
+    }) => void;
     getIsRecognizing: () => boolean;
     getRecognition: () => any;
 }
+export { ERROR_TYPES };
 export default STT;

src/index.ts

@@ -1,4 +1,5 @@
 import mitt from 'mitt';
+import { ERROR_TYPES } from './types';
 import { isSupportedBrowser } from './env';
 
 const speechRecognition = window.webkitSpeechRecognition;
@@ -34,7 +35,7 @@ class STT {
 
   start = () => {
     if (!isSupportedBrowser) {
-      emitter.emit('error', 'not-supported-browser');
+      emitter.emit('error', ERROR_TYPES.NOT_SUPPORTED_BROWSER);
       return;
     }
 
@@ -65,32 +66,34 @@ class STT {
     emitter.emit('end');
   };
 
-  onResult = (event) => {
+  onResult = (event: { results: any[]; resultIndex: number }) => {
+    const { results, resultIndex } = event;
     let interimTranscript: string = '';
-    if (typeof event.results === 'undefined') {
+
+    if (typeof results === 'undefined') {
       recognition.onend = null;
       recognition.stop();
-      return false;
+      return;
     }
 
-    for (let i = event.resultIndex; i < event.results.length; ++i) {
-      const transcript = event.results[i][0].transcript;
-      if (event.results[i].isFinal) {
+    for (let i = resultIndex; i < results.length; ++i) {
+      const transcript = results[i][0].transcript;
+      if (results[i].isFinal) {
         this.finalTranscript += transcript;
-        console.log('isFinal :>> ', transcript, event.results);
+        console.log('isFinal :>> ', transcript, results);
       } else {
         interimTranscript += transcript;
       }
     }
 
     emitter.emit('result', {
-      results: event.results,
-      finalTranscript: this.finalTranscript,
+      results,
       interimTranscript,
+      finalTranscript: this.finalTranscript,
     });
   };
 
-  onError = (event) => {
+  onError = (event: { error: string }) => {
     this.isRecognizing = false;
     emitter.emit('error', event.error);
   };
@@ -104,4 +107,6 @@ class STT {
   };
 }
 
+export { ERROR_TYPES };
+
 export default STT;

src/types.ts

@@ -0,0 +1,6 @@
+export enum ERROR_TYPES {
+  NOT_SUPPORTED_BROWSER = 'not-supported-browser',
+  NOT_ALLOWED = 'not-allowed',
+  NO_SPEECH = 'no-speech',
+  AUDIO_CAPTURE = 'audio-capture',
+}

website/main.js

@@ -38,9 +38,9 @@ function bindSttEvents() {
     fireCommand(interimTranscript);
   });
 
+  // no-speech|audio-capture|not-allowed|not-supported-browser
   stt.on('error', (error) => {
     console.log('error :>> ', error);
-    // no-speech|audio-capture|not-allowed|not-supported-browser
     $btnMic.classList.replace('on', 'off');
 
     switch (error) {