Knoq
A interval based Node module for continuous retrieval of web resources.
Example
var Knoq = ;var req = ; req; req;
Methods
var Knoq = ;
var req = Knoq(uri, opts, cb)
Create an ongoing http request to uri
.
The optional opts
object is used to pass configuration to Knoq
.
- opts.delay - Used to configure the interval timer. Defaults to
6000
.
Alternatively you can pass a number as the opts
argument:
var req = ;
Which is shorthand for:
var req = ;
The optional callback cb(err, res)
is called when either the error
or response
event is fired.
req.start()
Internally this is called with every new instance of Knoq
.
Can be used to restart an ended Knoq
instance.
req.end()
Calling req.end()
clears all timeouts, and stops Knoq
from making any further requests.
Events
Knoq
returns an instance of EventEmitter
, and exposes the following events:
req.on('request', function (req) {})
The request
event bubbles up from http.request()
.
req.on('response', function (res) {})
The response
event bubbles up from http.request()
.
req.on('error', function (err) {})
The error
event bubbles up from http.request()
.
By default req.end()
will be called in the case of an error.
req.on('end', function () {})
The end
event is fired when req.end()
is called.
Install
npm install knoq
License
MIT