Skip to content

Commit

Permalink
Document return value of getAccessTokenWithClientCredentials
Browse files Browse the repository at this point in the history
  • Loading branch information
justincy committed Jan 7, 2016
1 parent 80543e7 commit 3ed3ee7
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/modules/node-only.js
Expand Up @@ -15,6 +15,7 @@ var FS = require('./../FamilySearch'),
* @param {String} key A PEM-encoded key. Matches the `pem` parameter of [ursa.createPrivateKey()](https://github.com/quartzjer/ursa#ursacreateprivatekeypem-password-encoding).
* @param {String=} password The password for descrypting the key, if necessary.
* @param {Integer|String=} time This parameter is only available for the sake of testing. Do not use it in production.
* @return {Object} a promise for the (string) access token.
*/
FS.prototype.getAccessTokenWithClientCredentials = function(key, password, time){

Expand All @@ -39,4 +40,4 @@ FS.prototype.getAccessTokenWithClientCredentials = function(key, password, time)
{'Content-Type': 'application/x-www-form-urlencoded'}).then(function(response){
return self.handleAccessTokenResponse(response);
});
};
};

0 comments on commit 3ed3ee7

Please sign in to comment.