ExternalVendorCode/balena-cli
1
0
Fork 0
mirror of https://github.com/balena-io/balena-cli.git synced 2024-12-22 06:57:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix callback documentation issue

Browse Source
This commit is contained in:
Juan Cruz Viotti 2014-12-05 14:08:51 -04:00
parent 0c5126f0d5
commit 842336e61b
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
lib/resin/auth/auth.coffee
View File

@ -13,7 +13,7 @@ settings = require('../settings')
# @param {Object} credentials in the form of username, password
# @option credentials {String} username the username
# @option credentials {String} password user password
# @param {Function} callback (error, token)
# @param {Function} callback callback (error, token)
#
# @note You should use login() when possible, as it takes care of saving the token as well.
#
@ -33,7 +33,7 @@ exports.authenticate = (credentials, callback) ->
# @param {Object} credentials in the form of username, password
# @option credentials {String} username the username
# @option credentials {String} password user password
# @param {Function} callback (error)
# @param {Function} callback callback (error)
#
# @note This function saves the token to the directory configured in dataPrefix
#
@ -55,7 +55,7 @@ exports.login = (credentials, callback) ->
# Check if you're logged in
#
# @param {Function} callback (isLoggedIn)
# @param {Function} callback callback (isLoggedIn)
#
# @example Check if logged in
# resin.auth.isLoggedIn (isLoggedIn) ->
@ -69,7 +69,7 @@ exports.isLoggedIn = (callback) ->
# Get current logged in user's token
#
# @param {Function} callback (error, isLoggedIn)
# @param {Function} callback callback (error, isLoggedIn)
#
# @note This function simply delegates to resin.token.getToken() for convenience
#
@ -83,7 +83,7 @@ exports.getToken = (callback) ->
# Logout from Resin.io
#
# @param {Function} callback (error)
# @param {Function} callback callback (error)
#
# @example Logout from Resin.io
# resin.auth.logout (error) ->
@ -100,7 +100,7 @@ exports.logout = (callback) ->
# @private
#
# @param {String} colon separated credentials (username:password)
# @param {Function} callback (error, credentials)
# @param {Function} callback callback (error, credentials)
#
# @example Parse credentials
# resin.auth.parseCredentials 'johndoe:secret', (error, credentials) ->