Needle

The most handsome HTTP client in the Nodelands. Supports SSL, basic authentication, proxied requests, multipart form POSTs, gzip/deflate compression and, as you would expect, follows redirects. Simple, nimble and to the point.

Usage

var client = require('needle');

client.get('http://www.google.com', function(err, resp, body){
  console.log("Got status code: " + resp.statusCode);
});

Install

npm install needle

Options

• timeout: Returns error if response takes more than X milisecs. Defaults to 10000 (10 secs). 0 means no timeout.
• follow: When false, Needle won't follow redirects. Can also be a number or true (the default, 10 max).
• compressed: Whether to ask for a deflated or gzipped response or not. Defaults to false.
• parse: Whether to parse XML or JSON response bodies automagically. Defaults to true.
• multipart: Enables multipart/form-data encoding. Defaults to false.
• username: For HTTP basic auth.
• password: For HTTP basic auth. Requires username to be passed, obviously.
• agent: Uses an http.Agent of your choice, instead of the global (default) one.
• proxy: Forwards request through HTTP proxy. Eg. proxy: 'http://proxy.server.com:3128'

Methods

client.get(url, [options], callback);
client.head(url, [options], callback);
client.post(url, data, [options], callback);
client.put(url, data, [options], callback);
client.delete(url, [options], callback);

Callback receives three arguments: (error, response, body)

More examples

GET with querystring

client.get('http://www.google.com/search?q=syd+barrett', function(err, resp, body){
  if(!err && resp.statusCode == 200)
    console.log(body); // prints results
});

You can also skip the 'http://' part if you want, by the way.

HTTPS GET with options

var options = {
  username: 'you',
  password: 'secret',
  timeout: false,
  headers: {
    'X-Secret-Header': "Even more secret text"
  }
}

client.get('https://api.server.com', options, function(err, resp, body){
  // used HTTP auth
});

GET through proxy

client.get('http://search.npmjs.org', { proxy: 'http://localhost:1234' }, function(err, resp, body){
  // request passed through proxy
});

POST/PUT

client.post('https://my.app.com/endpoint', 'foo=bar', function(err, resp, body){
  // you can pass params as a string or as an object
});

POST/PUT 2

var data = {
  nested: {
    params: {
      are: {
        also: 'supported'
      }
    }
  }
}

client.put('https://api.app.com/v2', data, function(err, resp, body){
  // if you don't pass any data, needle will throw an exception.
});

Multipart POST: passing file path

var data = {
  foo: bar,
  image: { file: '/home/tomas/linux.png', content_type: 'image/png' }
}

var options = {
  multipart: true,
  timeout: 5000
}

client.post('http://my.other.app.com', data, options, function(err, resp, body){
  // in this case, if the request takes more than 5 seconds
  // the callback will return a [Socket closed] error
});

Multipart POST 2: passing data buffer

var buffer = fs.readFileSync('/path/to/package.zip');
var data = {
  zip_file: { buffer: buffer, filename: 'mypackage.zip', content_type: 'application/octet-stream' },
}

client.post('http://somewhere.com/over/the/rainbow', data, {multipart: true}, function(err, resp, body){
  // if you see, when using buffers we need to pass the filename for the multipart body.
  // you can also pass a filename when using the file path method, in case you want to override
  // the default filename to be received on the other end.
});

Credits

Written by Tomás Pollak, with the help of contributors.

Copyright

(c) 2012 Fork Ltd. Licensed under the MIT license.