@types/react-speech-recognition - npm Package Compare versions

Comparing version 3.6.0 to 3.6.1

react-speech-recognition/index.d.ts

@@ -9,11 +9,11 @@ // Type definitions for react-speech-recognition 3.6
     callback: (...args: any[]) => unknown;
-    isFuzzyMatch?: boolean;
-    matchInterim?: boolean;
-    fuzzyMatchingThreshold?: number;
-    bestMatchOnly?: boolean;
+    isFuzzyMatch?: boolean | undefined;
+    matchInterim?: boolean | undefined;
+    fuzzyMatchingThreshold?: number | undefined;
+    bestMatchOnly?: boolean | undefined;
 }
 
 export interface ListeningOptions {
-    continuous?: boolean;
-    language?: string;
+    continuous?: boolean | undefined;
+    language?: string | undefined;
 }
@@ -30,5 +30,5 @@
 export interface SpeechRecognitionOptions {
-    transcribing?: boolean;
-    clearTranscriptOnListen?: boolean;
-    commands?: ReadonlyArray<Command>;
+    transcribing?: boolean | undefined;
+    clearTranscriptOnListen?: boolean | undefined;
+    commands?: ReadonlyArray<Command> | undefined;
 }
@@ -35,0 +35,0 @@

react-speech-recognition/package.json

 {
     "name": "@types/react-speech-recognition",
-    "version": "3.6.0",
+    "version": "3.6.1",
     "description": "TypeScript definitions for react-speech-recognition",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-speech-recognition",
     "license": "MIT",
@@ -22,4 +23,4 @@ "contributors": [
     "dependencies": {},
-    "typesPublisherContentHash": "85482282bfaaca71d1b11b8f01092b97b72eaf6b0238714dd7310466bbdfefd7",
-    "typeScriptVersion": "3.4"
+    "typesPublisherContentHash": "4b578c20133a22f7a7c9f0284ff5237d0de8cf0f2db8e544808b95c6c34463f0",
+    "typeScriptVersion": "3.6"
 }

react-speech-recognition/README.md

@@ -9,5 +9,55 @@ # Installation
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-speech-recognition.
+## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-speech-recognition/index.d.ts)
+````ts
+// Type definitions for react-speech-recognition 3.6
+// Project: https://github.com/JamesBrill/react-speech-recognition#readme
+// Definitions by: OleksandrYehorov <https://github.com/OleksandrYehorov>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
+interface Command {
+    command: string | string[] | RegExp;
+    callback: (...args: any[]) => unknown;
+    isFuzzyMatch?: boolean | undefined;
+    matchInterim?: boolean | undefined;
+    fuzzyMatchingThreshold?: number | undefined;
+    bestMatchOnly?: boolean | undefined;
+}
+
+export interface ListeningOptions {
+    continuous?: boolean | undefined;
+    language?: string | undefined;
+}
+
+interface SpeechRecognition {
+    getRecognition(): SpeechRecognition | null;
+    startListening(options?: ListeningOptions): Promise<void>;
+    stopListening(): void;
+    abortListening(): void;
+    browserSupportsSpeechRecognition(): boolean;
+}
+
+export interface SpeechRecognitionOptions {
+    transcribing?: boolean | undefined;
+    clearTranscriptOnListen?: boolean | undefined;
+    commands?: ReadonlyArray<Command> | undefined;
+}
+
+export function useSpeechRecognition(
+    options?: SpeechRecognitionOptions,
+): {
+    transcript: string;
+    interimTranscript: string;
+    finalTranscript: string;
+    listening: boolean;
+    resetTranscript: () => void;
+};
+
+declare const SpeechRecognition: SpeechRecognition;
+
+export default SpeechRecognition;
+
+````
+
 ### Additional Details
- * Last updated: Wed, 13 Jan 2021 16:37:31 GMT
+ * Last updated: Thu, 08 Jul 2021 22:41:34 GMT
  * Dependencies: none
@@ -14,0 +64,0 @@ * Global values: none

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5553

increased by46.79%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

67

increased by294.12%

No dependency changes