From d76ad8803eec0dc9bc1a7d6ebd6cb223b5015e85 Mon Sep 17 00:00:00 2001 From: Alex Muramoto Date: Tue, 29 Nov 2016 10:22:32 -0600 Subject: [PATCH] docs(background mode): fix incorrect return types and typos --- src/plugins/backgroundmode.ts | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/plugins/backgroundmode.ts b/src/plugins/backgroundmode.ts index 0259ece0..3896602d 100644 --- a/src/plugins/backgroundmode.ts +++ b/src/plugins/backgroundmode.ts @@ -53,14 +53,14 @@ export class BackgroundMode { /** * Checks if background mode is enabled or not. - * @returns {boolean} returns a true of false if the background mode is enabled. + * @returns {Promise} returns a true of false if the background mode is enabled. */ @Cordova() static isEnabled(): Promise { return; } /** * Can be used to get the information if the background mode is active. - * @returns {boolean} returns tru or flase if the background mode is active. + * @returns {Promise} returns true or false if the background mode is active. */ @Cordova() static isActive(): Promise { return; } @@ -87,18 +87,21 @@ export class BackgroundMode { /** * Called when background mode is activated. + * @returns {Observable} returns an observable that emits when background mode is activated */ @CordovaFunctionOverride() static onactivate(): Observable { return; }; /** * Called when background mode is deactivated. + * @returns {Observable} returns an observable that emits when background mode is deactivated */ @CordovaFunctionOverride() static ondeactivate(): Observable { return; }; /** * Called when background mode fails + * @returns {Observable} returns an observable that emits when background mode fails */ @CordovaFunctionOverride() static onfailure(): Observable { return; };