Change to JSDoc type formatting {type}
This commit is contained in:
+6
-6
@@ -55,9 +55,9 @@ function resetEnqLinkTimer() {
|
||||
/**
|
||||
* Client session function - inherits from session()
|
||||
*
|
||||
* @param obj sock - socket object
|
||||
* @param obj options - as derived from client()
|
||||
* @return obj (returnObj)
|
||||
* @param {object} sock - socket object
|
||||
* @param {object} options - as derived from client()
|
||||
* @return {object} (returnObj)
|
||||
*/
|
||||
function clientSession(sock, options) {
|
||||
var returnObj = session(sock);
|
||||
@@ -89,10 +89,10 @@ function clientSession(sock, options) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Setup a client
|
||||
* Setup a client.
|
||||
*
|
||||
* @param obj options - host, port, username, password
|
||||
* @param func callback(err, session)
|
||||
* @param {object} options - host, port, username, password, tls, enqLinkTiming
|
||||
* @param {function} callback(err, session)
|
||||
*/
|
||||
function client(options, callback) {
|
||||
var sock;
|
||||
|
||||
Reference in New Issue
Block a user