Skip to content

Latest commit

 

History

History
209 lines (162 loc) · 6.79 KB

README.md

File metadata and controls

209 lines (162 loc) · 6.79 KB
Raw

urllib Build Status Coverage Status

logo

Help in opening URLs (mostly HTTP) in a complex world — basic and digest authentication, redirections, cookies and more.

Install

$ npm install urllib

Usage

var urllib = require('urllib');

urllib.request('http://cnodejs.org/', { wd: 'nodejs' }, function (err, data, res) {
  if (err) {
    throw err; // you need to handle error
  }
  console.log(res.statusCode);
  console.log(res.headers);
  // data is Buffer instance
  console.log(data.toString());
});

API Doc

.request(url[, options][, callback][, content])

Arguments

  • url String | Object - The URL to request, either a String or a Object that return by url.parse.
  • options Object - Optional
    • method String - Request method, defaults to GET. Could be GET, POST, DELETE or PUT. Alias 'type'.
    • data Object - Data to be sent. Will be stringify automatically.
    • content String | Buffer - Manually set the content of payload. If set, data will be ignored.
    • stream stream.Readable - Stream to be pipe to the remote. If set, data and content will be ignored.
    • writeStream stream.Writable - A writable stream to be piped by the response stream. Responding data will be write to this stream and callback will be called with data set null after finished writing.
    • dataType String - Type of response data. Could be text or json. If it's text, the callbacked data would be a Buffer. If it's json, the data of callback would be a parsed JSON Object. Defaults to text.
    • headers Object - Request headers.
    • timeout Number - Request timeout in milliseconds. Defaults to exports.TIMEOUT.
    • auth String - username:password used in HTTP Basic Authorization.
    • agent http.Agent - HTTP Agent object.
    • httpsAgent https.Agent - HTTPS Agent object.
  • callback(err, data, res) Function - Optional callback.
    • err Error - Would be null if no error accured.
    • data Buffer | Object - The data responsed. Would be a Buffer if dataType is set to text or an JSON parsed into Object if it's set to json.
    • res stream.Readable - The response stream.
  • context Object - Optional context object that will be binded to this of callback.

Returns

stream.Writable - The request stream.

Calling .abort() method of the request stream can cancel the request.

options.data

When making a request:

urllib.request('http://example.com', {
  method: 'GET',
  data: {
    'a': 'hello',
    'b': 'world'
  }
});

For GET request, data will be stringify to query string, e.g. http://example.com/?a=hello&world.

For POST, PATCH or PUT request, in defaults, the data will be stringify into application/x-www-form-urlencoded format if Content-Type header is not set.

options.content

options.content is useful when you wish to construct the request body by yourself, for example making a Content-Type: application/json request.

Notes that if you want to send a JSON body, you should stringify it yourself:

urllib.request('http://example.com', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  content: JSON.stringify({
    'a': 'hello',
    'b': 'world'
  })
});

It would make a HTTP request like:

POST / HTTP/1.1
Host: example.com
Content-Type: application/json

{
  "a": "hello",
  "b": "world"
}

options.stream

Uploads a file with formstream:

var urllib = require('urllib');
var formstream = require('formstream');

var form = formstream();
form.file('file', __filename);
form.field('hello', '你好urllib');

var req = urllib.request('http://my.server.com/upload', {
  method: 'POST',
  headers: form.headers(),
  stream: form
}, function (err, data) {
  // upload finished
});

res.aborted

If the underlaying connection was terminated before response.end() was called, res.aborted should be true.

var server = require('http').createServer(function (req, res) {
  req.on('end', function () {
    res.write('foo haha\n');
    setTimeout(function () {
      res.write('foo haha 2');
      setTimeout(function () {
        // res.end();
        res.socket.end();
        // res.socket.end('foosdfsdf');
      }, 300);
    }, 200);
    return;
  });
});

urllib.request('http://127.0.0.1:1984/socket.end', function (err, data, res) {
  should.not.exist(err);
  data.toString().should.equal('foo haha\nfoo haha 2');
  should.ok(res.aborted);
  done();
});

TODO

  • Support component
  • [√] Upload file like form upload
  • Auto redirect handle

Authors

Below is the output from git-summary.

$ git summary 

 project  : urllib
 repo age : 2 years, 2 months
 active   : 28 days
 commits  : 71
 files    : 16
 authors  : 
    57  fengmk2                 80.3%
     9  XiNGRZ                  12.7%
     4  Jackson Tian            5.6%
     1  aleafs                  1.4%

License

(The MIT License)

Copyright (c) 2011-2013 fengmk2 <fengmk2@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.