We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent db6061a commit 83570feCopy full SHA for 83570fe
index.js
@@ -25,13 +25,12 @@ var onHeaders = require('on-headers')
25
module.exports = timeout
26
27
/**
28
- * Timeout:
+ * Create a new timeout middleware.
29
*
30
- * See README.md for documentation.
31
- *
32
- * @param {Number} time
33
- * @param {Object} options
34
- * @return {Function} middleware
+ * @param {number|string} time The timeout as a number of milliseconds or a string for `ms`
+ * @param {object} [options] Additional options for middleware
+ * @param {boolean} [options.respond=true] Automatically emit error when timeout reached
+ * @return {function} middleware
35
* @public
36
*/
37
0 commit comments