Skip to content

Commit db6061a

Browse files
committed
docs: tweaks to jsdoc comments
1 parent c6ddade commit db6061a

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

index.js

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99

1010
/**
1111
* Module dependencies.
12+
* @private
1213
*/
1314

1415
var createError = require('http-errors')
@@ -18,6 +19,7 @@ var onHeaders = require('on-headers')
1819

1920
/**
2021
* Module exports.
22+
* @public
2123
*/
2224

2325
module.exports = timeout
@@ -30,7 +32,7 @@ module.exports = timeout
3032
* @param {Number} time
3133
* @param {Object} options
3234
* @return {Function} middleware
33-
* @api public
35+
* @public
3436
*/
3537

3638
function timeout (time, options) {
@@ -70,6 +72,14 @@ function timeout (time, options) {
7072
}
7173
}
7274

75+
/**
76+
* Create timeout listener function.
77+
*
78+
* @param {number} delay
79+
* @param {function} cb
80+
* @private
81+
*/
82+
7383
function onTimeout (delay, cb) {
7484
return function () {
7585
cb(createError(503, 'Response timeout', {

0 commit comments

Comments
 (0)