Class Easy

Easy class that acts as an wrapper around the libcurl connection handle.

C++ source code

It can be used by itself, in a synchronous way:

import { Curl, CurlCode, Easy } from 'node-libcurl'
import { StringDecoder } from 'string_decoder'

const decoder = new StringDecoder('utf8')
const easyHandle = new Easy()

easyHandle.setOpt(Curl.option.URL, 'https://www.google.com')
// This is used to receive the headers
// See https://curl.haxx.se/libcurl/c/CURLOPT_HEADERFUNCTION.html
easyHandle.setOpt(Curl.option.HEADERFUNCTION, function (buf, size, nmemb) {
  console.log('Received some headers:', decoder.write(buf))
  return size * nmemb
})

// This is used to receive the response data
// See https://curl.haxx.se/libcurl/c/CURLOPT_WRITEFUNCTION.html
easyHandle.setOpt(Curl.option.WRITEFUNCTION, function (buf, size, nmemb) {
  console.log('Received some body:', decoder.write(buf))
  return size * nmemb
})

// this will trigger the request
const ret = easyHandle.perform()
// The Easy handle will block the JS main thread:
console.log('I will only show after the request has finished')
// In case there is something wrong, you can use Easy.strError to get a human readable string about the error
console.log(ret, ret === CurlCode.CURLE_OK, Easy.strError(ret))
// Remember to always close the handle after you have finished using it for good
easyHandle.close()

or with the Multi class, allowing asynchronous usage.

Index

Constructors

constructor

new Easy(): Easy
Returns Easy

Properties

`Readonly`id

id: number

This is the unique ID of the Easy handle.

This ID is also unique across threads.

`Readonly`isInsideMultiHandle

isInsideMultiHandle: boolean

This will be true if the handle was added to a Multi handle.

`Readonly`isMonitoringSockets

isMonitoringSockets: boolean

This will be true if monitorSocketEvents was called.

`Readonly`isOpen

isOpen: boolean

This will be true if close was not called.

`Readonly`isPausedRecv

isPausedRecv: boolean

`Readonly`isPausedSend

isPausedSend: boolean

`Readonly`pauseFlags

pauseFlags: CurlPause

private

private: any

You can set this to anything - Use it to bind some data to this Easy instance.

This will not be copied to other instaces created when duplicating this one.

Methods

close

close(): void
Close this handle and dispose any resources bound to it. After closed, the handle MUST not be used again, doing so will throw an Error.

This is basically the same than curl_easy_cleanup()

Returns void
- Defined in lib/Easy.ts:720

dupHandle

dupHandle(): Easy
Duplicate this handle with all their options and callbacks.

Official libcurl documentation: curl_easy_duphandle()

Returns Easy
- Defined in lib/Easy.ts:661

getInfo

getInfo(info: "CERTINFO"): GetInfoReturn<string[]>
Official libcurl documentation: curl_easy_getinfo()
Parameters
- info: "CERTINFO"
  Info to retrieve. Use Curl.info for predefined constants.
Returns GetInfoReturn<string[]>
- Defined in lib/Easy.ts:533
getInfo(
    info:
        | "ACTIVESOCKET"
        | "APPCONNECT_TIME"
        | "APPCONNECT_TIME_T"
        | "CAINFO"
        | "CAPATH"
        | "CONDITION_UNMET"
        | "CONN_ID"
        | "CONNECT_TIME"
        | "CONNECT_TIME_T"
        | "CONTENT_LENGTH_DOWNLOAD"
        | "CONTENT_LENGTH_DOWNLOAD_T"
        | "CONTENT_LENGTH_UPLOAD"
        | "CONTENT_LENGTH_UPLOAD_T"
        | "CONTENT_TYPE"
        | "COOKIELIST"
        | "EARLYDATA_SENT_T"
        | "EFFECTIVE_METHOD"
        | "EFFECTIVE_URL"
        | "FILETIME"
        | "FILETIME_T"
        | "FTP_ENTRY_PATH"
        | "HEADER_SIZE"
        | "HTTP_CONNECTCODE"
        | "HTTP_VERSION"
        | "HTTPAUTH_AVAIL"
        | "HTTPAUTH_USED"
        | "LASTSOCKET"
        | "LOCAL_IP"
        | "LOCAL_PORT"
        | "NAMELOOKUP_TIME"
        | "NAMELOOKUP_TIME_T"
        | "NUM_CONNECTS"
        | "OS_ERRNO"
        | "POSTTRANSFER_TIME_T"
        | "PRETRANSFER_TIME"
        | "PRETRANSFER_TIME_T"
        | "PRIMARY_IP"
        | "PRIMARY_PORT"
        | "PRIVATE"
        | "PROTOCOL"
        | "PROXY_ERROR"
        | "PROXY_SSL_VERIFYRESULT"
        | "PROXYAUTH_AVAIL"
        | "PROXYAUTH_USED"
        | "QUEUE_TIME_T"
        | "REDIRECT_COUNT"
        | "REDIRECT_TIME"
        | "REDIRECT_TIME_T"
        | "REDIRECT_URL"
        | "REFERER"
        | "REQUEST_SIZE"
        | "RESPONSE_CODE"
        | "RETRY_AFTER"
        | "RTSP_CLIENT_CSEQ"
        | "RTSP_CSEQ_RECV"
        | "RTSP_SERVER_CSEQ"
        | "RTSP_SESSION_ID"
        | "SCHEME"
        | "SIZE_DOWNLOAD"
        | "SIZE_DOWNLOAD_T"
        | "SIZE_UPLOAD"
        | "SIZE_UPLOAD_T"
        | "SPEED_DOWNLOAD"
        | "SPEED_DOWNLOAD_T"
        | "SPEED_UPLOAD"
        | "SPEED_UPLOAD_T"
        | "SSL_ENGINES"
        | "SSL_VERIFYRESULT"
        | "STARTTRANSFER_TIME"
        | "STARTTRANSFER_TIME_T"
        | "TLS_SESSION"
        | "TLS_SSL_PTR"
        | "TOTAL_TIME"
        | "TOTAL_TIME_T"
        | "USED_PROXY"
        | "XFER_ID",
): GetInfoReturn
Returns information about the finished connection.

Official libcurl documentation: curl_easy_getinfo()
Parameters
- info:
      | "ACTIVESOCKET"
      | "APPCONNECT_TIME"
      | "APPCONNECT_TIME_T"
      | "CAINFO"
      | "CAPATH"
      | "CONDITION_UNMET"
      | "CONN_ID"
      | "CONNECT_TIME"
      | "CONNECT_TIME_T"
      | "CONTENT_LENGTH_DOWNLOAD"
      | "CONTENT_LENGTH_DOWNLOAD_T"
      | "CONTENT_LENGTH_UPLOAD"
      | "CONTENT_LENGTH_UPLOAD_T"
      | "CONTENT_TYPE"
      | "COOKIELIST"
      | "EARLYDATA_SENT_T"
      | "EFFECTIVE_METHOD"
      | "EFFECTIVE_URL"
      | "FILETIME"
      | "FILETIME_T"
      | "FTP_ENTRY_PATH"
      | "HEADER_SIZE"
      | "HTTP_CONNECTCODE"
      | "HTTP_VERSION"
      | "HTTPAUTH_AVAIL"
      | "HTTPAUTH_USED"
      | "LASTSOCKET"
      | "LOCAL_IP"
      | "LOCAL_PORT"
      | "NAMELOOKUP_TIME"
      | "NAMELOOKUP_TIME_T"
      | "NUM_CONNECTS"
      | "OS_ERRNO"
      | "POSTTRANSFER_TIME_T"
      | "PRETRANSFER_TIME"
      | "PRETRANSFER_TIME_T"
      | "PRIMARY_IP"
      | "PRIMARY_PORT"
      | "PRIVATE"
      | "PROTOCOL"
      | "PROXY_ERROR"
      | "PROXY_SSL_VERIFYRESULT"
      | "PROXYAUTH_AVAIL"
      | "PROXYAUTH_USED"
      | "QUEUE_TIME_T"
      | "REDIRECT_COUNT"
      | "REDIRECT_TIME"
      | "REDIRECT_TIME_T"
      | "REDIRECT_URL"
      | "REFERER"
      | "REQUEST_SIZE"
      | "RESPONSE_CODE"
      | "RETRY_AFTER"
      | "RTSP_CLIENT_CSEQ"
      | "RTSP_CSEQ_RECV"
      | "RTSP_SERVER_CSEQ"
      | "RTSP_SESSION_ID"
      | "SCHEME"
      | "SIZE_DOWNLOAD"
      | "SIZE_DOWNLOAD_T"
      | "SIZE_UPLOAD"
      | "SIZE_UPLOAD_T"
      | "SPEED_DOWNLOAD"
      | "SPEED_DOWNLOAD_T"
      | "SPEED_UPLOAD"
      | "SPEED_UPLOAD_T"
      | "SSL_ENGINES"
      | "SSL_VERIFYRESULT"
      | "STARTTRANSFER_TIME"
      | "STARTTRANSFER_TIME_T"
      | "TLS_SESSION"
      | "TLS_SSL_PTR"
      | "TOTAL_TIME"
      | "TOTAL_TIME_T"
      | "USED_PROXY"
      | "XFER_ID"
  Info to retrieve. Use Curl.info for predefined constants.
Returns GetInfoReturn
- Defined in lib/Easy.ts:542

monitorSocketEvents

monitorSocketEvents(): this
Start monitoring for events in the connection socket used by this handle.

This is only useful if using the onSocketEvent callback.

This method will throw an Error if the handle is already monitoring socket events. You can use isMonitoringSockets to check if socket events are already being monitored or not.

Returns this
- Defined in lib/Easy.ts:687

onSocketEvent

onSocketEvent(
cb: null | ((error: null | Error, events: SocketState) => void),
): this
This method is only useful when the internal polling of the connection socket is enabled by calling monitorSocketEvents.

The passed callback is going to be called everytime there are changes to the connection socket.

One use case for this is when using the send and recv methods

A full example is available at examples/15-send-recv-methods.js

Pass null to remove the current callback set.
Parameters
- cb: null | ((error: null | Error, events: SocketState) => void)
Returns this
- Defined in lib/Easy.ts:675

pause

pause(bitmask: CurlPause): CurlCode
Using this function, you can explicitly mark a running connection to get paused, and you can unpause a connection that was previously paused.

Use the CurlPause enum for predefined constants.

Official libcurl documentation: curl_easy_pause()
Parameters
- bitmask: CurlPause
Returns CurlCode
- Defined in lib/Easy.ts:645

perform

perform(): CurlCode
Performs the entire request in a blocking manner and returns when done.

Official libcurl documentation: curl_easy_perform()

Returns CurlCode
- Defined in lib/Easy.ts:628

recv

recv(storage: Buffer): { bytesReceived: number; code: CurlCode }
Receives data over the established connection, data will be written to the passed buffer.

See also onSocketEvent.

Official libcurl documentation: curl_easy_recv()
Parameters
- storage: Buffer
Returns { bytesReceived: number; code: CurlCode }
- Defined in lib/Easy.ts:560

reset

reset(): CurlCode
Reset this handle to their original state.

This method is useful if you plan to reuse this handle later on.

Official libcurl documentation: curl_easy_reset()

Returns CurlCode
- Defined in lib/Easy.ts:654

send

send(data: Buffer): { bytesSent: number; code: CurlCode }
Sends arbitrary data over the established connection.

See also onSocketEvent.

Official libcurl documentation: curl_easy_send()
Parameters
- data: Buffer
Returns { bytesSent: number; code: CurlCode }
- Defined in lib/Easy.ts:551

setMimePost

setMimePost(parts: CurlyMimePart[]): this
Build and set a MIME structure from a declarative configuration.

This is a high-level method that accepts an array of MIME part specifications and internally builds a CurlMime structure, then sets it using the MIMEPOST option. This is the recommended way to create multipart form data.

For stream-based parts, the unpause callback is automatically generated, so you don't need to provide it.

Available since libcurl 7.56.0.
Parameters
- parts: CurlyMimePart[]
  Array of MIME part specifications
Returns this
This Easy instance for method chaining
- Defined in lib/Easy.ts:712

setOpt

setOpt(
    option: DataCallbackOptions,
    value:
        | null
        | ((this: Easy, data: Buffer, size: number, nmemb: number) => number),
): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: DataCallbackOptions
- value: null | ((this: Easy, data: Buffer, size: number, nmemb: number) => number)
Returns CurlCode
- Defined in lib/Easy.ts:156
setOpt(
    option: ProgressCallbackOptions,
    value:
        | null
        | (
            (
                this: Easy,
                dltotal: number,
                dlnow: number,
                ultotal: number,
                ulnow: number,
            ) => number
        ),
): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: ProgressCallbackOptions
- value:
      | null
      | (
          (
              this: Easy,
              dltotal: number,
              dlnow: number,
              ultotal: number,
              ulnow: number,
          ) => number
      )
Returns CurlCode
- Defined in lib/Easy.ts:168
setOpt(option: StringListOptions, value: null | string[]): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: StringListOptions
- value: null | string[]
Returns CurlCode
- Defined in lib/Easy.ts:186
setOpt(
option: BlobOptions,
value: null | string | ArrayBuffer | Buffer<ArrayBufferLike>,
): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: BlobOptions
- value: null | string | ArrayBuffer | Buffer<ArrayBufferLike>
Returns CurlCode
- Defined in lib/Easy.ts:193
setOpt(
    option: "CHUNK_BGN_FUNCTION",
    value:
        | null
        | ((this: Easy, fileInfo: FileInfo, remains: number) => CurlChunk),
): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "CHUNK_BGN_FUNCTION"
- value: null | ((this: Easy, fileInfo: FileInfo, remains: number) => CurlChunk)
Returns CurlCode
- Defined in lib/Easy.ts:203
setOpt(
option: "CHUNK_END_FUNCTION",
value: null | ((this: Easy) => CurlChunk),
): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "CHUNK_END_FUNCTION"
- value: null | ((this: Easy) => CurlChunk)
Returns CurlCode
- Defined in lib/Easy.ts:215
setOpt(
option: "DEBUGFUNCTION",
value: null | ((this: Easy, type: CurlInfoDebug, data: Buffer) => 0),
): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "DEBUGFUNCTION"
- value: null | ((this: Easy, type: CurlInfoDebug, data: Buffer) => 0)
Returns CurlCode
- Defined in lib/Easy.ts:225
setOpt(
    option: "FNMATCH_FUNCTION",
    value:
        | null
        | ((this: Easy, pattern: string, value: string) => CurlFnMatchFunc),
): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "FNMATCH_FUNCTION"
- value: null | ((this: Easy, pattern: string, value: string) => CurlFnMatchFunc)
Returns CurlCode
- Defined in lib/Easy.ts:235
setOpt(
    option: "HSTSREADFUNCTION",
    value:
        | null
        | (
            (
                this: Easy,
                options: { maxHostLengthBytes: number },
            ) => null | CurlHstsCacheEntry | CurlHstsCacheEntry[]
        ),
): CurlCode
Use Curl.option for predefined constants.

You can either return a single CurlHstsReadCallbackResult object or an array of CurlHstsReadCallbackResult objects. If returning an array, the callback will only be called once per request. If returning a single object, the callback will be called multiple times until null is returned.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "HSTSREADFUNCTION"
- value:
      | null
      | (
          (
              this: Easy,
              options: { maxHostLengthBytes: number },
          ) => null | CurlHstsCacheEntry | CurlHstsCacheEntry[]
      )
Returns CurlCode
- Defined in lib/Easy.ts:251
setOpt(
    option: "HSTSWRITEFUNCTION",
    value:
        | null
        | (
            (
                this: Easy,
                cacheEntry: CurlHstsCacheEntry,
                cacheCount: CurlHstsCacheCount,
            ) => any
        ),
): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "HSTSWRITEFUNCTION"
- value:
      | null
      | (
          (
              this: Easy,
              cacheEntry: CurlHstsCacheEntry,
              cacheCount: CurlHstsCacheCount,
          ) => any
      )
Returns CurlCode
- Defined in lib/Easy.ts:266
setOpt(
    option: "INTERLEAVEFUNCTION",
    value:
        | null
        | ((this: Easy, data: Buffer, size: number, nmemb: number) => number),
): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "INTERLEAVEFUNCTION"
- value: null | ((this: Easy, data: Buffer, size: number, nmemb: number) => number)
Returns CurlCode
- Defined in lib/Easy.ts:282
setOpt(
    option: "PREREQFUNCTION",
    value:
        | null
        | (
            (
                this: Easy,
                connPrimaryIp: string,
                connLocalIp: string,
                connPrimaryPort: number,
                conLocalPort: number,
            ) => CurlPreReqFunc
        ),
): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "PREREQFUNCTION"
- value:
      | null
      | (
          (
              this: Easy,
              connPrimaryIp: string,
              connLocalIp: string,
              connPrimaryPort: number,
              conLocalPort: number,
          ) => CurlPreReqFunc
      )
Returns CurlCode
- Defined in lib/Easy.ts:294
setOpt(
option: "SEEKFUNCTION",
value: null | ((this: Easy, offset: number, origin: number) => number),
): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "SEEKFUNCTION"
- value: null | ((this: Easy, offset: number, origin: number) => number)
Returns CurlCode
- Defined in lib/Easy.ts:312
setOpt(
    option: "SSH_HOSTKEYFUNCTION",
    value:
        | null
        | ((this: Easy, keytype: CurlSshKeyType, key: Buffer) => CurlSshKeyMatch),
): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "SSH_HOSTKEYFUNCTION"
- value: null | ((this: Easy, keytype: CurlSshKeyType, key: Buffer) => CurlSshKeyMatch)
Returns CurlCode
- Defined in lib/Easy.ts:322
setOpt(
option: "TRAILERFUNCTION",
value: null | ((this: Easy) => false | string[]),
): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "TRAILERFUNCTION"
- value: null | ((this: Easy) => false | string[])
Returns CurlCode
- Defined in lib/Easy.ts:334
setOpt(option: "SHARE", value: null | Share): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "SHARE"
- value: null | Share
Returns CurlCode
- Defined in lib/Easy.ts:344
setOpt(option: "HTTPPOST", value: null | HttpPostField[]): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "HTTPPOST"
- value: null | HttpPostField[]
Returns CurlCode
- Defined in lib/Easy.ts:351
setOpt(option: "STREAM_DEPENDS", value: null | Easy): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "STREAM_DEPENDS"
- value: null | Easy
Returns CurlCode
- Defined in lib/Easy.ts:358
setOpt(option: "STREAM_DEPENDS_E", value: null | Easy): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "STREAM_DEPENDS_E"
- value: null | Easy
Returns CurlCode
- Defined in lib/Easy.ts:365
setOpt(option: "FTP_SSL_CCC", value: null | CurlFtpSsl): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "FTP_SSL_CCC"
- value: null | CurlFtpSsl
Returns CurlCode
- Defined in lib/Easy.ts:372
setOpt(option: "FTP_FILEMETHOD", value: null | CurlFtpMethod): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "FTP_FILEMETHOD"
- value: null | CurlFtpMethod
Returns CurlCode
- Defined in lib/Easy.ts:379
setOpt(option: "GSSAPI_DELEGATION", value: null | CurlGssApi): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "GSSAPI_DELEGATION"
- value: null | CurlGssApi
Returns CurlCode
- Defined in lib/Easy.ts:386
setOpt(option: "HEADEROPT", value: null | CurlHeader): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "HEADEROPT"
- value: null | CurlHeader
Returns CurlCode
- Defined in lib/Easy.ts:393
setOpt(option: "HTTP_VERSION", value: null | CurlHttpVersion): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "HTTP_VERSION"
- value: null | CurlHttpVersion
Returns CurlCode
- Defined in lib/Easy.ts:400
setOpt(option: "IPRESOLVE", value: null | CurlIpResolve): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "IPRESOLVE"
- value: null | CurlIpResolve
Returns CurlCode
- Defined in lib/Easy.ts:407
setOpt(option: "MIMEPOST", value: null | CurlMime): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "MIMEPOST"
- value: null | CurlMime
Returns CurlCode
- Defined in lib/Easy.ts:414
setOpt(option: "MIME_OPTIONS", value: null | FormEscape): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "MIME_OPTIONS"
- value: null | FormEscape
Returns CurlCode
- Defined in lib/Easy.ts:421
setOpt(option: "NETRC", value: null | CurlNetrc): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "NETRC"
- value: null | CurlNetrc
Returns CurlCode
- Defined in lib/Easy.ts:428
setOpt(option: "PROTOCOLS", value: null | CurlProtocol): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "PROTOCOLS"
- value: null | CurlProtocol
Returns CurlCode
- Defined in lib/Easy.ts:435
setOpt(option: "PROXY_SSL_OPTIONS", value: null | CurlSslOpt): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "PROXY_SSL_OPTIONS"
- value: null | CurlSslOpt
Returns CurlCode
- Defined in lib/Easy.ts:442
setOpt(option: "PROXYTYPE", value: null | CurlProxy): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "PROXYTYPE"
- value: null | CurlProxy
Returns CurlCode
- Defined in lib/Easy.ts:449
setOpt(option: "REDIR_PROTOCOLS", value: null | CurlProtocol): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "REDIR_PROTOCOLS"
- value: null | CurlProtocol
Returns CurlCode
- Defined in lib/Easy.ts:456
setOpt(option: "RTSP_REQUEST", value: null | CurlRtspRequest): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "RTSP_REQUEST"
- value: null | CurlRtspRequest
Returns CurlCode
- Defined in lib/Easy.ts:463
setOpt(option: "SSH_AUTH_TYPES", value: null | CurlSshAuth): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "SSH_AUTH_TYPES"
- value: null | CurlSshAuth
Returns CurlCode
- Defined in lib/Easy.ts:470
setOpt(option: "SSL_OPTIONS", value: null | CurlSslOpt): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "SSL_OPTIONS"
- value: null | CurlSslOpt
Returns CurlCode
- Defined in lib/Easy.ts:477
setOpt(option: "SSLVERSION", value: null | CurlSslVersion): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "SSLVERSION"
- value: null | CurlSslVersion
Returns CurlCode
- Defined in lib/Easy.ts:484
setOpt(option: "TIMECONDITION", value: null | CurlTimeCond): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "TIMECONDITION"
- value: null | CurlTimeCond
Returns CurlCode
- Defined in lib/Easy.ts:491
setOpt(option: "USE_SSL", value: null | CurlUseSsl): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "USE_SSL"
- value: null | CurlUseSsl
Returns CurlCode
- Defined in lib/Easy.ts:498
setOpt(option: "WS_OPTIONS", value: null | CurlWsOptions): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "WS_OPTIONS"
- value: null | CurlWsOptions
Returns CurlCode
- Defined in lib/Easy.ts:505
setOpt(option: "HSTS_CTRL", value: null | CurlHsts): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option: "HSTS_CTRL"
- value: null | CurlHsts
Returns CurlCode
- Defined in lib/Easy.ts:512
setOpt(
    option:
        | "CAINFO"
        | "CAPATH"
        | "CERTINFO"
        | "COOKIELIST"
        | "FILETIME"
        | "REFERER"
        | "RTSP_CLIENT_CSEQ"
        | "RTSP_SERVER_CSEQ"
        | "RTSP_SESSION_ID"
        | "MAXCONNECTS"
        | "URL"
        | "ABSTRACT_UNIX_SOCKET"
        | "ACCEPT_ENCODING"
        | "ACCEPTTIMEOUT_MS"
        | "ADDRESS_SCOPE"
        | "ALTSVC"
        | "ALTSVC_CTRL"
        | "APPEND"
        | "AUTOREFERER"
        | "AWS_SIGV4"
        | "BUFFERSIZE"
        | "CA_CACHE_TIMEOUT"
        | "CONNECT_ONLY"
        | "CONNECTTIMEOUT"
        | "CONNECTTIMEOUT_MS"
        | "COOKIE"
        | "COOKIEFILE"
        | "COOKIEJAR"
        | "COOKIESESSION"
        | "CRLF"
        | "CRLFILE"
        | "CUSTOMREQUEST"
        | "DEFAULT_PROTOCOL"
        | "DIRLISTONLY"
        | "DISALLOW_USERNAME_IN_URL"
        | "DNS_CACHE_TIMEOUT"
        | "DNS_INTERFACE"
        | "DNS_LOCAL_IP4"
        | "DNS_LOCAL_IP6"
        | "DNS_SERVERS"
        | "DNS_SHUFFLE_ADDRESSES"
        | "DNS_USE_GLOBAL_CACHE"
        | "DOH_SSL_VERIFYHOST"
        | "DOH_SSL_VERIFYPEER"
        | "DOH_SSL_VERIFYSTATUS"
        | "DOH_URL"
        | "ECH"
        | "EGDSOCKET"
        | "EXPECT_100_TIMEOUT_MS"
        | "FAILONERROR"
        | "FOLLOWLOCATION"
        | "FORBID_REUSE"
        | "FRESH_CONNECT"
        | "FTP_ACCOUNT"
        | "FTP_ALTERNATIVE_TO_USER"
        | "FTP_CREATE_MISSING_DIRS"
        | "FTP_SKIP_PASV_IP"
        | "FTP_USE_EPRT"
        | "FTP_USE_EPSV"
        | "FTP_USE_PRET"
        | "FTPPORT"
        | "FTPSSLAUTH"
        | "HAPPY_EYEBALLS_TIMEOUT_MS"
        | "HAPROXY_CLIENT_IP"
        | "HAPROXYPROTOCOL"
        | "HEADER"
        | "HSTS"
        | "HTTP_CONTENT_DECODING"
        | "HTTP_TRANSFER_DECODING"
        | "HTTP09_ALLOWED"
        | "HTTPAUTH"
        | "HTTPGET"
        | "HTTPPROXYTUNNEL"
        | "IGNORE_CONTENT_LENGTH"
        | "INFILESIZE"
        | "INFILESIZE_LARGE"
        | "INTERFACE"
        | "ISSUERCERT"
        | "KEEP_SENDING_ON_ERROR"
        | "KEYPASSWD"
        | "KRBLEVEL"
        | "LOCALPORT"
        | "LOCALPORTRANGE"
        | "LOGIN_OPTIONS"
        | "LOW_SPEED_LIMIT"
        | "LOW_SPEED_TIME"
        | "MAIL_AUTH"
        | "MAIL_FROM"
        | "MAIL_RCPT_ALLOWFAILS"
        | "MAX_RECV_SPEED_LARGE"
        | "MAX_SEND_SPEED_LARGE"
        | "MAXAGE_CONN"
        | "MAXFILESIZE"
        | "MAXFILESIZE_LARGE"
        | "MAXLIFETIME_CONN"
        | "MAXREDIRS"
        | "NETRC_FILE"
        | "NEW_DIRECTORY_PERMS"
        | "NEW_FILE_PERMS"
        | "NOBODY"
        | "NOPROGRESS"
        | "NOPROXY"
        | "NOSIGNAL"
        | "PASSWORD"
        | "PATH_AS_IS"
        | "PINNEDPUBLICKEY"
        | "PIPEWAIT"
        | "PORT"
        | "POST"
        | "POSTFIELDS"
        | "POSTFIELDSIZE"
        | "POSTFIELDSIZE_LARGE"
        | "POSTREDIR"
        | "PRE_PROXY"
        | "PROTOCOLS_STR"
        | "PROXY"
        | "PROXY_CAINFO"
        | "PROXY_CAPATH"
        | "PROXY_CRLFILE"
        | "PROXY_ISSUERCERT"
        | "PROXY_ISSUERCERT_BLOB"
        | "PROXY_KEYPASSWD"
        | "PROXY_PINNEDPUBLICKEY"
        | "PROXY_SERVICE_NAME"
        | "PROXY_SSL_CIPHER_LIST"
        | "PROXY_SSL_VERIFYHOST"
        | "PROXY_SSL_VERIFYPEER"
        | "PROXY_SSLCERTTYPE"
        | "PROXY_SSLKEY"
        | "PROXY_SSLKEYTYPE"
        | "PROXY_SSLVERSION"
        | "PROXY_TLS13_CIPHERS"
        | "PROXY_TLSAUTH_PASSWORD"
        | "PROXY_TLSAUTH_TYPE"
        | "PROXY_TLSAUTH_USERNAME"
        | "PROXY_TRANSFER_MODE"
        | "PROXYAUTH"
        | "PROXYPASSWORD"
        | "PROXYPORT"
        | "PROXYUSERNAME"
        | "PROXYUSERPWD"
        | "PUT"
        | "QUICK_EXIT"
        | "RANDOM_FILE"
        | "RANGE"
        | "READDATA"
        | "REDIR_PROTOCOLS_STR"
        | "REQUEST_TARGET"
        | "RESUME_FROM"
        | "RESUME_FROM_LARGE"
        | "RTSP_STREAM_URI"
        | "RTSP_TRANSPORT"
        | "SASL_AUTHZID"
        | "SASL_IR"
        | "SERVER_RESPONSE_TIMEOUT"
        | "SERVER_RESPONSE_TIMEOUT_MS"
        | "SERVICE_NAME"
        | "SOCKS5_AUTH"
        | "SOCKS5_GSSAPI_NEC"
        | "SOCKS5_GSSAPI_SERVICE"
        | "SSH_COMPRESSION"
        | "SSH_HOST_PUBLIC_KEY_MD5"
        | "SSH_HOST_PUBLIC_KEY_SHA256"
        | "SSH_KNOWNHOSTS"
        | "SSH_PRIVATE_KEYFILE"
        | "SSH_PUBLIC_KEYFILE"
        | "SSL_CIPHER_LIST"
        | "SSL_EC_CURVES"
        | "SSL_ENABLE_ALPN"
        | "SSL_ENABLE_NPN"
        | "SSL_FALSESTART"
        | "SSL_SESSIONID_CACHE"
        | "SSL_SIGNATURE_ALGORITHMS"
        | "SSL_VERIFYHOST"
        | "SSL_VERIFYPEER"
        | "SSL_VERIFYSTATUS"
        | "SSLCERT"
        | "SSLCERTTYPE"
        | "SSLENGINE"
        | "SSLENGINE_DEFAULT"
        | "SSLKEY"
        | "SSLKEYTYPE"
        | "STREAM_WEIGHT"
        | "SUPPRESS_CONNECT_HEADERS"
        | "TCP_FASTOPEN"
        | "TCP_KEEPALIVE"
        | "TCP_KEEPCNT"
        | "TCP_KEEPIDLE"
        | "TCP_KEEPINTVL"
        | "TCP_NODELAY"
        | "TFTP_BLKSIZE"
        | "TFTP_NO_OPTIONS"
        | "TIMEOUT"
        | "TIMEOUT_MS"
        | "TIMEVALUE"
        | "TIMEVALUE_LARGE"
        | "TLS13_CIPHERS"
        | "TLSAUTH_PASSWORD"
        | "TLSAUTH_TYPE"
        | "TLSAUTH_USERNAME"
        | "TRANSFER_ENCODING"
        | "TRANSFERTEXT"
        | "UNIX_SOCKET_PATH"
        | "UNRESTRICTED_AUTH"
        | "UPKEEP_INTERVAL_MS"
        | "UPLOAD"
        | "UPLOAD_BUFFERSIZE"
        | "UPLOAD_FLAGS"
        | "USERAGENT"
        | "USERNAME"
        | "USERPWD"
        | "VERBOSE"
        | "WILDCARDMATCH"
        | "XOAUTH2_BEARER",
    value: null | string | number | boolean,
): CurlCode
Use Curl.option for predefined constants.

Official libcurl documentation: curl_easy_setopt()
Parameters
- option:
      | "CAINFO"
      | "CAPATH"
      | "CERTINFO"
      | "COOKIELIST"
      | "FILETIME"
      | "REFERER"
      | "RTSP_CLIENT_CSEQ"
      | "RTSP_SERVER_CSEQ"
      | "RTSP_SESSION_ID"
      | "MAXCONNECTS"
      | "URL"
      | "ABSTRACT_UNIX_SOCKET"
      | "ACCEPT_ENCODING"
      | "ACCEPTTIMEOUT_MS"
      | "ADDRESS_SCOPE"
      | "ALTSVC"
      | "ALTSVC_CTRL"
      | "APPEND"
      | "AUTOREFERER"
      | "AWS_SIGV4"
      | "BUFFERSIZE"
      | "CA_CACHE_TIMEOUT"
      | "CONNECT_ONLY"
      | "CONNECTTIMEOUT"
      | "CONNECTTIMEOUT_MS"
      | "COOKIE"
      | "COOKIEFILE"
      | "COOKIEJAR"
      | "COOKIESESSION"
      | "CRLF"
      | "CRLFILE"
      | "CUSTOMREQUEST"
      | "DEFAULT_PROTOCOL"
      | "DIRLISTONLY"
      | "DISALLOW_USERNAME_IN_URL"
      | "DNS_CACHE_TIMEOUT"
      | "DNS_INTERFACE"
      | "DNS_LOCAL_IP4"
      | "DNS_LOCAL_IP6"
      | "DNS_SERVERS"
      | "DNS_SHUFFLE_ADDRESSES"
      | "DNS_USE_GLOBAL_CACHE"
      | "DOH_SSL_VERIFYHOST"
      | "DOH_SSL_VERIFYPEER"
      | "DOH_SSL_VERIFYSTATUS"
      | "DOH_URL"
      | "ECH"
      | "EGDSOCKET"
      | "EXPECT_100_TIMEOUT_MS"
      | "FAILONERROR"
      | "FOLLOWLOCATION"
      | "FORBID_REUSE"
      | "FRESH_CONNECT"
      | "FTP_ACCOUNT"
      | "FTP_ALTERNATIVE_TO_USER"
      | "FTP_CREATE_MISSING_DIRS"
      | "FTP_SKIP_PASV_IP"
      | "FTP_USE_EPRT"
      | "FTP_USE_EPSV"
      | "FTP_USE_PRET"
      | "FTPPORT"
      | "FTPSSLAUTH"
      | "HAPPY_EYEBALLS_TIMEOUT_MS"
      | "HAPROXY_CLIENT_IP"
      | "HAPROXYPROTOCOL"
      | "HEADER"
      | "HSTS"
      | "HTTP_CONTENT_DECODING"
      | "HTTP_TRANSFER_DECODING"
      | "HTTP09_ALLOWED"
      | "HTTPAUTH"
      | "HTTPGET"
      | "HTTPPROXYTUNNEL"
      | "IGNORE_CONTENT_LENGTH"
      | "INFILESIZE"
      | "INFILESIZE_LARGE"
      | "INTERFACE"
      | "ISSUERCERT"
      | "KEEP_SENDING_ON_ERROR"
      | "KEYPASSWD"
      | "KRBLEVEL"
      | "LOCALPORT"
      | "LOCALPORTRANGE"
      | "LOGIN_OPTIONS"
      | "LOW_SPEED_LIMIT"
      | "LOW_SPEED_TIME"
      | "MAIL_AUTH"
      | "MAIL_FROM"
      | "MAIL_RCPT_ALLOWFAILS"
      | "MAX_RECV_SPEED_LARGE"
      | "MAX_SEND_SPEED_LARGE"
      | "MAXAGE_CONN"
      | "MAXFILESIZE"
      | "MAXFILESIZE_LARGE"
      | "MAXLIFETIME_CONN"
      | "MAXREDIRS"
      | "NETRC_FILE"
      | "NEW_DIRECTORY_PERMS"
      | "NEW_FILE_PERMS"
      | "NOBODY"
      | "NOPROGRESS"
      | "NOPROXY"
      | "NOSIGNAL"
      | "PASSWORD"
      | "PATH_AS_IS"
      | "PINNEDPUBLICKEY"
      | "PIPEWAIT"
      | "PORT"
      | "POST"
      | "POSTFIELDS"
      | "POSTFIELDSIZE"
      | "POSTFIELDSIZE_LARGE"
      | "POSTREDIR"
      | "PRE_PROXY"
      | "PROTOCOLS_STR"
      | "PROXY"
      | "PROXY_CAINFO"
      | "PROXY_CAPATH"
      | "PROXY_CRLFILE"
      | "PROXY_ISSUERCERT"
      | "PROXY_ISSUERCERT_BLOB"
      | "PROXY_KEYPASSWD"
      | "PROXY_PINNEDPUBLICKEY"
      | "PROXY_SERVICE_NAME"
      | "PROXY_SSL_CIPHER_LIST"
      | "PROXY_SSL_VERIFYHOST"
      | "PROXY_SSL_VERIFYPEER"
      | "PROXY_SSLCERTTYPE"
      | "PROXY_SSLKEY"
      | "PROXY_SSLKEYTYPE"
      | "PROXY_SSLVERSION"
      | "PROXY_TLS13_CIPHERS"
      | "PROXY_TLSAUTH_PASSWORD"
      | "PROXY_TLSAUTH_TYPE"
      | "PROXY_TLSAUTH_USERNAME"
      | "PROXY_TRANSFER_MODE"
      | "PROXYAUTH"
      | "PROXYPASSWORD"
      | "PROXYPORT"
      | "PROXYUSERNAME"
      | "PROXYUSERPWD"
      | "PUT"
      | "QUICK_EXIT"
      | "RANDOM_FILE"
      | "RANGE"
      | "READDATA"
      | "REDIR_PROTOCOLS_STR"
      | "REQUEST_TARGET"
      | "RESUME_FROM"
      | "RESUME_FROM_LARGE"
      | "RTSP_STREAM_URI"
      | "RTSP_TRANSPORT"
      | "SASL_AUTHZID"
      | "SASL_IR"
      | "SERVER_RESPONSE_TIMEOUT"
      | "SERVER_RESPONSE_TIMEOUT_MS"
      | "SERVICE_NAME"
      | "SOCKS5_AUTH"
      | "SOCKS5_GSSAPI_NEC"
      | "SOCKS5_GSSAPI_SERVICE"
      | "SSH_COMPRESSION"
      | "SSH_HOST_PUBLIC_KEY_MD5"
      | "SSH_HOST_PUBLIC_KEY_SHA256"
      | "SSH_KNOWNHOSTS"
      | "SSH_PRIVATE_KEYFILE"
      | "SSH_PUBLIC_KEYFILE"
      | "SSL_CIPHER_LIST"
      | "SSL_EC_CURVES"
      | "SSL_ENABLE_ALPN"
      | "SSL_ENABLE_NPN"
      | "SSL_FALSESTART"
      | "SSL_SESSIONID_CACHE"
      | "SSL_SIGNATURE_ALGORITHMS"
      | "SSL_VERIFYHOST"
      | "SSL_VERIFYPEER"
      | "SSL_VERIFYSTATUS"
      | "SSLCERT"
      | "SSLCERTTYPE"
      | "SSLENGINE"
      | "SSLENGINE_DEFAULT"
      | "SSLKEY"
      | "SSLKEYTYPE"
      | "STREAM_WEIGHT"
      | "SUPPRESS_CONNECT_HEADERS"
      | "TCP_FASTOPEN"
      | "TCP_KEEPALIVE"
      | "TCP_KEEPCNT"
      | "TCP_KEEPIDLE"
      | "TCP_KEEPINTVL"
      | "TCP_NODELAY"
      | "TFTP_BLKSIZE"
      | "TFTP_NO_OPTIONS"
      | "TIMEOUT"
      | "TIMEOUT_MS"
      | "TIMEVALUE"
      | "TIMEVALUE_LARGE"
      | "TLS13_CIPHERS"
      | "TLSAUTH_PASSWORD"
      | "TLSAUTH_TYPE"
      | "TLSAUTH_USERNAME"
      | "TRANSFER_ENCODING"
      | "TRANSFERTEXT"
      | "UNIX_SOCKET_PATH"
      | "UNRESTRICTED_AUTH"
      | "UPKEEP_INTERVAL_MS"
      | "UPLOAD"
      | "UPLOAD_BUFFERSIZE"
      | "UPLOAD_FLAGS"
      | "USERAGENT"
      | "USERNAME"
      | "USERPWD"
      | "VERBOSE"
      | "WILDCARDMATCH"
      | "XOAUTH2_BEARER"
- value: null | string | number | boolean
Returns CurlCode
- Defined in lib/Easy.ts:519

unmonitorSocketEvents

unmonitorSocketEvents(): this
Stop monitoring for events in the connection socket used by this handle.

This method will throw an Error if the handle is not monitoring socket events. You can use isMonitoringSockets to check if socket events are already being monitored or not.

Returns this
- Defined in lib/Easy.ts:695

upkeep

upkeep(): CurlCode
Perform any connection upkeep checks.

Official libcurl documentation: curl_easy_upkeep()

Returns CurlCode
- Defined in lib/Easy.ts:635

wsMeta

wsMeta(): null | CurlWsFrame
Get WebSocket frame metadata when called from within a WRITEFUNCTION callback.

This function provides additional information about the current WebSocket frame being received. It only works from within the callback, and only when receiving WebSocket data.

Requires libcurl >= 7.86.0

Official libcurl documentation: curl_ws_meta()

Returns null | CurlWsFrame
Frame metadata or null if not available
- Defined in lib/Easy.ts:612

wsRecv

wsRecv(
buffer: Buffer,
): { bytesReceived: number; code: CurlCode; meta: null | CurlWsFrame }
Receive WebSocket data when using CONNECT_ONLY mode.

Retrieves as much as possible of a received WebSocket frame into the buffer, but not more than buflen bytes. Check meta.bytesleft to determine whether the complete frame has been received. If more payload is pending, call this function again with an updated buffer to resume receiving.

Requires libcurl >= 7.86.0

Official libcurl documentation: curl_ws_recv()
Parameters
- buffer: Buffer
Returns { bytesReceived: number; code: CurlCode; meta: null | CurlWsFrame }
- Defined in lib/Easy.ts:573

wsSend

wsSend(
    buffer: Buffer,
    flags: number,
    fragsize?: number,
): { bytesSent: number; code: CurlCode }
Send WebSocket data when using CONNECT_ONLY mode.

Sends a specific message chunk over an established WebSocket connection. flags must contain at least one flag indicating the type of the message (Text, Binary, Close, Ping, Pong). For fragmented messages, set the Cont bit in all frames except the final one.

Requires libcurl >= 7.86.0

Official libcurl documentation: curl_ws_send()
Parameters
- buffer: Buffer
  The data to send
- flags: number
  Frame type and flags from CurlWs
- Optionalfragsize: number
  Optional fragment size, only used with CURLWS_OFFSET flag
Returns { bytesSent: number; code: CurlCode }
- Defined in lib/Easy.ts:594

wsStartFrame

wsStartFrame(flags: number, frameLength: number): CurlCode
Start a new WebSocket frame.

This should only be called from within a READFUNCTION callback. Calling it from anywhere else is undefined behavior.

Official libcurl documentation: curl_ws_start_frame()
Parameters
- flags: number
- frameLength: number
Returns CurlCode
- Defined in lib/Easy.ts:621

`Static`strError

strError(errorCode: CurlCode): string
Returns a description for the given error code.

Official libcurl documentation: curl_easy_strerror()
Parameters
- errorCode: CurlCode
Returns string
- Defined in lib/Easy.ts:730

Class Easy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Easy

Properties

Readonlyid

ReadonlyisInsideMultiHandle

ReadonlyisMonitoringSockets

ReadonlyisOpen

ReadonlyisPausedRecv

ReadonlyisPausedSend

ReadonlypauseFlags

private

Methods

close

Returns void

dupHandle

Returns Easy

getInfo

Parameters

Returns GetInfoReturn<string[]>

Parameters

Returns GetInfoReturn

monitorSocketEvents

Returns this

onSocketEvent

Parameters

Returns this

pause

Parameters

Returns CurlCode

perform

Returns CurlCode

recv

Parameters

Returns { bytesReceived: number; code: CurlCode }

reset

Returns CurlCode

send

Parameters

Returns { bytesSent: number; code: CurlCode }

setMimePost

Parameters

Returns this

setOpt

Parameters

Returns CurlCode

Parameters

Returns CurlCode

Parameters

Returns CurlCode

Parameters

Returns CurlCode

Parameters

Returns CurlCode

Parameters

Returns CurlCode

Parameters

Returns CurlCode

Parameters

Returns CurlCode

Parameters

Returns CurlCode

Parameters

Returns CurlCode

Parameters

Returns CurlCode

Parameters

Returns CurlCode

Parameters

Returns CurlCode

Parameters

Returns CurlCode

Parameters

Returns CurlCode

Parameters

`Readonly`id

`Readonly`isInsideMultiHandle

`Readonly`isMonitoringSockets

`Readonly`isOpen

`Readonly`isPausedRecv

`Readonly`isPausedSend

`Readonly`pauseFlags

`Static`strError