@types/react-mic - npm Package Compare versions

Comparing version 12.4.2 to 12.4.3

react-mic/index.d.ts

@@ -29,37 +29,37 @@ // Type definitions for react-mic 12.4
     /** Set to true to begin recording */
-    record?: boolean;
+    record?: boolean | undefined;
 
     /** Available in React-Mic-Plus upgrade only */
-    pause?: boolean;
+    pause?: boolean | undefined;
 
-    visualSetting?: 'sinewave' | 'frequencyBars';
+    visualSetting?: 'sinewave' | 'frequencyBars' | undefined;
 
-    className?: string;
+    className?: string | undefined;
 
     /** Callback that is executed when audio stops recording */
-    onStop?: (recordedData: ReactMicStopEvent) => void;
+    onStop?: ((recordedData: ReactMicStopEvent) => void) | undefined;
 
     /** Callback that is executed when chunk of audio is available */
-    onData?: (recordedData: Blob) => void;
+    onData?: ((recordedData: Blob) => void) | undefined;
 
     /** defaults -> "audio/webm".  Set to "audio/wav" for WAV or "audio/mp3" for MP3 audio format (available in React-Mic-Gold) */
-    mimeType?: 'audio/webm' | 'audio/wav';
+    mimeType?: 'audio/webm' | 'audio/wav' | undefined;
 
     /** Sound wave color */
-    strokeColor?: string;
+    strokeColor?: string | undefined;
 
     /** Background color */
-    backgroundColor?: string;
+    backgroundColor?: string | undefined;
 
     /** Specify 1 for mono, defaults -> 2 (stereo) */
-    channelCount?: 1 | 2;
+    channelCount?: 1 | 2 | undefined;
 
     /** Enables/disables echo cancellation, defaults -> false */
-    echoCancellation?: boolean;
+    echoCancellation?: boolean | undefined;
 
     /** Enables/disables auto gain control, defaults -> false */
-    autoGainControl?: boolean;
+    autoGainControl?: boolean | undefined;
 
     /** Enables/disables background noise suppression, defaults -> false */
-    noiseSuppression?: boolean;
+    noiseSuppression?: boolean | undefined;
 }

react-mic/package.json

 {
     "name": "@types/react-mic",
-    "version": "12.4.2",
+    "version": "12.4.3",
     "description": "TypeScript definitions for react-mic",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-mic",
     "license": "MIT",
@@ -24,4 +25,4 @@ "contributors": [
     },
-    "typesPublisherContentHash": "ad7822a87bc12427aface90241d971e0eeef60470af764a80c40585f8e0f5cf4",
-    "typeScriptVersion": "2.9"
+    "typesPublisherContentHash": "10969af0033dfb323a5b5ec736908d705bf1e6ec37f150161dfd826e496c0b55",
+    "typeScriptVersion": "3.6"
 }

react-mic/README.md

@@ -9,5 +9,73 @@ # Installation
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-mic.
+## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-mic/index.d.ts)
+````ts
+// Type definitions for react-mic 12.4
+// Project: https://hackingbeauty.github.io/react-mic
+// Definitions by: mikaello <https://github.com/mikaello>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
+import * as React from 'react';
+
+/**
+ * Record a user's voice and display as an oscillation (or frequency bars).
+ */
+export class ReactMic extends React.PureComponent<ReactMicProps> {}
+
+/**
+ * The object sent when the recording stops
+ */
+export interface ReactMicStopEvent {
+    blob: Blob;
+    startTime: number;
+    stopTime: number;
+    option: {
+      audioBitsPerSecond: number;
+      mimeType: string;
+    };
+    blobURL: string;
+  }
+
+export interface ReactMicProps {
+    /** Set to true to begin recording */
+    record?: boolean | undefined;
+
+    /** Available in React-Mic-Plus upgrade only */
+    pause?: boolean | undefined;
+
+    visualSetting?: 'sinewave' | 'frequencyBars' | undefined;
+
+    className?: string | undefined;
+
+    /** Callback that is executed when audio stops recording */
+    onStop?: ((recordedData: ReactMicStopEvent) => void) | undefined;
+
+    /** Callback that is executed when chunk of audio is available */
+    onData?: ((recordedData: Blob) => void) | undefined;
+
+    /** defaults -> "audio/webm".  Set to "audio/wav" for WAV or "audio/mp3" for MP3 audio format (available in React-Mic-Gold) */
+    mimeType?: 'audio/webm' | 'audio/wav' | undefined;
+
+    /** Sound wave color */
+    strokeColor?: string | undefined;
+
+    /** Background color */
+    backgroundColor?: string | undefined;
+
+    /** Specify 1 for mono, defaults -> 2 (stereo) */
+    channelCount?: 1 | 2 | undefined;
+
+    /** Enables/disables echo cancellation, defaults -> false */
+    echoCancellation?: boolean | undefined;
+
+    /** Enables/disables auto gain control, defaults -> false */
+    autoGainControl?: boolean | undefined;
+
+    /** Enables/disables background noise suppression, defaults -> false */
+    noiseSuppression?: boolean | undefined;
+}
+
+````
+
 ### Additional Details
- * Last updated: Mon, 04 May 2020 18:52:15 GMT
+ * Last updated: Thu, 08 Jul 2021 20:20:57 GMT
  * Dependencies: [@types/react](https://npmjs.com/package/@types/react)
@@ -14,0 +82,0 @@ * Global values: none

Fixed alerts

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6593

55.75%

Number of low quality alerts

0

-100%

Number of lines in readme file

85

400%

No dependency changes