luvit-timeout
Timing out the request in ms
(defaulting to 5000
) middleware for luvit.io and Utopia.
Install
npm install luvit-timeout
If you're not familiar with npm check this out:
- https://github.com/voronianski/luvit-npm-example#how-to
- https://github.com/luvitrocks/luvit-utopia#install
API
timeout(time, options)
Returns middleware that times out in time
milliseconds. On timeout request will emit 'timeout'
.
Options
-
respond
- Iftrue
, the timeout error is passed to next() so that you may customize the response behavior, defaults totrue
req.clearTimeout()
Clears the timeout on the request.
req.timedout
It's true
if timeout fired and false
otherwise.
Example
local utopia = require('luvit-utopia')
local timeout = require('luvit-timeout')
local app = utopia:new()
app:use(timeout(2000))
app:listen(8080)
License
MIT Licensed
Copyright (c) 2014 Dmitri Voronianski [email protected]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.