chore(deps-dev): bump @capacitor/docgen from 0.0.11 to 0.0.14 (#147)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Daniel Imhoff <dwieeb@gmail.com>
ionic-team · Dec 16, 2020 · 95203f4 · 95203f4
1 parent b6be1e1
commit 95203f4
Show file tree

Hide file tree

Showing 27 changed files with 110 additions and 58 deletions.
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.11",
+    "@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.11",
+    "@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
@@ -102,7 +102,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>(state: <a href="#appstate">AppState</a>) =&gt; void</code> |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
@@ -123,7 +123,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>(data: <a href="#appurlopen">AppUrlOpen</a>) =&gt; void</code> |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
@@ -145,7 +145,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>(data: <a href="#apprestoredresult">AppRestoredResult</a>) =&gt; void</code> |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
@@ -167,7 +167,7 @@ If you want to close the app, call `App.exitApp()`.
 
 | Param              | Type                       |
 | ------------------ | -------------------------- |
-| **`eventName`**    | <code>"backButton"</code>  |
+| **`eventName`**    | <code>'backButton'</code>  |
 | **`listenerFunc`** | <code>() =&gt; void</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.11",
+    "@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/README.md b/browser/README.md
@@ -67,7 +67,7 @@ Android & iOS only: Listen for the loading finished event.
 
 | Param              | Type                           |
 | ------------------ | ------------------------------ |
-| **`eventName`**    | <code>"browserFinished"</code> |
+| **`eventName`**    | <code>'browserFinished'</code> |
 | **`listenerFunc`** | <code>() =&gt; void</code>     |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
@@ -87,7 +87,7 @@ Android & iOS only: Listen for the page loaded event.
 
 | Param              | Type                             |
 | ------------------ | -------------------------------- |
-| **`eventName`**    | <code>"browserPageLoaded"</code> |
+| **`eventName`**    | <code>'browserPageLoaded'</code> |
 | **`listenerFunc`** | <code>() =&gt; void</code>       |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
@@ -122,7 +122,7 @@ Represents the options passed to `open`.
 | **`url`**               | <code>string</code>                    | The URL to which the browser is opened.                                                                                                    | 1.0.0 |
 | **`windowName`**        | <code>string</code>                    | Web only: Optional target for browser open. Follows the `target` property for window.open. Defaults to _blank. Ignored on other platforms. | 1.0.0 |
 | **`toolbarColor`**      | <code>string</code>                    | A hex color to which the toolbar color is set.                                                                                             | 1.0.0 |
-| **`presentationStyle`** | <code>"fullscreen" \| "popover"</code> | iOS only: The presentation style of the browser. Defaults to fullscreen. Ignored on other platforms.                                       | 1.0.0 |
+| **`presentationStyle`** | <code>'fullscreen' \| 'popover'</code> | iOS only: The presentation style of the browser. Defaults to fullscreen. Ignored on other platforms.                                       | 1.0.0 |
 
 
 #### PluginListenerHandle

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.11",
+    "@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.11",
+    "@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
@@ -17,6 +17,7 @@ npx cap sync
 * [`getBatteryInfo()`](#getbatteryinfo)
 * [`getLanguageCode()`](#getlanguagecode)
 * [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
 
 </docgen-index>
 
@@ -73,19 +74,19 @@ Get the device's current language locale code.
 
 #### DeviceInfo
 
-| Prop                  | Type                                                               | Description                                                                                                                                  | Since |
-| --------------------- | ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
-| **`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 |
-| **`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>"ios" \| "android" \| "windows" \| "mac" \| "unknown"</code> | The operating system of the device.                                                                                                          | 1.0.0 |
-| **`osVersion`**       | <code>string</code>                                                | The version of the device OS.                                                                                                                | 1.0.0 |
-| **`manufacturer`**    | <code>string</code>                                                | The manufacturer of the device.                                                                                                              | 1.0.0 |
-| **`isVirtual`**       | <code>boolean</code>                                               | Whether the app is running in a simulator/emulator.                                                                                          | 1.0.0 |
-| **`memUsed`**         | <code>number</code>                                                | Approximate memory used by the current app, in bytes. Divide by 1048576 to get the number of MBs used.                                       | 1.0.0 |
-| **`diskFree`**        | <code>number</code>                                                | How much free disk space is available on the the normal data storage. path for the os, in bytes                                              | 1.0.0 |
-| **`diskTotal`**       | <code>number</code>                                                | The total size of the normal data storage path for the OS, in bytes.                                                                         | 1.0.0 |
+| Prop                  | Type                                                        | Description                                                                                                                                  | Since |
+| --------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`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 |
+| **`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 |
+| **`manufacturer`**    | <code>string</code>                                         | The manufacturer of the device.                                                                                                              | 1.0.0 |
+| **`isVirtual`**       | <code>boolean</code>                                        | Whether the app is running in a simulator/emulator.                                                                                          | 1.0.0 |
+| **`memUsed`**         | <code>number</code>                                         | Approximate memory used by the current app, in bytes. Divide by 1048576 to get the number of MBs used.                                       | 1.0.0 |
+| **`diskFree`**        | <code>number</code>                                         | How much free disk space is available on the the normal data storage. path for the os, in bytes                                              | 1.0.0 |
+| **`diskTotal`**       | <code>number</code>                                         | The total size of the normal data storage path for the OS, in bytes.                                                                         | 1.0.0 |
 
 
 #### DeviceBatteryInfo
@@ -102,4 +103,12 @@ Get the device's current language locale code.
 | ----------- | ------------------- | ---------------------------- | ----- |
 | **`value`** | <code>string</code> | Two character language code. | 1.0.0 |
 
+
+### Type Aliases
+
+
+#### OperatingSystem
+
+<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.11",
+    "@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.11",
+    "@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
@@ -27,6 +27,7 @@ npx cap sync
 * [`checkPermissions()`](#checkpermissions)
 * [`requestPermissions()`](#requestpermissions)
 * [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
 * [Enums](#enums)
 
 </docgen-index>
@@ -399,9 +400,22 @@ FilesystemDirectory.ExternalStorage.
 
 #### FilesystemPermissionStatus
 
-| Prop                | Type             |
-| ------------------- | ---------------- |
-| **`publicStorage`** | <code>any</code> |
+| Prop                | Type                                                        |
+| ------------------- | ----------------------------------------------------------- |
+| **`publicStorage`** | <code><a href="#permissionstate">PermissionState</a></code> |
+
+
+### Type Aliases
+
+
+#### RenameOptions
+
+<code><a href="#copyoptions">CopyOptions</a></code>
+
+
+#### PermissionState
+
+<code>'prompt' | 'prompt-with-rationale' | 'granted' | '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.11",
+    "@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/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.11",
+    "@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/README.md b/keyboard/README.md
@@ -147,7 +147,7 @@ Listen for when the keyboard is about to be shown.
 
 | Param              | Type                                                                     |
 | ------------------ | ------------------------------------------------------------------------ |
-| **`eventName`**    | <code>"keyboardWillShow"</code>                                          |
+| **`eventName`**    | <code>'keyboardWillShow'</code>                                          |
 | **`listenerFunc`** | <code>(info: <a href="#keyboardinfo">KeyboardInfo</a>) =&gt; void</code> |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
@@ -167,7 +167,7 @@ Listen for when the keyboard is shown.
 
 | Param              | Type                                                                     |
 | ------------------ | ------------------------------------------------------------------------ |
-| **`eventName`**    | <code>"keyboardDidShow"</code>                                           |
+| **`eventName`**    | <code>'keyboardDidShow'</code>                                           |
 | **`listenerFunc`** | <code>(info: <a href="#keyboardinfo">KeyboardInfo</a>) =&gt; void</code> |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
@@ -187,7 +187,7 @@ Listen for when the keyboard is about to be hidden.
 
 | Param              | Type                            |
 | ------------------ | ------------------------------- |
-| **`eventName`**    | <code>"keyboardWillHide"</code> |
+| **`eventName`**    | <code>'keyboardWillHide'</code> |
 | **`listenerFunc`** | <code>() =&gt; void</code>      |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
@@ -207,7 +207,7 @@ Listen for when the keyboard is hidden.
 
 | Param              | Type                           |
 | ------------------ | ------------------------------ |
-| **`eventName`**    | <code>"keyboardDidHide"</code> |
+| **`eventName`**    | <code>'keyboardDidHide'</code> |
 | **`listenerFunc`** | <code>() =&gt; void</code>     |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>

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.11",
+    "@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
@@ -17,6 +17,7 @@ npx cap sync
 * [`addListener('orientation', ...)`](#addlistenerorientation-)
 * [`removeAllListeners()`](#removealllisteners)
 * [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
 
 </docgen-index>
 
@@ -33,7 +34,7 @@ Add a listener for accelerometer data
 
 | Param              | Type                                                                                |
 | ------------------ | ----------------------------------------------------------------------------------- |
-| **`eventName`**    | <code>"accel"</code>                                                                |
+| **`eventName`**    | <code>'accel'</code>                                                                |
 | **`listenerFunc`** | <code>(event: <a href="#motioneventresult">MotionEventResult</a>) =&gt; void</code> |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
@@ -53,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>(event: <a href="#devicemotioneventrotationrate">DeviceMotionEventRotationRate</a>) =&gt; void</code> |
 
 **Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
@@ -113,4 +114,12 @@ Remove all the listeners that are attached to this plugin.
 | **`beta`**  | <code>number</code> | The amount of rotation around the X axis, in degrees per second. | 1.0.0 |
 | **`gamma`** | <code>number</code> | The amount of rotation around the Y axis, in degrees per second. | 1.0.0 |
 
+
+### Type Aliases
+
+
+#### MotionOrientationEventResult
+
+<code><a href="#devicemotioneventrotationrate">DeviceMotionEventRotationRate</a></code>
+
 </docgen-api>
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.11",
+    "@capacitor/docgen": "0.0.14",
     "@capacitor/ios": "^3.0.0-alpha.9",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",