Skip to content

Commit 2c2f85e

Browse files
authored
Merge pull request #173 from westonruter/patch-1
Use JSDoc brackets to indicate optional cb param
2 parents d209f97 + e88f5cb commit 2c2f85e

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

lib/wait-on.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ const WAIT_ON_SCHEMA = Joi.object({
8181
@param opts.timeout integer - optional timeout in ms, default Infinity. Aborts with error.
8282
@param opts.verbose boolean - optional flag to turn on debug log
8383
@param opts.window integer - optional stabilization time in ms, default 750ms. Waits this amount of time for file sizes to stabilize or other resource availability to remain unchanged. If less than interval then will be reset to interval
84-
@param cb optional callback function with signature cb(err) - if err is provided then, resource checks did not succeed
84+
@param [cb] optional callback function with signature cb(err) - if err is provided then, resource checks did not succeed
8585
if not specified, wait-on will return a promise that will be rejected if resource checks did not succeed or resolved otherwise
8686
*/
8787
function waitOn(opts, cb) {

0 commit comments

Comments
 (0)