github/awesome-cordova-plugins
github/awesome-cordova-plugins
2
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2025-02-07 23:03:19 +08:00
Code Issues Projects Releases Wiki Activity

docs(): fix docs

Browse Source
This commit is contained in:
Ibby Hadeed 2017-05-17 06:53:13 -04:00
parent 92ef4f0c33
commit 84551cac67
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/@ionic-native/plugins/deeplinks/index.ts
View File

@ -88,7 +88,7 @@ export class Deeplinks extends IonicNativePlugin {
/** /**
* Define a set of paths to match against incoming deeplinks. * Define a set of paths to match against incoming deeplinks.
* *
* @param {paths} Define a set of paths to match against incoming deeplinks. * @param {paths} paths Define a set of paths to match against incoming deeplinks.
* paths takes an object of the form { 'path': data }. If a deeplink * paths takes an object of the form { 'path': data }. If a deeplink
* matches the path, the resulting path-data pair will be returned in the * matches the path, the resulting path-data pair will be returned in the
* promise result which you can then use to navigate in the app as you see fit. * promise result which you can then use to navigate in the app as you see fit.
@ -110,11 +110,13 @@ export class Deeplinks extends IonicNativePlugin {
* This handler will automatically navigate when a route matches. If you need finer-grained * This handler will automatically navigate when a route matches. If you need finer-grained
* control over the behavior of a matching deeplink, use the plain `route` method. * control over the behavior of a matching deeplink, use the plain `route` method.
* *
* @param {paths} Define a set of paths to match against incoming deeplinks. * @param {Nav} navController Define a set of paths to match against incoming deeplinks.
* paths takes an object of the form { 'path': data }. If a deeplink * paths takes an object of the form { 'path': data }. If a deeplink
* matches the path, the resulting path-data pair will be returned in the * matches the path, the resulting path-data pair will be returned in the
* promise result which you can then use to navigate in the app as you see fit. * promise result which you can then use to navigate in the app as you see fit.
* *
* @param {Object} paths
*
* @returns {Observable<DeeplinkMatch>} Returns an Observable that resolves each time a deeplink comes through, and * @returns {Observable<DeeplinkMatch>} Returns an Observable that resolves each time a deeplink comes through, and
* errors if a deeplink comes through that does not match a given path. * errors if a deeplink comes through that does not match a given path.
*/ */