node-libcurl


[![NPM version][npm-image]][npm-url]
[![node][node-image]][node-url]
[![io.js][iojs-image]][iojs-url]
[![license][license-image]][license-url]

[![Travis CI Status][travis-image]][travis-url]
[![AppVeyor CI Status][appveyor-image]][appveyor-url]
[![Code Quality][codeclimate-image]][codeclimate-url]
[![Dependencies][deps-image]][deps-url]

[npm-image]:https://img.shields.io/npm/v/node-libcurl.svg?style=flat-square
[npm-url]:https://www.npmjs.org/package/node-libcurl
[travis-image]:https://img.shields.io/travis/JCMais/node-libcurl/master.svg?style=flat-square
[travis-url]:https://travis-ci.org/JCMais/node-libcurl
[appveyor-image]:https://ci.appveyor.com/api/projects/status/u7ox641jyb6hxrkt/branch/master?svg=true
[appveyor-url]:https://ci.appveyor.com/project/JCMais/node-libcurl
[codeclimate-image]:https://img.shields.io/codeclimate/github/JCMais/node-libcurl.svg?style=flat-square
[codeclimate-url]:https://codeclimate.com/github/JCMais/node-libcurl
[node-image]:https://img.shields.io/badge/node.js-%3E=_0.10-green.svg?style=flat-square
[node-url]:https://nodejs.org/download/
[iojs-image]:https://img.shields.io/badge/io.js-%3E=_1.0-brightgreen.svg?style=flat-square
[iojs-url]:https://iojs.org/en/index.html
[license-image]:https://img.shields.io/github/license/JCMais/node-libcurl.svg?style=flat-square
[license-url]:https://raw.githubusercontent.com/JCMais/node-libcurl/develop/LICENSE-MIT
[deps-image]:https://img.shields.io/david/JCMais/node-libcurl.svg?style=flat-square
[deps-url]:https://david-dm.org/jcmais/node-libcurl

Libcurl bindings for Node.js.
_Based on the work from jiangmiao/node-curl._

Quick Start

$3

``npm install node-libcurl --save`

$3

`javascript
var Curl = require( 'node-libcurl' ).Curl;

var curl = new Curl();

curl.setOpt( 'URL', 'www.google.com' );
curl.setOpt( 'FOLLOWLOCATION', true );

curl.on( 'end', function( statusCode, body, headers ) {

console.info( statusCode );
console.info( '---' );
console.info( body.length );
console.info( '---' );
console.info( this.getInfo( 'TOTAL_TIME' ) );

this.close();
});

curl.on( 'error', curl.close.bind( curl ) );
curl.perform();
`

$3

`javascript
var Curl = require( 'node-libcurl' ).Curl;

var curl = new Curl(),
close = curl.close.bind( curl );

curl.setOpt( curl.option.URL, '127.0.0.1/upload.php' );
curl.setOpt( curl.option.HTTPPOST, [
{ name: 'input-name', file: '/file/path', type: 'text/html' },
{ name: 'input-name2', contents: 'field-contents' }
]);

curl.on( 'end', close );
curl.on( 'error', close );
`

For more examples check the examples folder.

API

Check the API Docs

Detailed Installation

This package has prebuilt binaries (thanks to node-pre-gyp) available for the following platforms:
* Linux 64 bits
* Mac OS X 64 bits
* Windows 32 and 64 bits

Just running npm install nodejs-libcurl should install a prebuilt binary and no compilation will be needed.

If there is no prebuilt binary available that matches your system, or if the installation fails, then you will
need an environment capable of compilling nodejs addons, which means python 2.7
installed and an updated C++ compiler able to compile C++11.

If you don't want to use a prebuilt binary you can pass --build-from-source to the arguments list.

$3

The only compiler supported on linux is gcc >=4.8, also you need to have the libcurl development files available,
if you are running debian for example, you must install the libcurl4-openssl-dev package.

If you don't want to use the libcurl version shipped with your system, since it's probably very old
(debian 7 uses libcurl 7.26 which is more than 3 years old, and had more than 1000 bugfixes already),
you can install libcurl from source, the addon will pick the libcurl info using the curl-config tool,
that way you only need to make sure that the libcurl you installed is in the path and in higher priority
than the system one.

$3

You need to have installed OS X >=10.8 and xcode >=4.5

If you want to install using a different version of libcurl, the same instructions for linux applies.

$3

If installing using a prebuilt binary you only need to have the visual c++ 2013 runtime library.
If building from source, you need to have Python 2.7, Visual Studio >=2013 and git

Currently there is no support to use other libcurl version than the one provided by the curl-for-windows submodule.

$3

Currently there are no prebuilt binaries for node-webkit, to install node-libcurl, do the following:

1. Install nw-gyp

`javascript
npm install nw-gyp -g
`
2. Install node-libcurl

`javascript
npm install node-libcurl --runtime=node-webkit --target=0.12.3 --arch=x64 --msvs_version=2013 --build-from-source --save
`
--target says you want to build for the node-webkit version 0.12.3.

--arch says the module should be built for 64bit.

$3

Currently there are no prebuilt binaries for electron, to install node-libcurl, do the following:

`javascript
npm install node-libcurl --runtime=electron --target=0.34.1 --arch=x64 --build-from-source --save
`
--target says you want to build for the electron version 0.34.1.

--arch` says the module should be built for 64bit.