Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(health): add wrapper for cordova-plugin-health #1039

Merged
merged 10 commits into from
Mar 2, 2017
Merged

feat(health): add wrapper for cordova-plugin-health #1039

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b7b52c5
feat(health): add wrapper for cordova-plugin-health
alx-andru Feb 7, 2017
bd9d1c6
Merge remote-tracking branch 'upstream/master'
alx-andru Feb 22, 2017
4311e96
fix(Health): add optional params to QueryOptions for .query()
alx-andru Feb 23, 2017
4025c82
docs(health): fix javadoc of interfaces
alx-andru Mar 2, 2017
d985c20
fix(health): remove unused Plugin option
alx-andru Mar 2, 2017
03308de
docs(health): add missing documentation
alx-andru Mar 2, 2017
26a84e8
doc(health): add promise to return
alx-andru Mar 2, 2017
0622bc1
doc(health): remove empty lines
alx-andru Mar 2, 2017
da27805
doc(health): Add description & reference to repo
alx-andru Mar 2, 2017
4d0599d
doc(health: add "return {Promise<any>}"
alx-andru Mar 2, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/plugins/health.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ export class Health {
*
* This function is only available on Android.
*
* @return successCallback: {type: function()}, called if the function was called
* @return {Promise<any>} {type: function()}, called if the function was called
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of this should be removed:

 {type: function()}, called if the function was called
     * errorCallback: {type: function(err)}, called if something went wrong		     * errorCallback: {type: function(err)}, called if something went wrong

All what it needs is @return {Promise<any>}

You can add additional description such as:

@returns {Promise<any>} returns a promise that resolves when (something happens) and rejects if (something else happens).

* errorCallback: {type: function(err)}, called if something went wrong
*/
@Cordova({
Expand Down Expand Up @@ -229,7 +229,7 @@ export class Health {
*
* @param {Array<String>} datatypes a list of data types you want to be granted access to
*
* @return successCallback: {type: function}, called if all OK
* @return {Promise<any>}: {type: function}, called if all OK
* errorCallback: {type: function(err)}, called if something went wrong,
* err contains a textual description of the problem

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra lines like this one should be removed

Expand Down