Merge branch 'main' into localize-types

Conflicts: action-sheet/package.json app-launcher/package.json app/README.md app/package.json browser/package.json clipboard/package.json device/README.md device/package.json dialog/package.json filesystem/package.json filesystem/src/definitions.ts haptics/package.json keyboard/package.json motion/README.md motion/package.json network/README.md network/package.json screen-reader/README.md screen-reader/package.json share/package.json status-bar/package.json storage/package.json text-zoom/package.json toast/package.json
ionic-team · imhoffd · Dec 20, 2020 · Dec 14, 2020 · Dec 14, 2020 · Dec 14, 2020
commit 5c294cdeb09ff158baa554d379b8e528994f8bd6
diff --git a/action-sheet/package.json b/action-sheet/package.json
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@capacitor/android": "^3.0.0-alpha.10",
     "@capacitor/core": "^3.0.0-alpha.9",
-    "@capacitor/docgen": "0.0.13",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",

diff --git a/app-launcher/package.json b/app-launcher/package.json
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@capacitor/android": "^3.0.0-alpha.10",
     "@capacitor/core": "^3.0.0-alpha.9",
-    "@capacitor/docgen": "0.0.13",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",

diff --git a/app/README.md b/app/README.md
@@ -103,7 +103,7 @@ Listen for changes in the App's active state (whether the app is in the foregrou
 
 | Param              | Type                                                                |
 | ------------------ | ------------------------------------------------------------------- |
-| **`eventName`**    | <code>"appStateChange"</code>                                       |
+| **`eventName`**    | <code>'appStateChange'</code>                                       |
 | **`listenerFunc`** | <code><a href="#statechangelistener">StateChangeListener</a></code> |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
@@ -124,7 +124,7 @@ as URLs your app handles (Universal Links on iOS and App Links on Android)
 
 | Param              | Type                                                        |
 | ------------------ | ----------------------------------------------------------- |
-| **`eventName`**    | <code>"appUrlOpen"</code>                                   |
+| **`eventName`**    | <code>'appUrlOpen'</code>                                   |
 | **`listenerFunc`** | <code><a href="#urlopenlistener">URLOpenListener</a></code> |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
@@ -146,7 +146,7 @@ the app was launched with, converted into the form of a result from a plugin cal
 
 | Param              | Type                                                          |
 | ------------------ | ------------------------------------------------------------- |
-| **`eventName`**    | <code>"appRestoredResult"</code>                              |
+| **`eventName`**    | <code>'appRestoredResult'</code>                              |
 | **`listenerFunc`** | <code><a href="#restoredlistener">RestoredListener</a></code> |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
@@ -168,7 +168,7 @@ If you want to close the app, call `App.exitApp()`.
 
 | Param              | Type                                                              |
 | ------------------ | ----------------------------------------------------------------- |
-| **`eventName`**    | <code>"backButton"</code>                                         |
+| **`eventName`**    | <code>'backButton'</code>                                         |
 | **`listenerFunc`** | <code><a href="#backbuttonlistener">BackButtonListener</a></code> |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>

diff --git a/app/package.json b/app/package.json
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@capacitor/android": "^3.0.0-alpha.10",
     "@capacitor/core": "^3.0.0-alpha.9",
-    "@capacitor/docgen": "0.0.13",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",

diff --git a/browser/package.json b/browser/package.json
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@capacitor/android": "^3.0.0-alpha.10",
     "@capacitor/core": "^3.0.0-alpha.9",
-    "@capacitor/docgen": "0.0.13",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",

diff --git a/clipboard/package.json b/clipboard/package.json
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@capacitor/android": "^3.0.0-alpha.10",
     "@capacitor/core": "^3.0.0-alpha.9",
-    "@capacitor/docgen": "0.0.13",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",

diff --git a/device/README.md b/device/README.md
@@ -78,7 +78,7 @@ Get the device's current language locale code.
 | --------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
 | **`name`**            | <code>string</code>                                         | The name of the device. For example, "John's iPhone". This is only supported on iOS and Android 7.1 or above.                                | 1.0.0 |
 | **`model`**           | <code>string</code>                                         | The device model. For example, "iPhone".                                                                                                     | 1.0.0 |
-| **`platform`**        | <code>"ios" \| "android" \| "web"</code>                    | The device platform (lowercase).                                                                                                             | 1.0.0 |
+| **`platform`**        | <code>'ios' \| 'android' \| 'web'</code>                    | The device platform (lowercase).                                                                                                             | 1.0.0 |
 | **`uuid`**            | <code>string</code>                                         | The UUID of the device as available to the app. This identifier may change on modern mobile platforms that only allow per-app install UUIDs. | 1.0.0 |
 | **`operatingSystem`** | <code><a href="#operatingsystem">OperatingSystem</a></code> | The operating system of the device.                                                                                                          | 1.0.0 |
 | **`osVersion`**       | <code>string</code>                                         | The version of the device OS.                                                                                                                | 1.0.0 |
@@ -109,6 +109,6 @@ Get the device's current language locale code.
 
 #### OperatingSystem
 
-<code>'ios'</code>,<code>'android'</code>,<code>'windows'</code>,<code>'mac'</code>,<code>'unknown'</code>
+<code>'ios' | 'android' | 'windows' | 'mac' | 'unknown'</code>
 
 </docgen-api>
diff --git a/device/package.json b/device/package.json
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@capacitor/android": "^3.0.0-alpha.10",
     "@capacitor/core": "^3.0.0-alpha.9",
-    "@capacitor/docgen": "0.0.13",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",

diff --git a/dialog/package.json b/dialog/package.json
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@capacitor/android": "^3.0.0-alpha.10",
     "@capacitor/core": "^3.0.0-alpha.9",
-    "@capacitor/docgen": "0.0.13",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",

diff --git a/filesystem/README.md b/filesystem/README.md
@@ -418,19 +418,6 @@ Required on Android, only when using <a href="#directory">`Directory.Documents`<
 <code>'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'</code>
 
 
-### Type Aliases
-
-
-#### RenameOptions
-
-<code><a href="#copyoptions">CopyOptions</a></code>
-
-
-#### PermissionState
-
-<code>'prompt'</code>,<code>'prompt-with-rationale'</code>,<code>'granted'</code>,<code>'denied'</code>
-
-
 ### Enums
 
 

diff --git a/filesystem/package.json b/filesystem/package.json
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@capacitor/android": "^3.0.0-alpha.10",
     "@capacitor/core": "^3.0.0-alpha.9",
-    "@capacitor/docgen": "0.0.13",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",

diff --git a/filesystem/src/definitions.ts b/filesystem/src/definitions.ts
@@ -1,3 +1,5 @@
+import type { PermissionState } from '@capacitor/core';
+
 export interface PermissionStatus {
   publicStorage: PermissionState;
 }

diff --git a/haptics/package.json b/haptics/package.json
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@capacitor/android": "^3.0.0-alpha.10",
     "@capacitor/core": "^3.0.0-alpha.9",
-    "@capacitor/docgen": "0.0.13",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",

diff --git a/keyboard/package.json b/keyboard/package.json
@@ -46,7 +46,7 @@
     "@capacitor/android": "^3.0.0-alpha.10",
     "@capacitor/cli": "^3.0.0-alpha.9",
     "@capacitor/core": "^3.0.0-alpha.9",
-    "@capacitor/docgen": "0.0.13",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",

diff --git a/motion/README.md b/motion/README.md
@@ -34,7 +34,7 @@ Add a listener for accelerometer data
 
 | Param              | Type                                                    |
 | ------------------ | ------------------------------------------------------- |
-| **`eventName`**    | <code>"accel"</code>                                    |
+| **`eventName`**    | <code>'accel'</code>                                    |
 | **`listenerFunc`** | <code><a href="#accellistener">AccelListener</a></code> |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
@@ -54,7 +54,7 @@ Add a listener for device orientation change (compass heading, etc.)
 
 | Param              | Type                                                                |
 | ------------------ | ------------------------------------------------------------------- |
-| **`eventName`**    | <code>"orientation"</code>                                          |
+| **`eventName`**    | <code>'orientation'</code>                                          |
 | **`listenerFunc`** | <code><a href="#orientationlistener">OrientationListener</a></code> |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>

diff --git a/motion/package.json b/motion/package.json
@@ -40,7 +40,7 @@
   "devDependencies": {
     "@capacitor/android": "^3.0.0-alpha.10",
     "@capacitor/core": "^3.0.0-alpha.9",
-    "@capacitor/docgen": "0.0.13",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",

diff --git a/network/README.md b/network/README.md
@@ -49,7 +49,7 @@ Listen for changes in the network connection.
 
 | Param              | Type                                                                                      |
 | ------------------ | ----------------------------------------------------------------------------------------- |
-| **`eventName`**    | <code>"networkStatusChange"</code>                                                        |
+| **`eventName`**    | <code>'networkStatusChange'</code>                                                        |
 | **`listenerFunc`** | <code><a href="#connectionstatuschangelistener">ConnectionStatusChangeListener</a></code> |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
@@ -99,7 +99,7 @@ Represents the state and type of the network connection.
 
 The type of network connection that a device might have.
 
-<code>'wifi'</code>,<code>'cellular'</code>,<code>'none'</code>,<code>'unknown'</code>
+<code>'wifi' | 'cellular' | 'none' | 'unknown'</code>
 
 
 #### ConnectionStatusChangeListener

diff --git a/network/package.json b/network/package.json
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@capacitor/android": "^3.0.0-alpha.10",
     "@capacitor/core": "^3.0.0-alpha.9",
-    "@capacitor/docgen": "0.0.13",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",

diff --git a/screen-reader/README.md b/screen-reader/README.md
@@ -83,7 +83,7 @@ Readers).
 
 | Param           | Type                                                                |
 | --------------- | ------------------------------------------------------------------- |
-| **`eventName`** | <code>"screenReaderStateChange"</code>                              |
+| **`eventName`** | <code>'screenReaderStateChange'</code>                              |
 | **`listener`**  | <code><a href="#statechangelistener">StateChangeListener</a></code> |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>

diff --git a/screen-reader/package.json b/screen-reader/package.json
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@capacitor/android": "^3.0.0-alpha.10",
     "@capacitor/core": "^3.0.0-alpha.9",
-    "@capacitor/docgen": "0.0.13",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",

diff --git a/share/package.json b/share/package.json
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@capacitor/android": "^3.0.0-alpha.10",
     "@capacitor/core": "^3.0.0-alpha.9",
-    "@capacitor/docgen": "0.0.13",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",

diff --git a/status-bar/package.json b/status-bar/package.json
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@capacitor/android": "^3.0.0-alpha.10",
     "@capacitor/core": "^3.0.0-alpha.9",
-    "@capacitor/docgen": "0.0.13",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",

diff --git a/storage/package.json b/storage/package.json
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@capacitor/android": "^3.0.0-alpha.10",
     "@capacitor/core": "^3.0.0-alpha.9",
-    "@capacitor/docgen": "0.0.13",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",

diff --git a/text-zoom/package.json b/text-zoom/package.json
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@capacitor/android": "^3.0.0-alpha.10",
     "@capacitor/core": "^3.0.0-alpha.9",
-    "@capacitor/docgen": "0.0.13",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",

diff --git a/toast/package.json b/toast/package.json
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@capacitor/android": "^3.0.0-alpha.10",
     "@capacitor/core": "^3.0.0-alpha.9",
-    "@capacitor/docgen": "0.0.13",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",