cordova-plugin-app-review - npm Package Compare versions

Comparing version 2.1.0 to 2.1.1

package.json

 {
   "name": "cordova-plugin-app-review",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "Cordova plugin to review app",
@@ -35,14 +35,13 @@ "types": "./types/index.d.ts",
   "scripts": {
-    "preversion": "npm run docs && npm run apidocs && rm -rf ./docs",
+    "preversion": "npm run docs && rm -rf ./docs",
     "version": "perl -i -pe 's/(version=)\"\\d+\\.\\d+\\.\\d+\"/$1\"'$npm_package_version'\"$2/' plugin.xml && git add plugin.xml README.md",
     "postversion": "git push && git push --tags",
-    "docs": "typedoc --hideBreadcrumbs --hideInPageTOC --entryPointStrategy packages .",
-    "preapidocs": "perl -i -0pe 's/<!-- TypedocGenerated -->.*//gms' README.md",
-    "apidocs": "cat ./docs/interfaces/AppReviewPlugin.md >> README.md",
-    "postapidocs": "perl -i -pe 's/# Interface.*/<!-- TypedocGenerated -->/' README.md"
+    "predocs": "perl -i -0pe 's/(<!-- TypedocGenerated -->).*/$1\n\n/gms' README.md",
+    "docs": "typedoc .",
+    "postdocs": "cat ./docs/interfaces/*.md >> README.md"
   },
   "devDependencies": {
-    "typedoc": "^0.23.9",
-    "typedoc-plugin-markdown": "^3.13.4"
+    "@colony/typedoc-plugin-markdown": "3.16.0",
+    "typedoc": "^0.23.9"
   }
 }

README.md

@@ -32,3 +32,9 @@ # cordova-plugin-app-review
 * iOS
+    - Supported iOS 10.3+ only
+    - [iOS limits the frequency of displaying The Rating dialog](https://developer.apple.com/design/human-interface-guidelines/ios/system-capabilities/)
+
 * Android
+    - After the account on the device has downloaded the app at least once from the internal test track and is part of the testers list, you can deploy new versions of the app via cordova cli and call `requestReview` in debug mode
+    - In-app reviews require your app to be published in Play Store
+    - [Google Play enforces a quota on how often a user can be shown the review dialog](https://developer.android.com/guide/playcore/in-app-review#quotas)
 
@@ -47,6 +53,4 @@ ## Installation
 
-### openStoreScreen
+### ▸ **openStoreScreen**(`packageName?`): `Promise`<`void`\>
 
-▸ **openStoreScreen**(`packageName?`): `Promise`<`void`\>
-
 Launches App/Play store page with a review form. By default current app screen
@@ -74,30 +78,6 @@ is displayed but you can pass a package name string to show another app details.
 
-#### Defined in
+### ▸ **requestReview**(): `Promise`<`void`\>
 
-[index.d.ts:41](https://github.com/chemerisuk/cordova-plugin-app-review/blob/e2df19b/types/index.d.ts#L41)
-
-___
-
-### requestReview
-
-▸ **requestReview**(): `Promise`<`void`\>
-
 Launches in-app review dialog.
 
-IOS notes:
-- Supported iOS 10.3+ only
-- iOS limits the frequency of displaying The Rating dialog
-
-Android notes:
-- After the account on the device has downloaded the app at least once from the
-internal test track and is part of the testers list, you can deploy new
-versions of the app via cordova cli and call `requestReview` in debug mode
-- In-app reviews require your app to be published in Play Store
-- Google Play enforces a quota on how often a user can be shown the review dialog
-
-**`See`**
-
- - [https://developer.apple.com/design/human-interface-guidelines/ios/system-capabilities/](https://developer.apple.com/design/human-interface-guidelines/ios/system-capabilities/)
- - [https://developer.android.com/guide/playcore/in-app-review#quotas](https://developer.android.com/guide/playcore/in-app-review#quotas)
-
 **`Example`**
@@ -118,5 +98,1 @@
 Callback when operation is completed
-
-#### Defined in
-
-[index.d.ts:28](https://github.com/chemerisuk/cordova-plugin-app-review/blob/e2df19b/types/index.d.ts#L28)

types/index.d.ts

@@ -5,18 +5,4 @@ export interface AppReviewPlugin {
      *
-     * IOS notes:
-     * - Supported iOS 10.3+ only
-     * - iOS limits the frequency of displaying The Rating dialog
-     *
-     * Android notes:
-     * - After the account on the device has downloaded the app at least once from the
-     * internal test track and is part of the testers list, you can deploy new
-     * versions of the app via cordova cli and call `requestReview` in debug mode
-     * - In-app reviews require your app to be published in Play Store
-     * - Google Play enforces a quota on how often a user can be shown the review dialog
-     *
      * @returns Callback when operation is completed
      *
-     * @see {@link https://developer.apple.com/design/human-interface-guidelines/ios/system-capabilities/}
-     * @see {@link https://developer.android.com/guide/playcore/in-app-review#quotas}
-     *
      * @example
@@ -45,4 +31,5 @@ * cordova.plugins.AppReview.requestReview();
 
+/** @ignore */
 interface CordovaPlugins {
     AppReview: AppReviewPlugin;
 }

No alert changes

Worsened metrics

Total package byte prevSize

14374

-7.8%

Lines of code

105

-3.67%

Number of lines in readme file

95

-20.17%

No dependency changes