Skip to content

Commit

Permalink
Fix JSDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
codenirvana committed Aug 14, 2020
1 parent 3515a42 commit e37c7ad
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
11 changes: 8 additions & 3 deletions lib/sandbox/cookie-jar.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ var CookieJar = require('tough-cookie').CookieJar,
/**
* Convert PostmanCookie Cookie instance to ToughCookie instance.
*
* @private
* @param {PostmanCookie} cookie - Postman Cookie instance
* @returns {ToughCookie} Tough Cookie instance
*/
Expand All @@ -36,6 +37,7 @@ var CookieJar = require('tough-cookie').CookieJar,
/**
* Convert Tough Cookie instance to Electron Cookie instance.
*
* @private
* @param {ToughCookie} cookie - Tough Cookie instance
* @returns {ElectronCookie} Electron Cookie instance
*/
Expand All @@ -61,6 +63,7 @@ var CookieJar = require('tough-cookie').CookieJar,
/**
* Sanitize url object or string to Postman Url instance.
*
* @private
* @param {Object|String} url
* @returns {Url|Null}
*/
Expand All @@ -81,6 +84,7 @@ var CookieJar = require('tough-cookie').CookieJar,
*
* @note not completely asynchronous, don't compare with async.each
*
* @private
* @param {Array} items - Array of items to iterate over
* @param {Function} fn - An async function to apply to each item in items
* @param {Function} cb - A callback which is called when all iteratee functions have finished,
Expand Down Expand Up @@ -116,6 +120,7 @@ var CookieJar = require('tough-cookie').CookieJar,
/**
* Helper function to handle callback.
*
* @private
* @param {Function} callback - Callback function
* @param {Error|String} err - Error or Error message
* @param {*} result
Expand All @@ -135,13 +140,13 @@ var CookieJar = require('tough-cookie').CookieJar,
/**
* Helper function to fetch a cookie with given name.
*
* @private
* @todo add CookieJar~getCookie to avoid this
*
* @param {CookieJar} jar - ToughCookie jar instance
* @param {String} url - Url string
* @param {String} name - Cookie name
* @param {Function} callback - Callback function
*
* @private
* @todo add CookieJar~getCookie to avoid this
*/
getCookie = function (jar, url, name, callback) {
jar.getCookies(url, function (err, cookies) {
Expand Down
3 changes: 3 additions & 0 deletions lib/sandbox/pmapi.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ var EXECUTION_ASSERTION_EVENT = 'execution.assertion',

/**
* Use this function to assign readonly properties to an object
*
* @private
*
* @param {Object} obj
* @param {Object} properties
*/
Expand Down

0 comments on commit e37c7ad

Please sign in to comment.