## node-libcurl
* [node-libcurl](#module_node-libcurl)
* _static_
* [.Curl](#module_node-libcurl.Curl) ⇐ EventEmitter
* [new Curl()](#new_module_node-libcurl.Curl_new)
* _instance_
* ~~[.onData](#module_node-libcurl.Curl+onData) : [onDataCallback](#module_node-libcurl.Easy..onDataCallback)~~
* ~~[.onHeader](#module_node-libcurl.Curl+onHeader) : [onHeaderCallback](#module_node-libcurl.Easy..onHeaderCallback)~~
* [.enable(bitmask)](#module_node-libcurl.Curl+enable) ⇒ [Curl](#module_node-libcurl.Curl)
* [.disable(bitmask)](#module_node-libcurl.Curl+disable) ⇒ [Curl](#module_node-libcurl.Curl)
* [.setOpt(optionIdOrName, optionValue)](#module_node-libcurl.Curl+setOpt) ⇒ [Curl](#module_node-libcurl.Curl)
* [.getInfo(infoNameOrId)](#module_node-libcurl.Curl+getInfo) ⇒ String | Number | Array
* [.setProgressCallback(cb)](#module_node-libcurl.Curl+setProgressCallback) ⇒ [Curl](#module_node-libcurl.Curl)
* [.perform()](#module_node-libcurl.Curl+perform) ⇒ [Curl](#module_node-libcurl.Curl)
* [.pause(bitmask)](#module_node-libcurl.Curl+pause) ⇒ [Curl](#module_node-libcurl.Curl)
* [.reset()](#module_node-libcurl.Curl+reset) ⇒ [Curl](#module_node-libcurl.Curl)
* [.dupHandle([shouldCopyCallbacks], [shouldCopyEventListeners])](#module_node-libcurl.Curl+dupHandle) ⇒ [Curl](#module_node-libcurl.Curl)
* [.close()](#module_node-libcurl.Curl+close)
* ["data" (chunk)](#module_node-libcurl.Curl+event_data)
* ["header" (chunk)](#module_node-libcurl.Curl+event_header)
* ["error" (err, errCode)](#module_node-libcurl.Curl+event_error)
* ["end" (status, argBody, argBody)](#module_node-libcurl.Curl+event_end)
* _static_
* [.getCount](#module_node-libcurl.Curl.getCount) ⇒ Number
* [.getVersion](#module_node-libcurl.Curl.getVersion) ⇒ String
* [.globalInit](#module_node-libcurl.Curl.globalInit) ⇒ Number
* [.globalCleanup](#module_node-libcurl.Curl.globalCleanup)
* [.option](#module_node-libcurl.Curl.option) : enum
* [.multi](#module_node-libcurl.Curl.multi) : enum
* [.share](#module_node-libcurl.Curl.share) : enum
* [.lock](#module_node-libcurl.Curl.lock) : enum
* [.info](#module_node-libcurl.Curl.info) : enum
* [.auth](#module_node-libcurl.Curl.auth) : enum
* [.http](#module_node-libcurl.Curl.http) : enum
* [.pause](#module_node-libcurl.Curl.pause) : enum
* [.protocol](#module_node-libcurl.Curl.protocol) : enum
* [.header](#module_node-libcurl.Curl.header) : enum
* [.code](#module_node-libcurl.Curl.code) : enum
* [.netrc](#module_node-libcurl.Curl.netrc) : enum
* [.chunk](#module_node-libcurl.Curl.chunk) : enum
* [.filetype](#module_node-libcurl.Curl.filetype) : enum
* [.fnmatchfunc](#module_node-libcurl.Curl.fnmatchfunc) : enum
* [.ftpauth](#module_node-libcurl.Curl.ftpauth) : enum
* [.ftpssl](#module_node-libcurl.Curl.ftpssl) : enum
* [.ftpmethod](#module_node-libcurl.Curl.ftpmethod) : enum
* [.rtspreq](#module_node-libcurl.Curl.rtspreq) : enum
* [.ipresolve](#module_node-libcurl.Curl.ipresolve) : enum
* [.proxy](#module_node-libcurl.Curl.proxy) : enum
* [.pipe](#module_node-libcurl.Curl.pipe) : enum
* [.usessl](#module_node-libcurl.Curl.usessl) : enum
* [.sslversion](#module_node-libcurl.Curl.sslversion) : enum
* [.ssh_auth](#module_node-libcurl.Curl.ssh_auth) : enum
* [.timecond](#module_node-libcurl.Curl.timecond) : enum
* [.feature](#module_node-libcurl.Curl.feature) : enum
* [.global](#module_node-libcurl.Curl.global) : enum
* [.VERSION_NUM](#module_node-libcurl.Curl.VERSION_NUM)
* _inner_
* [~progressCallback](#module_node-libcurl.Curl..progressCallback) ⇒ Number
* [.Easy](#module_node-libcurl.Easy)
* [new Easy([orig])](#new_module_node-libcurl.Easy_new)
* _instance_
* ~~[.onData](#module_node-libcurl.Easy+onData) : [onDataCallback](#module_node-libcurl.Easy..onDataCallback)~~
* ~~[.onHeader](#module_node-libcurl.Easy+onHeader) : [onHeaderCallback](#module_node-libcurl.Easy..onHeaderCallback)~~
* [.setOpt(optionIdOrName, optionValue)](#module_node-libcurl.Easy+setOpt) ⇒ [code](#module_node-libcurl.Curl.code)
* [.getInfo(infoNameOrId)](#module_node-libcurl.Easy+getInfo) ⇒ [ReturnData](#module_node-libcurl.Easy..ReturnData)
* [.send(buf)](#module_node-libcurl.Easy+send) ⇒ [ReturnData](#module_node-libcurl.Easy..ReturnData)
* [.recv(buf)](#module_node-libcurl.Easy+recv) ⇒ module:node-libcurl.Easy.ReturnData
* [.perform()](#module_node-libcurl.Easy+perform) ⇒ [code](#module_node-libcurl.Curl.code)
* [.pause(bitmask)](#module_node-libcurl.Easy+pause) ⇒ [code](#module_node-libcurl.Curl.code)
* [.reset()](#module_node-libcurl.Easy+reset) ⇒ [code](#module_node-libcurl.Curl.code)
* [.dupHandle()](#module_node-libcurl.Easy+dupHandle) ⇒ [Easy](#module_node-libcurl.Easy)
* [.onSocketEvent(cb)](#module_node-libcurl.Easy+onSocketEvent) ⇒ [Easy](#module_node-libcurl.Easy)
* [.monitorSocketEvents()](#module_node-libcurl.Easy+monitorSocketEvents) ⇒ [Easy](#module_node-libcurl.Easy)
* [.unmonitorSocketEvents()](#module_node-libcurl.Easy+unmonitorSocketEvents) ⇒ [Easy](#module_node-libcurl.Easy)
* [.close()](#module_node-libcurl.Easy+close)
* _static_
* [.socket](#module_node-libcurl.Easy.socket) : enum
* [.strError(code)](#module_node-libcurl.Easy.strError) ⇒ String
* _inner_
* [~ReturnData](#module_node-libcurl.Easy..ReturnData) : Object
* [~onDataCallback](#module_node-libcurl.Easy..onDataCallback) ⇒ Number
* [~onHeaderCallback](#module_node-libcurl.Easy..onHeaderCallback) ⇒ Number
* [~onSocketEventCallback](#module_node-libcurl.Easy..onSocketEventCallback) : function
* [.Multi](#module_node-libcurl.Multi)
* [new Multi()](#new_module_node-libcurl.Multi_new)
* _instance_
* [.setOpt(optionIdOrName, optionValue)](#module_node-libcurl.Multi+setOpt) ⇒ [code](#module_node-libcurl.Curl.code)
* [.addHandle(handle)](#module_node-libcurl.Multi+addHandle) ⇒ [code](#module_node-libcurl.Curl.code)
* [.onMessage(cb)](#module_node-libcurl.Multi+onMessage) ⇒ [Multi](#module_node-libcurl.Multi)
* [.removeHandle(handle)](#module_node-libcurl.Multi+removeHandle) ⇒ [code](#module_node-libcurl.Curl.code)
* [.getCount()](#module_node-libcurl.Multi+getCount) ⇒ Number
* [.close()](#module_node-libcurl.Multi+close)
* _static_
* [.strError(code)](#module_node-libcurl.Multi.strError) ⇒ String
* _inner_
* [~onMessageCallback](#module_node-libcurl.Multi..onMessageCallback) : function
* [.Share](#module_node-libcurl.Share)
* [new Share()](#new_module_node-libcurl.Share_new)
* _instance_
* [.setOpt(optionIdOrName, optionValue)](#module_node-libcurl.Share+setOpt) ⇒ [code](#module_node-libcurl.Curl.code)
* [.close()](#module_node-libcurl.Share+close)
* _static_
* [.strError(code)](#module_node-libcurl.Share.strError) ⇒ String
* _inner_
* [~CurlFileInfo](#module_node-libcurl..CurlFileInfo) : Object
### node-libcurl.Curl ⇐ EventEmitter
**Kind**: static class of [node-libcurl](#module_node-libcurl)
**Extends:** EventEmitter
* [.Curl](#module_node-libcurl.Curl) ⇐ EventEmitter
* [new Curl()](#new_module_node-libcurl.Curl_new)
* _instance_
* ~~[.onData](#module_node-libcurl.Curl+onData) : [onDataCallback](#module_node-libcurl.Easy..onDataCallback)~~
* ~~[.onHeader](#module_node-libcurl.Curl+onHeader) : [onHeaderCallback](#module_node-libcurl.Easy..onHeaderCallback)~~
* [.enable(bitmask)](#module_node-libcurl.Curl+enable) ⇒ [Curl](#module_node-libcurl.Curl)
* [.disable(bitmask)](#module_node-libcurl.Curl+disable) ⇒ [Curl](#module_node-libcurl.Curl)
* [.setOpt(optionIdOrName, optionValue)](#module_node-libcurl.Curl+setOpt) ⇒ [Curl](#module_node-libcurl.Curl)
* [.getInfo(infoNameOrId)](#module_node-libcurl.Curl+getInfo) ⇒ String | Number | Array
* [.setProgressCallback(cb)](#module_node-libcurl.Curl+setProgressCallback) ⇒ [Curl](#module_node-libcurl.Curl)
* [.perform()](#module_node-libcurl.Curl+perform) ⇒ [Curl](#module_node-libcurl.Curl)
* [.pause(bitmask)](#module_node-libcurl.Curl+pause) ⇒ [Curl](#module_node-libcurl.Curl)
* [.reset()](#module_node-libcurl.Curl+reset) ⇒ [Curl](#module_node-libcurl.Curl)
* [.dupHandle([shouldCopyCallbacks], [shouldCopyEventListeners])](#module_node-libcurl.Curl+dupHandle) ⇒ [Curl](#module_node-libcurl.Curl)
* [.close()](#module_node-libcurl.Curl+close)
* ["data" (chunk)](#module_node-libcurl.Curl+event_data)
* ["header" (chunk)](#module_node-libcurl.Curl+event_header)
* ["error" (err, errCode)](#module_node-libcurl.Curl+event_error)
* ["end" (status, argBody, argBody)](#module_node-libcurl.Curl+event_end)
* _static_
* [.getCount](#module_node-libcurl.Curl.getCount) ⇒ Number
* [.getVersion](#module_node-libcurl.Curl.getVersion) ⇒ String
* [.globalInit](#module_node-libcurl.Curl.globalInit) ⇒ Number
* [.globalCleanup](#module_node-libcurl.Curl.globalCleanup)
* [.option](#module_node-libcurl.Curl.option) : enum
* [.multi](#module_node-libcurl.Curl.multi) : enum
* [.share](#module_node-libcurl.Curl.share) : enum
* [.lock](#module_node-libcurl.Curl.lock) : enum
* [.info](#module_node-libcurl.Curl.info) : enum
* [.auth](#module_node-libcurl.Curl.auth) : enum
* [.http](#module_node-libcurl.Curl.http) : enum
* [.pause](#module_node-libcurl.Curl.pause) : enum
* [.protocol](#module_node-libcurl.Curl.protocol) : enum
* [.header](#module_node-libcurl.Curl.header) : enum
* [.code](#module_node-libcurl.Curl.code) : enum
* [.netrc](#module_node-libcurl.Curl.netrc) : enum
* [.chunk](#module_node-libcurl.Curl.chunk) : enum
* [.filetype](#module_node-libcurl.Curl.filetype) : enum
* [.fnmatchfunc](#module_node-libcurl.Curl.fnmatchfunc) : enum
* [.ftpauth](#module_node-libcurl.Curl.ftpauth) : enum
* [.ftpssl](#module_node-libcurl.Curl.ftpssl) : enum
* [.ftpmethod](#module_node-libcurl.Curl.ftpmethod) : enum
* [.rtspreq](#module_node-libcurl.Curl.rtspreq) : enum
* [.ipresolve](#module_node-libcurl.Curl.ipresolve) : enum
* [.proxy](#module_node-libcurl.Curl.proxy) : enum
* [.pipe](#module_node-libcurl.Curl.pipe) : enum
* [.usessl](#module_node-libcurl.Curl.usessl) : enum
* [.sslversion](#module_node-libcurl.Curl.sslversion) : enum
* [.ssh_auth](#module_node-libcurl.Curl.ssh_auth) : enum
* [.timecond](#module_node-libcurl.Curl.timecond) : enum
* [.feature](#module_node-libcurl.Curl.feature) : enum
* [.global](#module_node-libcurl.Curl.global) : enum
* [.VERSION_NUM](#module_node-libcurl.Curl.VERSION_NUM)
* _inner_
* [~progressCallback](#module_node-libcurl.Curl..progressCallback) ⇒ Number
#### new Curl()
Wrapper class around one easy handle.
It provides a more *nodejs-friendly* interface.
#### ~~curl.onData : [onDataCallback](#module_node-libcurl.Easy..onDataCallback)~~
***Deprecated***
Use [setOpt](#module_node-libcurl.Curl+setOpt)( Curl.option.WRITEFUNCTION, onDataCallback ) instead.
**Kind**: instance property of [Curl](#module_node-libcurl.Curl)
#### ~~curl.onHeader : [onHeaderCallback](#module_node-libcurl.Easy..onHeaderCallback)~~
***Deprecated***
Use [setOpt](#module_node-libcurl.Curl+setOpt)( Curl.option.HEADERFUNCTION, onHeaderCallback ) instead.
**Kind**: instance property of [Curl](#module_node-libcurl.Curl)
#### curl.enable(bitmask) ⇒ [Curl](#module_node-libcurl.Curl)
Enables a feature, should not be used while a request is running.
Check [feature](#module_node-libcurl.Curl.feature).
**Kind**: instance method of [Curl](#module_node-libcurl.Curl)
**Returns**: [Curl](#module_node-libcurl.Curl) - this
| Param | Type | Description |
| --- | --- | --- |
| bitmask | Number | Bitmask with the features to enable |
#### curl.disable(bitmask) ⇒ [Curl](#module_node-libcurl.Curl)
Disables a feature, should not be used while a request is running.
Check [feature](#module_node-libcurl.Curl.feature).
**Kind**: instance method of [Curl](#module_node-libcurl.Curl)
**Returns**: [Curl](#module_node-libcurl.Curl) - this
| Param | Type | Description |
| --- | --- | --- |
| bitmask | Number | Bitmask with the features to disable |
#### curl.setOpt(optionIdOrName, optionValue) ⇒ [Curl](#module_node-libcurl.Curl)
Use [option](#module_node-libcurl.Curl.option) for predefined constants.
**Kind**: instance method of [Curl](#module_node-libcurl.Curl)
**Returns**: [Curl](#module_node-libcurl.Curl) - this
| Param | Type | Description |
| --- | --- | --- |
| optionIdOrName | String | Number | Option id or name. |
| optionValue | \* | Value is relative to what option you are using. |
#### curl.getInfo(infoNameOrId) ⇒ String | Number | Array
Use [info](#module_node-libcurl.Curl.info) for predefined constants.
**Kind**: instance method of [Curl](#module_node-libcurl.Curl)
**Returns**: String | Number | Array - Return type is based on the info requested.
| Param | Type | Description |
| --- | --- | --- |
| infoNameOrId | String | Number | Info id or name. |
#### curl.setProgressCallback(cb) ⇒ [Curl](#module_node-libcurl.Curl)
The option XFERINFOFUNCTION was introduced in curl version 7.32.0,
versions older than that should use PROGRESSFUNCTION.
If you don't want to mess with version numbers you can use this method,
instead of directly calling [setOpt](#module_node-libcurl.Curl+setOpt).
NOPROGRESS should be set to false to make this function actually get called.
**Kind**: instance method of [Curl](#module_node-libcurl.Curl)
**Returns**: [Curl](#module_node-libcurl.Curl) - this
| Param | Type |
| --- | --- |
| cb | [progressCallback](#module_node-libcurl.Curl..progressCallback) |
#### curl.perform() ⇒ [Curl](#module_node-libcurl.Curl)
Add this instance to the processing queue.
**Kind**: instance method of [Curl](#module_node-libcurl.Curl)
**Returns**: [Curl](#module_node-libcurl.Curl) - this
**Throws**:
- This method should be called only one time per request,
otherwise it will throw an exception.
#### curl.pause(bitmask) ⇒ [Curl](#module_node-libcurl.Curl)
Using this function, you can explicitly mark a running connection to get paused, and you can unpause a connection that was previously paused.
The bitmask argument is a set of bits that sets the new state of the connection.
**Kind**: instance method of [Curl](#module_node-libcurl.Curl)
**Returns**: [Curl](#module_node-libcurl.Curl) - this
| Param | Type |
| --- | --- |
| bitmask | [pause](#module_node-libcurl.Curl.pause) |
#### curl.reset() ⇒ [Curl](#module_node-libcurl.Curl)
Reset this handle options to their defaults.
**Kind**: instance method of [Curl](#module_node-libcurl.Curl)
**Returns**: [Curl](#module_node-libcurl.Curl) - this
#### curl.dupHandle([shouldCopyCallbacks], [shouldCopyEventListeners]) ⇒ [Curl](#module_node-libcurl.Curl)
Duplicate this handle with all their options.
Keep in mind that, by default, this also means anonymous functions
that were set as callbacks and all event listeners.
Using the arguments to change that behaviour.
**Kind**: instance method of [Curl](#module_node-libcurl.Curl)
**Returns**: [Curl](#module_node-libcurl.Curl) - New handle with all the options set in this handle.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [shouldCopyCallbacks] | Boolean | true | Should copy onData and onHeader callbacks |
| [shouldCopyEventListeners] | Boolean | true | Should copy current event listeners |
#### curl.close()
Close this handle.
NOTE: After closing the handle, it should not be used anymore!
Doing so will throw an exception.
**Kind**: instance method of [Curl](#module_node-libcurl.Curl)
#### "data" (chunk)
Data event
**Kind**: event emitted by [Curl](#module_node-libcurl.Curl)
| Param | Type | Description |
| --- | --- | --- |
| chunk | Buffer | The data that was received. |
#### "header" (chunk)
Header event
**Kind**: event emitted by [Curl](#module_node-libcurl.Curl)
| Param | Type | Description |
| --- | --- | --- |
| chunk | Buffer | The header that was received. |
#### "error" (err, errCode)
Error event
**Kind**: event emitted by [Curl](#module_node-libcurl.Curl)
| Param | Type | Description |
| --- | --- | --- |
| err | Error | Error object |
| errCode | Number | libcurl error code. |
#### "end" (status, argBody, argBody)
End event
**Kind**: event emitted by [Curl](#module_node-libcurl.Curl)
| Param | Type | Description |
| --- | --- | --- |
| status | Number | Last received response code |
| argBody | String | Buffer | If [Curl.feature.NO_DATA_PARSING](#module_node-libcurl.Curl.feature) is set, a Buffer is passed instead of a string. |
| argBody | Array | Buffer | If [Curl.feature.NO_HEADER_PARSING](#module_node-libcurl.Curl.feature) is set, a Buffer is passed instead of an array with the headers. |
#### Curl.getCount ⇒ Number
Returns the number of handles currently open in the internal multi handle being used.
**Kind**: static property of [Curl](#module_node-libcurl.Curl)
#### Curl.getVersion ⇒ String
Returns libcurl version string.
The string shows which features are enabled,
and the version of the libraries that libcurl was built with.
**Kind**: static property of [Curl](#module_node-libcurl.Curl)
#### Curl.globalInit ⇒ Number
Calls [curl_global_init()](http://curl.haxx.se/libcurl/c/curl_global_init.html)
**Kind**: static property of [Curl](#module_node-libcurl.Curl)
**Returns**: Number - Status code, see [code](#module_node-libcurl.Curl.code)
| Param | Type | Description |
| --- | --- | --- |
| flags | Number | Flag of options, see [global](#module_node-libcurl.Curl.global) |
#### Curl.globalCleanup
Calls [curl_global_cleanup()](http://curl.haxx.se/libcurl/c/curl_global_cleanup.html)
**Kind**: static property of [Curl](#module_node-libcurl.Curl)
#### Curl.option : enum
Options to be used with easy.setOpt or curl.setOpt
See the official documentation of [curl_easy_setopt()](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html) for reference.
``CURLOPT_URL`` becomes ``Curl.option.URL``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
#### Curl.multi : enum
Options to be used with multi.setOpt()
``CURLMOPT_MAXCONNECTS`` becomes ``Curl.multi.MAXCONNECTS``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
#### Curl.share : enum
Options to be used with share.setOpt()
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**See**: module:node-libcurl.Curl.lock
**Properties**
| Name | Type | Default |
| --- | --- | --- |
| SHARE | Number | 1 |
| UNSHARE | Number | 2 |
#### Curl.lock : enum
Options to be used with the Curl.share.SHARE and Curl.share.UNSHARE options.
``CURL_LOCK_DATA_COOKIE`` becomes ``Curl.lock.DATA_COOKIE``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**Properties**
| Name | Type | Default |
| --- | --- | --- |
| DATA_COOKIE | Number | 2 |
| DATA_DNS | Number | 3 |
| DATA_SSL_SESSION | Number | 4 |
#### Curl.info : enum
Infos to be used with easy.getInfo() or curl.getInfo()
See the official documentation of [curl_easy_getinfo()](http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html) for reference.
``CURLINFO_EFFECTIVE_URL`` becomes ``Curl.info.EFFECTIVE_URL``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
#### Curl.auth : enum
Object with bitmasks that should be used with the HTTPAUTH option.
``CURLAUTH_BASIC`` becomes ``Curl.auth.BASIC``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
#### Curl.http : enum
Object with constants to be used with the HTTP_VERSION option.
``CURL_HTTP_VERSION_NONE`` becomes ``Curl.http.VERSION_NONE``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
#### Curl.pause : enum
Object with constants to be used with the pause method.
``CURLPAUSE_RECV`` becomes ``Curl.pause.RECV``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
#### Curl.protocol : enum
Object with the protocols supported by libcurl, as bitmasks.
Should be used when setting PROTOCOLS and REDIR_PROTOCOLS options.
``CURLPROTO_HTTP`` becomes ``Curl.proto.HTTP``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
#### Curl.header : enum
Object with the avaialable bitmasks to be used with HEADEROPT.
Available since libcurl version >= 7.37.0
``CURLHEADER_UNIFIED`` becomes ``Curl.header.UNIFIED``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
#### Curl.code : enum
Object with the CURLM_ and CURLE_ constants.
``CURLE_OK`` becomes ``Curl.code.CURLE_OK``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
#### Curl.netrc : enum
Object with constants to be used with NETRC option.
``CURL_NETRC_OPTIONAL`` becomes ``Curl.netrc.OPTIONAL``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**Properties**
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| IGNORED | Number | 0 | The .netrc will never be read. Default. |
| OPTIONAL | Number | 1 | A user:password in the URL will be preferred to one in the .netrc. |
| REQUIRED | Number | 2 | A user:password in the URL will be ignored. Unless one is set programmatically, the .netrc will be queried. |
#### Curl.chunk : enum
Object with constants to be used as the return value for the callbacks set
with the options ``CHUNK_BGN_FUNCTION`` and ``CHUNK_END_FUNCTION``.
``CURL_CHUNK_BGN_FUNC_OK`` becomes ``Curl.chunk.BGN_FUNC_OK``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**Properties**
| Name | Type | Default |
| --- | --- | --- |
| BGN_FUNC_OK | Number | 0 |
| BGN_FUNC_FAIL | Number | 1 |
| BGN_FUNC_SKIP | Number | 2 |
| END_FUNC_OK | Number | 0 |
| END_FUNC_FAIL | Number | 1 |
#### Curl.filetype : enum
Object with constants to be used when using the [module:node-libcurl#CurlFileInfo](module:node-libcurl#CurlFileInfo) object,
mostly used alongside the ``CHUNK_BGN_FUNCTION`` option
``CURLFILETYPE_FILE`` becomes ``Curl.filetype.FILE``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**Properties**
| Name | Type | Default |
| --- | --- | --- |
| FILE | Number | 0 |
| DIRECTORY | Number | 1 |
| SYMLINK | Number | 2 |
| DEVICE_BLOCK | Number | 3 |
| DEVICE_CHAR | Number | 4 |
| NAMEDPIPE | Number | 5 |
| SOCKET | Number | 6 |
| DOOR | Number | 7 |
#### Curl.fnmatchfunc : enum
Object with constants to be used as the return value for the callback set
with the option ``FNMATCH_FUNCTION``.
``CURL_FNMATCHFUNC_MATCH`` becomes ``Curl.fnmatchfunc.MATCH``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**Properties**
| Name | Type | Default |
| --- | --- | --- |
| MATCH | Number | 0 |
| NOMATCH | Number | 1 |
| FAIL | Number | 2 |
#### Curl.ftpauth : enum
Object with constants for option ``FTPSSLAUTH``
``CURLFTPAUTH_DEFAULT`` becomes ``Curl.ftpauth.DEFAULT``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**Properties**
| Name | Type | Default |
| --- | --- | --- |
| DEFAULT | Number | 0 |
| SSL | Number | 1 |
| TLS | Number | 2 |
#### Curl.ftpssl : enum
Object with constants for option ``FTP_SSL_CCC``
``CURLFTPSSL_CCC_NONE`` becomes ``Curl.ftpssl.CCC_NONE``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**Properties**
| Name | Type | Default |
| --- | --- | --- |
| CCC_NONE | Number | 0 |
| CCC_PASSIVE | Number | 1 |
| CCC_ACTIVE | Number | 2 |
#### Curl.ftpmethod : enum
Object with constants for option ``FTP_FILEMETHOD``
``CURLFTPMETHOD_MULTICWD`` becomes ``Curl.ftpmethod.MULTICWD``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**Properties**
| Name | Type | Default |
| --- | --- | --- |
| DEFAULT | Number | 0 |
| MULTICWD | Number | 1 |
| NOCWD | Number | 2 |
| SINGLECWD | Number | 3 |
#### Curl.rtspreq : enum
Object with constants for option ``RTSP_REQUEST``
Only available on libcurl >= 7.20
``CURL_RTSPREQ_OPTIONS`` becomes ``Curl.rtspreq.OPTIONS``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**Properties**
| Name | Type | Default |
| --- | --- | --- |
| OPTIONS | Number | 0 |
| DESCRIBE | Number | 1 |
| ANNOUNCE | Number | 2 |
| SETUP | Number | 3 |
| PLAY | Number | 4 |
| PAUSE | Number | 5 |
| TEARDOWN | Number | 6 |
| GET_PARAMETER | Number | 7 |
| SET_PARAMETER | Number | 8 |
| RECORD | Number | 9 |
| RECEIVE | Number | 10 |
#### Curl.ipresolve : enum
Object with constants for option ``IPRESOLVE``
``CURL_IPRESOLVE_V4`` becomes ``Curl.ipresolve.V4``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**Properties**
| Name | Type | Default |
| --- | --- | --- |
| WHATEVER | Number | 0 |
| V4 | Number | 1 |
| V6 | Number | 2 |
#### Curl.proxy : enum
Object with constants for option ``PROXYTYPE``
``CURLPROXY_HTTP`` becomes ``Curl.proxy.HTTP``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**Properties**
| Name | Type | Default |
| --- | --- | --- |
| HTTP | Number | 0 |
| HTTP_1_0 | Number | 1 |
| SOCKS4 | Number | 4 |
| SOCKS5 | Number | 5 |
| SOCKS4A | Number | 6 |
| SOCKS5_HOSTNAME | Number | 7 |
#### Curl.pipe : enum
Object with bit constants to be used with the multi handle option ``PIPELINING``
Those are available starting with libcurl 7.43.0.
``CURLPIPE_NOTHING`` becomes ``Curl.pipe.NOTHING``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**See**: https://curl.haxx.se/libcurl/c/CURLMOPT_PIPELINING.html
**Properties**
| Name | Type | Default |
| --- | --- | --- |
| NOTHING | Number | 0 |
| HTTP1 | Number | 1 |
| MULTIPLEX | Number | 2 |
#### Curl.usessl : enum
Object with constants for option ``USE_SSL``
``CURLUSESSL_NONE`` becomes ``Curl.usessl.NONE``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**Properties**
| Name | Type | Default |
| --- | --- | --- |
| NONE | Number | 0 |
| TRY | Number | 1 |
| CONTROL | Number | 2 |
| ALL | Number | 3 |
#### Curl.sslversion : enum
Object with constants for option ``SSLVERSION``
``CURL_SSLVERSION_DEFAULT`` becomes ``Curl.sslversion.DEFAULT``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**Properties**
| Name | Type | Default |
| --- | --- | --- |
| DEFAULT | Number | 0 |
| TLSv1 | Number | 1 |
| SSLv2 | Number | 2 |
| SSLv3 | Number | 3 |
#### Curl.ssh_auth : enum
Object with constants for option ``SSH_AUTH_TYPES``
``CURLSSH_AUTH_PASSWORD`` becomes ``Curl.ssh_auth.PASSWORD``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**Properties**
| Name | Type | Default |
| --- | --- | --- |
| ANY | Number | ~0 |
| NONE | Number | 0 |
| PUBLICKEY | Number | Number | Number | Number | enum
Object with constants for option ``TIMECONDITION``
``CURL_TIMECOND_IFMODSINCE`` becomes ``Curl.timecond.IFMODSINCE``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**Properties**
| Name | Type | Default |
| --- | --- | --- |
| IFMODSINCE | Number | 0 |
| IFUNMODSINCE | Number | 1 |
#### Curl.feature : enum
Object with the features currently supported as bitmasks.
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**Properties**
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| NO_DATA_PARSING | Number | Number | Number | Number | Number | Number | enum
Object with constants for the function [globalInit](#module_node-libcurl.Curl.globalInit)
``CURL_GLOBAL_ALL`` becomes ``Curl.global.ALL``
**Kind**: static enum of [Curl](#module_node-libcurl.Curl)
**Read only**: true
**Properties**
| Name | Type | Default |
| --- | --- | --- |
| SSL | Number | Number | Number | Number | Number | 0 |
| ACK_EINTR | Number | [Curl](#module_node-libcurl.Curl)
#### Curl~progressCallback ⇒ Number
Progress callback called by libcurl.
**Kind**: inner typedef of [Curl](#module_node-libcurl.Curl)
**Returns**: Number - Returning a non-zero value from this callback will cause libcurl to abort the transfer and return CURLE_ABORTED_BY_CALLBACK.
**this**: {module:node-libcurl.Easy}
| Param | Type | Description |
| --- | --- | --- |
| dltotal | Number | Total number of bytes libcurl expects to download in this transfer. |
| dlnow | Number | Number of bytes downloaded so far. |
| ultotal | Number | Total number of bytes libcurl expects to upload in this transfer. |
| ulnow | Number | Number of bytes uploaded so far. |
### node-libcurl.Easy
**Kind**: static class of [node-libcurl](#module_node-libcurl)
* [.Easy](#module_node-libcurl.Easy)
* [new Easy([orig])](#new_module_node-libcurl.Easy_new)
* _instance_
* ~~[.onData](#module_node-libcurl.Easy+onData) : [onDataCallback](#module_node-libcurl.Easy..onDataCallback)~~
* ~~[.onHeader](#module_node-libcurl.Easy+onHeader) : [onHeaderCallback](#module_node-libcurl.Easy..onHeaderCallback)~~
* [.setOpt(optionIdOrName, optionValue)](#module_node-libcurl.Easy+setOpt) ⇒ [code](#module_node-libcurl.Curl.code)
* [.getInfo(infoNameOrId)](#module_node-libcurl.Easy+getInfo) ⇒ [ReturnData](#module_node-libcurl.Easy..ReturnData)
* [.send(buf)](#module_node-libcurl.Easy+send) ⇒ [ReturnData](#module_node-libcurl.Easy..ReturnData)
* [.recv(buf)](#module_node-libcurl.Easy+recv) ⇒ module:node-libcurl.Easy.ReturnData
* [.perform()](#module_node-libcurl.Easy+perform) ⇒ [code](#module_node-libcurl.Curl.code)
* [.pause(bitmask)](#module_node-libcurl.Easy+pause) ⇒ [code](#module_node-libcurl.Curl.code)
* [.reset()](#module_node-libcurl.Easy+reset) ⇒ [code](#module_node-libcurl.Curl.code)
* [.dupHandle()](#module_node-libcurl.Easy+dupHandle) ⇒ [Easy](#module_node-libcurl.Easy)
* [.onSocketEvent(cb)](#module_node-libcurl.Easy+onSocketEvent) ⇒ [Easy](#module_node-libcurl.Easy)
* [.monitorSocketEvents()](#module_node-libcurl.Easy+monitorSocketEvents) ⇒ [Easy](#module_node-libcurl.Easy)
* [.unmonitorSocketEvents()](#module_node-libcurl.Easy+unmonitorSocketEvents) ⇒ [Easy](#module_node-libcurl.Easy)
* [.close()](#module_node-libcurl.Easy+close)
* _static_
* [.socket](#module_node-libcurl.Easy.socket) : enum
* [.strError(code)](#module_node-libcurl.Easy.strError) ⇒ String
* _inner_
* [~ReturnData](#module_node-libcurl.Easy..ReturnData) : Object
* [~onDataCallback](#module_node-libcurl.Easy..onDataCallback) ⇒ Number
* [~onHeaderCallback](#module_node-libcurl.Easy..onHeaderCallback) ⇒ Number
* [~onSocketEventCallback](#module_node-libcurl.Easy..onSocketEventCallback) : function
#### new Easy([orig])
Easy handle constructor
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [orig] | Easy | orig.dupHandle(); |
#### ~~easy.onData : [onDataCallback](#module_node-libcurl.Easy..onDataCallback)~~
***Deprecated***
Use [setOpt](#module_node-libcurl.Easy+setOpt)( Curl.option.WRITEFUNCTION, onDataCallback ) instead.
**Kind**: instance property of [Easy](#module_node-libcurl.Easy)
#### ~~easy.onHeader : [onHeaderCallback](#module_node-libcurl.Easy..onHeaderCallback)~~
***Deprecated***
Use [setOpt](#module_node-libcurl.Easy+setOpt)( Curl.option.HEADERFUNCTION, onHeaderCallback ) instead.
**Kind**: instance property of [Easy](#module_node-libcurl.Easy)
#### easy.setOpt(optionIdOrName, optionValue) ⇒ [code](#module_node-libcurl.Curl.code)
Use [option](#module_node-libcurl.Curl.option) for predefined constants.
Official libcurl documentation: [curl_easy_setopt()](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html)
**Kind**: instance method of [Easy](#module_node-libcurl.Easy)
**Returns**: [code](#module_node-libcurl.Curl.code) - code Should be Curl.code.CURLE_OK.
| Param | Type | Description |
| --- | --- | --- |
| optionIdOrName | String | Number | Option id or name. |
| optionValue | \* | Value is relative to what option you are using. |
#### easy.getInfo(infoNameOrId) ⇒ [ReturnData](#module_node-libcurl.Easy..ReturnData)
Use [info](#module_node-libcurl.Curl.info) for predefined constants.
Official libcurl documentation: [curl_easy_getinfo()](http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html)
**Kind**: instance method of [Easy](#module_node-libcurl.Easy)
**Returns**: [ReturnData](#module_node-libcurl.Easy..ReturnData) - .data will be the requested info
| Param | Type | Description |
| --- | --- | --- |
| infoNameOrId | String | Number | Info id or name. |
#### easy.send(buf) ⇒ [ReturnData](#module_node-libcurl.Easy..ReturnData)
Sends arbitrary data over the established connection.
Official libcurl documentation: [curl_easy_send()](http://curl.haxx.se/libcurl/c/curl_easy_send.html)
**Kind**: instance method of [Easy](#module_node-libcurl.Easy)
**Returns**: [ReturnData](#module_node-libcurl.Easy..ReturnData) - .data will be the numbers of bytes sent.
| Param | Type | Description |
| --- | --- | --- |
| buf | Buffer | The data to be sent |
#### easy.recv(buf) ⇒ module:node-libcurl.Easy.ReturnData
Receives arbitrary data over the established connection.
Official libcurl documentation: [curl_easy_recv()](http://curl.haxx.se/libcurl/c/curl_easy_recv.html)
**Kind**: instance method of [Easy](#module_node-libcurl.Easy)
**Returns**: module:node-libcurl.Easy.ReturnData - .data will be the numbers of bytes received.
| Param | Type | Description |
| --- | --- | --- |
| buf | Buffer | The data will be stored inside this Buffer instance. You need to make sure that the buffer has enought space to store it all. |
#### easy.perform() ⇒ [code](#module_node-libcurl.Curl.code)
Performs the entire request in a blocking manner and returns when done.
Official libcurl documentation: [http://curl.haxx.se/libcurl/c/curl_easy_perform.html](http://curl.haxx.se/libcurl/c/curl_easy_perform.html)
**Kind**: instance method of [Easy](#module_node-libcurl.Easy)
**Returns**: [code](#module_node-libcurl.Curl.code) - code Should be Curl.code.CURLE_OK.
#### easy.pause(bitmask) ⇒ [code](#module_node-libcurl.Curl.code)
Using this function, you can explicitly mark a running connection
to get paused, and you can unpause a connection that was previously paused.
Official libcurl documentation: [curl_easy_pause()](http://curl.haxx.se/libcurl/c/curl_easy_pause.html)
**Kind**: instance method of [Easy](#module_node-libcurl.Easy)
**Returns**: [code](#module_node-libcurl.Curl.code) - code Should be Curl.code.CURLE_OK.
| Param | Type | Description |
| --- | --- | --- |
| bitmask | [pause](#module_node-libcurl.Curl.pause) | bitmask set of bits that sets the new state of the connection. |
#### easy.reset() ⇒ [code](#module_node-libcurl.Curl.code)
Reset this handle to their original state.
Official libcurl documentation: [curl_easy_reset()](http://curl.haxx.se/libcurl/c/curl_easy_reset.html)
**Kind**: instance method of [Easy](#module_node-libcurl.Easy)
**Returns**: [code](#module_node-libcurl.Curl.code) - code Should be Curl.code.CURLE_OK.
#### easy.dupHandle() ⇒ [Easy](#module_node-libcurl.Easy)
Duplicate this handle with all their options
Official libcurl documentation: [curl_easy_duphandle()](http://curl.haxx.se/libcurl/c/curl_easy_duphandle.html)
**Kind**: instance method of [Easy](#module_node-libcurl.Easy)
**Returns**: [Easy](#module_node-libcurl.Easy) - handle Returns the new handle.
#### easy.onSocketEvent(cb) ⇒ [Easy](#module_node-libcurl.Easy)
The only time this method should be used is when one enables
the internal polling of the connection socket used by this handle (by
calling [Easy#monitorSocketEvents](#module_node-libcurl.Easy+monitorSocketEvents)),
the callback is going to be called everytime there is some change to the socket.
One use case for that is when using the
[Easy#send](#module_node-libcurl.Easy+send)
and [Easy#recv](#module_node-libcurl.Easy+recv) methods.
**Kind**: instance method of [Easy](#module_node-libcurl.Easy)
**Returns**: [Easy](#module_node-libcurl.Easy) - this
| Param | Type |
| --- | --- |
| cb | [onSocketEventCallback](#module_node-libcurl.Easy..onSocketEventCallback) |
#### easy.monitorSocketEvents() ⇒ [Easy](#module_node-libcurl.Easy)
Start monitoring for events in the connection socket used by this handle.
**Kind**: instance method of [Easy](#module_node-libcurl.Easy)
**Returns**: [Easy](#module_node-libcurl.Easy) - this
**See**: module:node-libcurl.Easy#unmonitorSocketEvents
#### easy.unmonitorSocketEvents() ⇒ [Easy](#module_node-libcurl.Easy)
Stop monitoring for events in the connection socket used by this handle.
**Kind**: instance method of [Easy](#module_node-libcurl.Easy)
**Returns**: [Easy](#module_node-libcurl.Easy) - this
**See**: module:node-libcurl.Easy#monitorSocketEvents
#### easy.close()
Close this handle and dispose any resources bound to it.
After closed, the handle **MUST** not be used again.
This is basically the same than [curl_easy_cleanup()](http://curl.haxx.se/libcurl/c/curl_easy_cleanup.html)
**Kind**: instance method of [Easy](#module_node-libcurl.Easy)
#### Easy.socket : enum
**Kind**: static enum of [Easy](#module_node-libcurl.Easy)
**Read only**: true
**Properties**
| Name | Type | Default |
| --- | --- | --- |
| READABLE | Number | 1 |
| WRITABLE | Number | 2 |
#### Easy.strError(code) ⇒ String
Returns a description for the given error code.
Official libcurl documentation: [curl_easy_strerror()](http://curl.haxx.se/libcurl/c/curl_easy_strerror.html)
**Kind**: static method of [Easy](#module_node-libcurl.Easy)
| Param | Type |
| --- | --- |
| code | [code](#module_node-libcurl.Curl.code) |
#### Easy~ReturnData : Object
This literal object is returned for calls that cannot return single values.
Like [getInfo](#module_node-libcurl.Easy+getInfo) and [send](#module_node-libcurl.Easy+send)
**Kind**: inner typedef of [Easy](#module_node-libcurl.Easy)
**Properties**
| Name | Type | Description |
| --- | --- | --- |
| code | [code](#module_node-libcurl.Curl.code) | The return code for the given method call. It should be equals Curl.code.CURLE_OK to be valid. |
| data | \* | Data returned from the method call. |
#### Easy~onDataCallback ⇒ Number
onData callback for taking care of the data we just received.
This is basically the
[CURLOPT_WRITEFUNCTION](http://curl.haxx.se/libcurl/c/CURLOPT_WRITEFUNCTION.html)
option.
**Kind**: inner typedef of [Easy](#module_node-libcurl.Easy)
**Returns**: Number - The callback must return exactly nmemb * size, otherwise
it will signal libcurl to abort the transfer, and return with error code CURLE_WRITE_ERROR.
You can return Curl.pause.WRITEFUNC too, this will cause this transfer to become paused.
**this**: {module:node-libcurl.Easy}
**See**: module:node-libcurl.Easy#onData
| Param | Type |
| --- | --- |
| buf | Buffer |
| size | Number |
| nitems | Number |
#### Easy~onHeaderCallback ⇒ Number
onHeader callback for taking care of the headers we just received.
This is basically the
[CURLOPT_HEADERFUNCTION](http://curl.haxx.se/libcurl/c/CURLOPT_HEADERFUNCTION.html)
option.
**Kind**: inner typedef of [Easy](#module_node-libcurl.Easy)
**Returns**: Number - The callback must return exactly nmemb * size, otherwise
it will signal libcurl to abort the transfer, and return with error code CURLE_WRITE_ERROR.
**this**: {module:node-libcurl.Easy}
**See**: module:node-libcurl.Easy#onHeader
| Param | Type |
| --- | --- |
| buf | Buffer |
| size | Number |
| nitems | Number |
#### Easy~onSocketEventCallback : function
OnSocketEvent callback called when there are changes to the connection socket.
**Kind**: inner typedef of [Easy](#module_node-libcurl.Easy)
**this**: {module:node-libcurl.Easy}
| Param | Type | Description |
| --- | --- | --- |
| err | Error | Should be null if there are no errors. |
| events | [socket](#module_node-libcurl.Easy.socket) | The events that were detected in the socket |
### node-libcurl.Multi
**Kind**: static class of [node-libcurl](#module_node-libcurl)
* [.Multi](#module_node-libcurl.Multi)
* [new Multi()](#new_module_node-libcurl.Multi_new)
* _instance_
* [.setOpt(optionIdOrName, optionValue)](#module_node-libcurl.Multi+setOpt) ⇒ [code](#module_node-libcurl.Curl.code)
* [.addHandle(handle)](#module_node-libcurl.Multi+addHandle) ⇒ [code](#module_node-libcurl.Curl.code)
* [.onMessage(cb)](#module_node-libcurl.Multi+onMessage) ⇒ [Multi](#module_node-libcurl.Multi)
* [.removeHandle(handle)](#module_node-libcurl.Multi+removeHandle) ⇒ [code](#module_node-libcurl.Curl.code)
* [.getCount()](#module_node-libcurl.Multi+getCount) ⇒ Number
* [.close()](#module_node-libcurl.Multi+close)
* _static_
* [.strError(code)](#module_node-libcurl.Multi.strError) ⇒ String
* _inner_
* [~onMessageCallback](#module_node-libcurl.Multi..onMessageCallback) : function
#### new Multi()
Multi handle constructor
#### multi.setOpt(optionIdOrName, optionValue) ⇒ [code](#module_node-libcurl.Curl.code)
Use [multi](#module_node-libcurl.Curl.multi) for predefined constants.
Official libcurl documentation: [curl_multi_setopt()](http://curl.haxx.se/libcurl/c/curl_multi_setopt.html)
**Kind**: instance method of [Multi](#module_node-libcurl.Multi)
**Returns**: [code](#module_node-libcurl.Curl.code) - code Should be Curl.code.CURLM_OK.
| Param | Type | Description |
| --- | --- | --- |
| optionIdOrName | String | Number | Option id or name. |
| optionValue | \* | Value is relative to what option you are using. |
#### multi.addHandle(handle) ⇒ [code](#module_node-libcurl.Curl.code)
Adds an easy handle to be managed by this multi instance.
Official libcurl documentation: [curl_multi_add_handle()](http://curl.haxx.se/libcurl/c/curl_multi_add_handle.html)
**Kind**: instance method of [Multi](#module_node-libcurl.Multi)
**Returns**: [code](#module_node-libcurl.Curl.code) - code Should be Curl.code.CURLM_OK.
| Param | Type |
| --- | --- |
| handle | [Easy](#module_node-libcurl.Easy) |
#### multi.onMessage(cb) ⇒ [Multi](#module_node-libcurl.Multi)
This is basically an abstraction over [curl_multi_info_read()](http://curl.haxx.se/libcurl/c/curl_multi_info_read.html).
**Kind**: instance method of [Multi](#module_node-libcurl.Multi)
**Returns**: [Multi](#module_node-libcurl.Multi) - this
| Param | Type | Description |
| --- | --- | --- |
| cb | [onMessageCallback](#module_node-libcurl.Multi..onMessageCallback) | null | You can pass null to remove the current callback set. |
#### multi.removeHandle(handle) ⇒ [code](#module_node-libcurl.Curl.code)
Removes an easy handle that was inside this multi instance.
Official libcurl documentation: [curl_multi_remove_handle()](http://curl.haxx.se/libcurl/c/curl_multi_remove_handle.html)
**Kind**: instance method of [Multi](#module_node-libcurl.Multi)
**Returns**: [code](#module_node-libcurl.Curl.code) - code Should be Curl.code.CURLM_OK.
| Param | Type |
| --- | --- |
| handle | [Easy](#module_node-libcurl.Easy) |
#### multi.getCount() ⇒ Number
Utility method that returns the number of easy handles that are inside this instance.
**Kind**: instance method of [Multi](#module_node-libcurl.Multi)
**Returns**: Number - count
#### multi.close()
Closes this multi handle.
Keep in mind that this doesn't closes the easy handles
that were still inside this multi instance, you must do it manually.
This is basically the same than [curl_multi_cleanup()](http://curl.haxx.se/libcurl/c/curl_multi_cleanup.html)
**Kind**: instance method of [Multi](#module_node-libcurl.Multi)
#### Multi.strError(code) ⇒ String
Returns a description for the given error code.
Official libcurl documentation: [curl_multi_strerror()](http://curl.haxx.se/libcurl/c/curl_multi_strerror.html)
**Kind**: static method of [Multi](#module_node-libcurl.Multi)
| Param | Type |
| --- | --- |
| code | [code](#module_node-libcurl.Curl.code) |
#### Multi~onMessageCallback : function
OnMessage callback called when there
are new informations about handles inside this multi instance.
**Kind**: inner typedef of [Multi](#module_node-libcurl.Multi)
**this**: {module:node-libcurl.Multi}
**See**: module:node-libcurl.Multi#onMessage
| Param | Type | Description |
| --- | --- | --- |
| err | Error | Should be null if there are no errors. |
| easy | [Easy](#module_node-libcurl.Easy) | The easy handle that triggered the message. |
| errCode | [code](#module_node-libcurl.Curl.code) | |
### node-libcurl.Share
**Kind**: static class of [node-libcurl](#module_node-libcurl)
* [.Share](#module_node-libcurl.Share)
* [new Share()](#new_module_node-libcurl.Share_new)
* _instance_
* [.setOpt(optionIdOrName, optionValue)](#module_node-libcurl.Share+setOpt) ⇒ [code](#module_node-libcurl.Curl.code)
* [.close()](#module_node-libcurl.Share+close)
* _static_
* [.strError(code)](#module_node-libcurl.Share.strError) ⇒ String
#### new Share()
Share handle constructor
#### share.setOpt(optionIdOrName, optionValue) ⇒ [code](#module_node-libcurl.Curl.code)
Use [share](#module_node-libcurl.Curl.share) for predefined constants.
Official libcurl documentation: [curl_share_setopt()](http://curl.haxx.se/libcurl/c/curl_share_setopt.html)
**Kind**: instance method of [Share](#module_node-libcurl.Share)
**Returns**: [code](#module_node-libcurl.Curl.code) - code Should be Curl.code.CURLSHE_OK.
| Param | Type | Description |
| --- | --- | --- |
| optionIdOrName | String | Number | Option id or name. |
| optionValue | \* | Value is relative to what option you are using. |
#### share.close()
Closes this share handle.
This is basically the same than [curl_share_cleanup()](http://curl.haxx.se/libcurl/c/curl_share_cleanup.html)
**Kind**: instance method of [Share](#module_node-libcurl.Share)
#### Share.strError(code) ⇒ String
Returns a description for the given error code.
Official libcurl documentation: [curl_share_strerror()](http://curl.haxx.se/libcurl/c/curl_share_strerror.html)
**Kind**: static method of [Share](#module_node-libcurl.Share)
| Param | Type |
| --- | --- |
| code | [code](#module_node-libcurl.Curl.code) |
### node-libcurl~CurlFileInfo : Object
CurlFileInfo data type, the first parameter
passed to the callback set using the option ``CHUNK_BGN_FUNCTION``.
**Kind**: inner typedef of [node-libcurl](#module_node-libcurl)
**Read only**: true
**Properties**
| Name | Type | Description |
| --- | --- | --- |
| fileName | String | |
| fileType | Number | Value to be used with [filetype](#module_node-libcurl.Curl.filetype) |
| time | Date | |
| perm | Number | |
| uid | Number | |
| gid | Number | |
| size | Number | |
| hardLinks | Number | |
| strings | Object | |
| strings.time | String | |
| strings.perm | String | |
| strings.user | String | |
| strings.group | String | |
| strings.target | String | Null | |