co-req

0.0.5 • Public • Published

co-req

tiny wrapper around request wrapper for generators. makes streaming responses a cinch.

Installation

npm install co-req

Example

co(function *() {

  var req = request('http://google.com');
  var res = yield req;

  if (200 != res.statusCode) {
    throw new Error(res.statusCode);
  }

  var body = '';
  var buf;

  while (buf = yield req) {
    body += buf.toString();
  }

})()

API

req = yield request(opts)

req has the same signature as substack/hyperquest. request returns a thunk that you can yield.

The response res contains all the http header information.

The body is streamed and to get each chunk you yield on req until the stream is complete.

License

(The MIT License)

Copyright (c) 2014 Matthew Mueller <mattmuelle@gmail.com>

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.

Readme

Keywords

none

Package Sidebar

Install

npm i co-req

Weekly Downloads

4

Version

0.0.5

License

none

Last publish

Collaborators

  • mattmueller