capacitor-voice-recorder - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

package.json

 {
   "name": "capacitor-voice-recorder",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Capacitor plugin for voice recording",
@@ -5,0 +5,0 @@ "main": "dist/plugin.cjs.js",

README.md

@@ -1,18 +0,14 @@
-<p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p>
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" />
+</p>
 <h3 align="center">Capacitor Voice Recorder</h3>
 <p align="center"><strong><code>tchvu3/capacitor-voice-recorder</code></strong></p>
-<p align="center">
-  Capacitor plugin for simple voice recording (For Capacitor 3)
-</p>
+<p align="center">Capacitor plugin for simple voice recording (For Capacitor 3)</p>
 
 <p align="center">
-  <img src="https://img.shields.io/maintenance/yes/2021?style=flat-square" />
-  <!-- <a href="https://github.com/tchvu3/capacitor-voice-recorder/actions?query=workflow%3A%22CI%22"><img src="https://img.shields.io/github/workflow/status/tchvu3/capacitor-voice-recorder/CI?style=flat-square" /></a> -->
-  <a href="https://www.npmjs.com/package/capacitor-voice-recorder"><img src="https://img.shields.io/npm/l/capacitor-voice-recorder?style=flat-square" /></a>
+  <img src="https://img.shields.io/maintenance/yes/2021" />
+  <a href="https://www.npmjs.com/package/capacitor-voice-recorder"><img src="https://img.shields.io/npm/l/capacitor-voice-recorder" /></a>
 <br>
-  <a href="https://www.npmjs.com/package/capacitor-voice-recorder"><img src="https://img.shields.io/npm/dw/capacitor-voice-recorder?style=flat-square" /></a>
-  <a href="https://www.npmjs.com/package/capacitor-voice-recorder"><img src="https://img.shields.io/npm/v/capacitor-voice-recorder?style=flat-square" /></a>
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-<a href="#contributors-"><img src="https://img.shields.io/badge/all%20contributors-0-orange?style=flat-square" /></a>
-<!-- ALL-CONTRIBUTORS-BADGE:END -->
+  <a href="https://www.npmjs.com/package/capacitor-voice-recorder"><img src="https://img.shields.io/npm/dw/capacitor-voice-recorder" /></a>
+  <a href="https://www.npmjs.com/package/capacitor-voice-recorder"><img src="https://img.shields.io/npm/v/capacitor-voice-recorder" /></a>
 </p>
@@ -22,5 +18,5 @@
 
-| Maintainer | GitHub | Social |
-| -----------| -------| -------|
-| Avihu Harush | [tchvu3](https://github.com/tchvu3) | [@tchvu3](https://twitter.com/tchvu3) |
+| Maintainer | GitHub |
+| -----------| -------|
+| Avihu Harush | [tchvu3](https://github.com/tchvu3) |
 
@@ -55,3 +51,4 @@ ## Installation
 
-* canDeviceVoiceRecord - return promise that resolves to {"value": true} / {"value": false} based on the phone's ability to record voice.
+* canDeviceVoiceRecord - this function has been updated for Capacitor version 3 and will now ALWAYS return a promise that resolves to {"value": true}.
+  it has not been removed completely to not break old implementations.
 
@@ -69,5 +66,5 @@ ---
 
-* startRecording - if the app lacks the required permission then the promise will reject with the message "MISSING_PERMISSION". if the phone
-  is unable to record then the promise will reject with the message "CANNOT_VOICE_RECORD_ON_THIS_PHONE". if there's a recording already
-  running then the promise will reject with "ALREADY_RECORDING", and if other apps are using the microphone then the promise will reject
+* startRecording - if the app lacks the required permission then the promise will reject with the message "MISSING_PERMISSION".
+  if there's a recording already running then the promise will reject with "ALREADY_RECORDING",
+  and if other apps are using the microphone then the promise will reject
   with "MICROPHONE_BEING_USED". in a case of unknown error the promise will reject with "FAILED_TO_RECORD".
@@ -88,3 +85,3 @@
 
-// will print true / false based on the device ability to record
+// will ALWAYS print true (do not use this method, it has not been removed to keep old implementations from breaking)
 VoiceRecorder.canDeviceVoiceRecord().then((result: GenericResponse) => console.log(result.value))
@@ -104,3 +101,3 @@
 * in case of an error the promise will reject with one of the following messages:
-* "MISSING_PERMISSION", "ALREADY_RECORDING", "CANNOT_RECORD_ON_THIS_PHONE", "MICROPHONE_BEING_USED" or "FAILED_TO_RECORD"
+* "MISSING_PERMISSION", "ALREADY_RECORDING", "MICROPHONE_BEING_USED" or "FAILED_TO_RECORD"
 */
@@ -107,0 +104,0 @@ VoiceRecorder.startRecording()

No alert changes

Improved metrics

Total package byte prevSize

41651

increased by0.96%

Worsened metrics

Lines of code

223

decreased by-52.65%

Number of lines in readme file

126

decreased by-2.33%

No dependency changes