From be9ff28e06a367feb58cff612e4f1409985664de Mon Sep 17 00:00:00 2001 From: jcesarmobile Date: Mon, 29 Jan 2024 16:29:03 +0100 Subject: [PATCH] docs: fix addListener links (#2012) --- action-sheet/package.json | 2 +- app-launcher/package.json | 2 +- app/README.md | 12 ++++++------ app/package.json | 2 +- browser/README.md | 4 ++-- browser/package.json | 2 +- camera/package.json | 2 +- clipboard/package.json | 2 +- device/package.json | 2 +- dialog/package.json | 2 +- filesystem/README.md | 2 +- filesystem/package.json | 2 +- geolocation/README.md | 11 +++++++++++ geolocation/package.json | 2 +- google-maps/package.json | 2 +- haptics/package.json | 2 +- keyboard/README.md | 8 ++++---- keyboard/package.json | 2 +- local-notifications/README.md | 4 ++-- local-notifications/package.json | 2 +- motion/README.md | 4 ++-- motion/package.json | 2 +- network/README.md | 2 +- network/package.json | 2 +- preferences/package.json | 2 +- push-notifications/README.md | 8 ++++---- push-notifications/package.json | 2 +- screen-orientation/README.md | 2 +- screen-orientation/package.json | 2 +- screen-reader/README.md | 2 +- screen-reader/package.json | 2 +- share/package.json | 2 +- splash-screen/package.json | 2 +- status-bar/package.json | 2 +- text-zoom/package.json | 2 +- toast/package.json | 2 +- 36 files changed, 60 insertions(+), 49 deletions(-) diff --git a/action-sheet/package.json b/action-sheet/package.json index 6f2323899..c9d4a899b 100644 --- a/action-sheet/package.json +++ b/action-sheet/package.json @@ -47,7 +47,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/app-launcher/package.json b/app-launcher/package.json index 5cbba3f6a..7950208a8 100644 --- a/app-launcher/package.json +++ b/app-launcher/package.json @@ -47,7 +47,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/app/README.md b/app/README.md index 5c0ec03ea..7506a9f4a 100644 --- a/app/README.md +++ b/app/README.md @@ -76,12 +76,12 @@ const checkAppLaunchUrl = async () => { * [`getState()`](#getstate) * [`getLaunchUrl()`](#getlaunchurl) * [`minimizeApp()`](#minimizeapp) -* [`addListener('appStateChange', ...)`](#addlistenerappstatechange) -* [`addListener('pause', ...)`](#addlistenerpause) -* [`addListener('resume', ...)`](#addlistenerresume) -* [`addListener('appUrlOpen', ...)`](#addlistenerappurlopen) -* [`addListener('appRestoredResult', ...)`](#addlistenerapprestoredresult) -* [`addListener('backButton', ...)`](#addlistenerbackbutton) +* [`addListener('appStateChange', ...)`](#addlistenerappstatechange-) +* [`addListener('pause', ...)`](#addlistenerpause-) +* [`addListener('resume', ...)`](#addlistenerresume-) +* [`addListener('appUrlOpen', ...)`](#addlistenerappurlopen-) +* [`addListener('appRestoredResult', ...)`](#addlistenerapprestoredresult-) +* [`addListener('backButton', ...)`](#addlistenerbackbutton-) * [`removeAllListeners()`](#removealllisteners) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) diff --git a/app/package.json b/app/package.json index abc3059e1..d447a84c1 100644 --- a/app/package.json +++ b/app/package.json @@ -47,7 +47,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/browser/README.md b/browser/README.md index 53acc7322..bdedd6910 100644 --- a/browser/README.md +++ b/browser/README.md @@ -35,8 +35,8 @@ const openCapacitorSite = async () => { * [`open(...)`](#open) * [`close()`](#close) -* [`addListener('browserFinished', ...)`](#addlistenerbrowserfinished) -* [`addListener('browserPageLoaded', ...)`](#addlistenerbrowserpageloaded) +* [`addListener('browserFinished', ...)`](#addlistenerbrowserfinished-) +* [`addListener('browserPageLoaded', ...)`](#addlistenerbrowserpageloaded-) * [`removeAllListeners()`](#removealllisteners) * [Interfaces](#interfaces) diff --git a/browser/package.json b/browser/package.json index 3ff7bf182..4f1492cf2 100644 --- a/browser/package.json +++ b/browser/package.json @@ -47,7 +47,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/camera/package.json b/camera/package.json index 7230f104c..6eca04b22 100644 --- a/camera/package.json +++ b/camera/package.json @@ -47,7 +47,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/clipboard/package.json b/clipboard/package.json index 0f204a7d7..6b039856a 100644 --- a/clipboard/package.json +++ b/clipboard/package.json @@ -47,7 +47,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/device/package.json b/device/package.json index 6c8aa3271..5b81ae559 100644 --- a/device/package.json +++ b/device/package.json @@ -48,7 +48,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/dialog/package.json b/dialog/package.json index e742a285d..1915eadf1 100644 --- a/dialog/package.json +++ b/dialog/package.json @@ -47,7 +47,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/filesystem/README.md b/filesystem/README.md index cfa757077..f953fb6ea 100644 --- a/filesystem/README.md +++ b/filesystem/README.md @@ -100,7 +100,7 @@ const readFilePath = async () => { * [`checkPermissions()`](#checkpermissions) * [`requestPermissions()`](#requestpermissions) * [`downloadFile(...)`](#downloadfile) -* [`addListener('progress', ...)`](#addlistenerprogress) +* [`addListener('progress', ...)`](#addlistenerprogress-) * [`removeAllListeners()`](#removealllisteners) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) diff --git a/filesystem/package.json b/filesystem/package.json index cf6293e30..cb38fd1d6 100644 --- a/filesystem/package.json +++ b/filesystem/package.json @@ -47,7 +47,7 @@ "devDependencies": { "@capacitor/android": "^5.1.1", "@capacitor/core": "^5.1.1", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.1.1", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/geolocation/README.md b/geolocation/README.md index 0e478b4c1..3331cfb20 100644 --- a/geolocation/README.md +++ b/geolocation/README.md @@ -204,6 +204,17 @@ Request location permissions. Will throw if system location services are disabl ### Type Aliases +#### Position + +A Position is an array of coordinates. +https://tools.ietf.org/html/rfc7946#section-3.1.1 +Array should contain between two and three elements. +The previous GeoJSON specification allowed more elements (e.g., which could be used to represent M values), +but the current specification only allows X, Y, and (optionally) Z to be defined. + +number[] + + #### WatchPositionCallback (position: Position | null, err?: any): void diff --git a/geolocation/package.json b/geolocation/package.json index 5a63c3bb1..f60d5ae80 100644 --- a/geolocation/package.json +++ b/geolocation/package.json @@ -47,7 +47,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/google-maps/package.json b/google-maps/package.json index 8a1e79e0a..d532146a3 100644 --- a/google-maps/package.json +++ b/google-maps/package.json @@ -58,7 +58,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "^1.0.1", diff --git a/haptics/package.json b/haptics/package.json index 783438fe3..909ec441f 100644 --- a/haptics/package.json +++ b/haptics/package.json @@ -47,7 +47,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/keyboard/README.md b/keyboard/README.md index 7b91cb501..f14d864b8 100644 --- a/keyboard/README.md +++ b/keyboard/README.md @@ -100,10 +100,10 @@ the following events also work with `window.addEventListener`: * [`setStyle(...)`](#setstyle) * [`setResizeMode(...)`](#setresizemode) * [`getResizeMode()`](#getresizemode) -* [`addListener('keyboardWillShow', ...)`](#addlistenerkeyboardwillshow) -* [`addListener('keyboardDidShow', ...)`](#addlistenerkeyboarddidshow) -* [`addListener('keyboardWillHide', ...)`](#addlistenerkeyboardwillhide) -* [`addListener('keyboardDidHide', ...)`](#addlistenerkeyboarddidhide) +* [`addListener('keyboardWillShow', ...)`](#addlistenerkeyboardwillshow-) +* [`addListener('keyboardDidShow', ...)`](#addlistenerkeyboarddidshow-) +* [`addListener('keyboardWillHide', ...)`](#addlistenerkeyboardwillhide-) +* [`addListener('keyboardDidHide', ...)`](#addlistenerkeyboarddidhide-) * [`removeAllListeners()`](#removealllisteners) * [Interfaces](#interfaces) * [Enums](#enums) diff --git a/keyboard/package.json b/keyboard/package.json index 5f2895695..d2d098e43 100644 --- a/keyboard/package.json +++ b/keyboard/package.json @@ -48,7 +48,7 @@ "@capacitor/android": "^5.0.0", "@capacitor/cli": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/local-notifications/README.md b/local-notifications/README.md index 0c1660b98..27bcb3583 100644 --- a/local-notifications/README.md +++ b/local-notifications/README.md @@ -94,8 +94,8 @@ If the device has entered [Doze](https://developer.android.com/training/monitori * [`listChannels()`](#listchannels) * [`checkPermissions()`](#checkpermissions) * [`requestPermissions()`](#requestpermissions) -* [`addListener('localNotificationReceived', ...)`](#addlistenerlocalnotificationreceived) -* [`addListener('localNotificationActionPerformed', ...)`](#addlistenerlocalnotificationactionperformed) +* [`addListener('localNotificationReceived', ...)`](#addlistenerlocalnotificationreceived-) +* [`addListener('localNotificationActionPerformed', ...)`](#addlistenerlocalnotificationactionperformed-) * [`removeAllListeners()`](#removealllisteners) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) diff --git a/local-notifications/package.json b/local-notifications/package.json index 4e6affb4b..eb5ebfb1a 100644 --- a/local-notifications/package.json +++ b/local-notifications/package.json @@ -48,7 +48,7 @@ "@capacitor/android": "^5.0.0", "@capacitor/cli": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/motion/README.md b/motion/README.md index bdf728134..6e8979e37 100644 --- a/motion/README.md +++ b/motion/README.md @@ -57,8 +57,8 @@ API to understand the data supplied in the 'accel' event. -* [`addListener('accel', ...)`](#addlisteneraccel) -* [`addListener('orientation', ...)`](#addlistenerorientation) +* [`addListener('accel', ...)`](#addlisteneraccel-) +* [`addListener('orientation', ...)`](#addlistenerorientation-) * [`removeAllListeners()`](#removealllisteners) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) diff --git a/motion/package.json b/motion/package.json index e354b579f..4c4308caf 100644 --- a/motion/package.json +++ b/motion/package.json @@ -41,7 +41,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/network/README.md b/network/README.md index 189aa8b8e..faa632c3e 100644 --- a/network/README.md +++ b/network/README.md @@ -30,7 +30,7 @@ const logCurrentNetworkStatus = async () => { * [`getStatus()`](#getstatus) -* [`addListener('networkStatusChange', ...)`](#addlistenernetworkstatuschange) +* [`addListener('networkStatusChange', ...)`](#addlistenernetworkstatuschange-) * [`removeAllListeners()`](#removealllisteners) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) diff --git a/network/package.json b/network/package.json index 07578fab6..cfcd5921e 100644 --- a/network/package.json +++ b/network/package.json @@ -47,7 +47,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/preferences/package.json b/preferences/package.json index 4931bc68a..dd77ef21b 100644 --- a/preferences/package.json +++ b/preferences/package.json @@ -47,7 +47,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/push-notifications/README.md b/push-notifications/README.md index eddd7a590..28eb10a7a 100644 --- a/push-notifications/README.md +++ b/push-notifications/README.md @@ -189,10 +189,10 @@ const getDeliveredNotifications = async () => { * [`listChannels()`](#listchannels) * [`checkPermissions()`](#checkpermissions) * [`requestPermissions()`](#requestpermissions) -* [`addListener('registration', ...)`](#addlistenerregistration) -* [`addListener('registrationError', ...)`](#addlistenerregistrationerror) -* [`addListener('pushNotificationReceived', ...)`](#addlistenerpushnotificationreceived) -* [`addListener('pushNotificationActionPerformed', ...)`](#addlistenerpushnotificationactionperformed) +* [`addListener('registration', ...)`](#addlistenerregistration-) +* [`addListener('registrationError', ...)`](#addlistenerregistrationerror-) +* [`addListener('pushNotificationReceived', ...)`](#addlistenerpushnotificationreceived-) +* [`addListener('pushNotificationActionPerformed', ...)`](#addlistenerpushnotificationactionperformed-) * [`removeAllListeners()`](#removealllisteners) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) diff --git a/push-notifications/package.json b/push-notifications/package.json index b9dd930fd..d08dbb715 100644 --- a/push-notifications/package.json +++ b/push-notifications/package.json @@ -48,7 +48,7 @@ "@capacitor/android": "^5.0.0", "@capacitor/cli": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/screen-orientation/README.md b/screen-orientation/README.md index 418b5ea3a..09dd48fe4 100644 --- a/screen-orientation/README.md +++ b/screen-orientation/README.md @@ -36,7 +36,7 @@ By default, an iPad allows Multitasking and its orientation cannot be locked. If * [`orientation()`](#orientation) * [`lock(...)`](#lock) * [`unlock()`](#unlock) -* [`addListener('screenOrientationChange', ...)`](#addlistenerscreenorientationchange) +* [`addListener('screenOrientationChange', ...)`](#addlistenerscreenorientationchange-) * [`removeAllListeners()`](#removealllisteners) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) diff --git a/screen-orientation/package.json b/screen-orientation/package.json index 416dd91f3..825eb319b 100644 --- a/screen-orientation/package.json +++ b/screen-orientation/package.json @@ -47,7 +47,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/screen-reader/README.md b/screen-reader/README.md index c664cd21b..f5d93f3cc 100644 --- a/screen-reader/README.md +++ b/screen-reader/README.md @@ -35,7 +35,7 @@ const sayHello = async () => { * [`isEnabled()`](#isenabled) * [`speak(...)`](#speak) -* [`addListener('stateChange', ...)`](#addlistenerstatechange) +* [`addListener('stateChange', ...)`](#addlistenerstatechange-) * [`removeAllListeners()`](#removealllisteners) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) diff --git a/screen-reader/package.json b/screen-reader/package.json index 47dcf4e24..d1313da80 100644 --- a/screen-reader/package.json +++ b/screen-reader/package.json @@ -47,7 +47,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/share/package.json b/share/package.json index 718f3b8ca..aca7299eb 100644 --- a/share/package.json +++ b/share/package.json @@ -47,7 +47,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/splash-screen/package.json b/splash-screen/package.json index e3dbf9544..19bbcaeb3 100644 --- a/splash-screen/package.json +++ b/splash-screen/package.json @@ -48,7 +48,7 @@ "@capacitor/android": "^5.0.0", "@capacitor/cli": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/status-bar/package.json b/status-bar/package.json index 5b14a0f24..b802689f9 100644 --- a/status-bar/package.json +++ b/status-bar/package.json @@ -47,7 +47,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/text-zoom/package.json b/text-zoom/package.json index 2d2458ca2..c77f770cc 100644 --- a/text-zoom/package.json +++ b/text-zoom/package.json @@ -47,7 +47,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1", diff --git a/toast/package.json b/toast/package.json index 95053c8db..a048ad496 100644 --- a/toast/package.json +++ b/toast/package.json @@ -47,7 +47,7 @@ "devDependencies": { "@capacitor/android": "^5.0.0", "@capacitor/core": "^5.0.0", - "@capacitor/docgen": "0.2.0", + "@capacitor/docgen": "0.2.2", "@capacitor/ios": "^5.0.0", "@ionic/eslint-config": "^0.3.0", "@ionic/prettier-config": "~1.0.1",