Skip to content

Commit

Permalink
docs: provide better jsdoc for main function
Browse files Browse the repository at this point in the history
  • Loading branch information
dougwilson committed Jan 25, 2017
1 parent db6061a commit 83570fe
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions index.js
Expand Up @@ -25,13 +25,12 @@ var onHeaders = require('on-headers')
module.exports = timeout

/**
* Timeout:
* Create a new timeout middleware.
*
* See README.md for documentation.
*
* @param {Number} time
* @param {Object} options
* @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
* @public
*/

Expand Down

0 comments on commit 83570fe

Please sign in to comment.