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

docs(all): standardizes and adds return types, also some param fixes

Browse Source
This commit is contained in:
Alex Muramoto
2016-11-29 16:40:50 -06:00
parent b7a562053a
commit 3da2831779
88 changed files with 635 additions and 347 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/plugins/toast.ts
+15 -9
View File
@@ -71,7 +71,7 @@ export class Toast {
* @param {string} message The message to display.
* @param {string} duration Duration to show the toast, either 'short', 'long' or any number of milliseconds: '1500'.
* @param {string} position Where to position the toast, either 'top', 'center', or 'bottom'.
* @return {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error.
* @returns {Observable<any>} Returns an Observable that notifies first on success and then when tapped, rejects on error.
*/
@Cordova({
observable: true,
@@ -85,7 +85,7 @@ export class Toast {
/**
* Manually hide any currently visible toast.
* @return {Promise} Returns a Promise that resolves on success.
* @returns {Promise<any>} Returns a Promise that resolves on success.
*/
@Cordova()
static hide(): Promise<any> { return; }
@@ -99,7 +99,7 @@ export class Toast {
* position Where to position the toast, either 'top', 'center', or 'bottom'.
* addPixelsY Offset in pixels to move the toast up or down from its specified position.
*
* @return {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error.
* @returns {Observable<any>} Returns an Observable that notifies first on success and then when tapped, rejects on error.
*/
@Cordova({
observable: true,
@@ -109,7 +109,8 @@ export class Toast {
/**
* Shorthand for `show(message, 'short', 'top')`.
* @return {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error.
* @param message {string}
* @returns {Observable<any>} Returns an Observable that notifies first on success and then when tapped, rejects on error.
*/
@Cordova({
observable: true,
@@ -119,7 +120,8 @@ export class Toast {
/**
* Shorthand for `show(message, 'short', 'center')`.
* @return {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error.
* @param message {string}
* @returns {Observable<any>} Returns an Observable that notifies first on success and then when tapped, rejects on error.
*/
@Cordova({
observable: true,
@@ -130,7 +132,8 @@ export class Toast {
/**
* Shorthand for `show(message, 'short', 'bottom')`.
* @return {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error.
* @param message {string}
* @returns {Observable<any>} Returns an Observable that notifies first on success and then when tapped, rejects on error.
*/
@Cordova({
observable: true,
@@ -141,7 +144,8 @@ export class Toast {
/**
* Shorthand for `show(message, 'long', 'top')`.
* @return {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error.
* @param message {string}
* @returns {Observable<any>} Returns an Observable that notifies first on success and then when tapped, rejects on error.
*/
@Cordova({
observable: true,
@@ -152,7 +156,8 @@ export class Toast {
/**
* Shorthand for `show(message, 'long', 'center')`.
* @return {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error.
* @param message {string}
* @returns {Observable<any>} Returns an Observable that notifies first on success and then when tapped, rejects on error.
*/
@Cordova({
observable: true,
@@ -163,7 +168,8 @@ export class Toast {
/**
* Shorthand for `show(message, 'long', 'bottom')`.
* @return {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error.
* @param message {string}
* @returns {Observable<any>} Returns an Observable that notifies first on success and then when tapped, rejects on error.
*/
@Cordova({
observable: true,