Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CurlyOptions

These are the options accepted by the CurlyFunction API.

Most libcurl options are accepted as their specific name, like PROXY_CAPATH, or as a camel case version of that name, like proxyCaPath.

Options specific to the curly API are prefixed with curly, like curlyBaseUrl.

For quick navigation use the sidebar.

Hierarchy

  • { ABSTRACT_UNIX_SOCKET?: string | number | boolean | null; ACCEPTTIMEOUT_MS?: string | number | boolean | null; ACCEPT_ENCODING?: string | number | boolean | null; ADDRESS_SCOPE?: string | number | boolean | null; ALTSVC?: string | number | boolean | null; ALTSVC_CTRL?: string | number | boolean | null; APPEND?: string | number | boolean | null; AUTOREFERER?: string | number | boolean | null; AWS_SIGV4?: string | number | boolean | null; BUFFERSIZE?: string | number | boolean | null; CAINFO?: string | number | boolean | null; CAINFO_BLOB?: ArrayBuffer | Buffer | string | null; CAPATH?: string | number | boolean | null; CERTINFO?: string | number | boolean | null; CHUNK_BGN_FUNCTION?: ((this: EasyNativeBinding, fileInfo: FileInfo, remains: number) => CurlChunk) | null; CHUNK_END_FUNCTION?: ((this: EasyNativeBinding) => CurlChunk) | null; CONNECTTIMEOUT?: string | number | boolean | null; CONNECTTIMEOUT_MS?: string | number | boolean | null; CONNECT_ONLY?: string | number | boolean | null; CONNECT_TO?: string[] | null; COOKIE?: string | number | boolean | null; COOKIEFILE?: string | number | boolean | null; COOKIEJAR?: string | number | boolean | null; COOKIELIST?: string | number | boolean | null; COOKIESESSION?: string | number | boolean | null; CRLF?: string | number | boolean | null; CRLFILE?: string | number | boolean | null; CUSTOMREQUEST?: string | number | boolean | null; DEBUGFUNCTION?: ((this: EasyNativeBinding, type: CurlInfoDebug, data: Buffer) => 0) | null; DEFAULT_PROTOCOL?: string | number | boolean | null; DIRLISTONLY?: string | number | boolean | null; DISALLOW_USERNAME_IN_URL?: string | number | boolean | null; DNS_CACHE_TIMEOUT?: string | number | boolean | null; DNS_INTERFACE?: string | number | boolean | null; DNS_LOCAL_IP4?: string | number | boolean | null; DNS_LOCAL_IP6?: string | number | boolean | null; DNS_SERVERS?: string | number | boolean | null; DNS_SHUFFLE_ADDRESSES?: string | number | boolean | null; DNS_USE_GLOBAL_CACHE?: string | number | boolean | null; DOH_SSL_VERIFYHOST?: string | number | boolean | null; DOH_SSL_VERIFYPEER?: string | number | boolean | null; DOH_SSL_VERIFYSTATUS?: string | number | boolean | null; DOH_URL?: string | number | boolean | null; EGDSOCKET?: string | number | boolean | null; EXPECT_100_TIMEOUT_MS?: string | number | boolean | null; FAILONERROR?: string | number | boolean | null; FILETIME?: string | number | boolean | null; FNMATCH_FUNCTION?: ((this: EasyNativeBinding, pattern: string, value: string) => CurlFnMatchFunc) | null; FOLLOWLOCATION?: string | number | boolean | null; FORBID_REUSE?: string | number | boolean | null; FRESH_CONNECT?: string | number | boolean | null; FTPPORT?: string | number | boolean | null; FTPSSLAUTH?: string | number | boolean | null; FTP_ACCOUNT?: string | number | boolean | null; FTP_ALTERNATIVE_TO_USER?: string | number | boolean | null; FTP_CREATE_MISSING_DIRS?: string | number | boolean | null; FTP_FILEMETHOD?: CurlFtpMethod | null; FTP_SKIP_PASV_IP?: string | number | boolean | null; FTP_SSL_CCC?: CurlFtpSsl | null; FTP_USE_EPRT?: string | number | boolean | null; FTP_USE_EPSV?: string | number | boolean | null; FTP_USE_PRET?: string | number | boolean | null; GSSAPI_DELEGATION?: CurlGssApi | null; HAPPY_EYEBALLS_TIMEOUT_MS?: string | number | boolean | null; HAPROXYPROTOCOL?: string | number | boolean | null; HEADER?: string | number | boolean | null; HEADERFUNCTION?: ((this: EasyNativeBinding, data: Buffer, size: number, nmemb: number) => number) | null; HEADEROPT?: CurlHeader | null; HSTS?: string | number | boolean | null; HSTSREADFUNCTION?: ((this: EasyNativeBinding) => null | CurlHstsCacheEntry | CurlHstsCacheEntry[]) | null; HSTSWRITEFUNCTION?: ((this: EasyNativeBinding, cacheEntry: CurlHstsCacheEntry, cacheCount: CurlHstsCacheCount) => any) | null; HSTS_CTRL?: CurlHsts | null; HTTP09_ALLOWED?: string | number | boolean | null; HTTP200ALIASES?: string[] | null; HTTPAUTH?: string | number | boolean | null; HTTPGET?: string | number | boolean | null; HTTPHEADER?: string[] | null; HTTPPOST?: HttpPostField[] | null; HTTPPROXYTUNNEL?: string | number | boolean | null; HTTP_CONTENT_DECODING?: string | number | boolean | null; HTTP_TRANSFER_DECODING?: string | number | boolean | null; HTTP_VERSION?: CurlHttpVersion | null; IGNORE_CONTENT_LENGTH?: string | number | boolean | null; INFILESIZE?: string | number | boolean | null; INFILESIZE_LARGE?: string | number | boolean | null; INTERFACE?: string | number | boolean | null; IPRESOLVE?: CurlIpResolve | null; ISSUERCERT?: string | number | boolean | null; ISSUERCERT_BLOB?: ArrayBuffer | Buffer | string | null; KEEP_SENDING_ON_ERROR?: string | number | boolean | null; KEYPASSWD?: string | number | boolean | null; KRBLEVEL?: string | number | boolean | null; LOCALPORT?: string | number | boolean | null; LOCALPORTRANGE?: string | number | boolean | null; LOGIN_OPTIONS?: string | number | boolean | null; LOW_SPEED_LIMIT?: string | number | boolean | null; LOW_SPEED_TIME?: string | number | boolean | null; MAIL_AUTH?: string | number | boolean | null; MAIL_FROM?: string | number | boolean | null; MAIL_RCPT?: string[] | null; MAIL_RCPT_ALLLOWFAILS?: string | number | boolean | null; MAXAGE_CONN?: string | number | boolean | null; MAXCONNECTS?: string | number | boolean | null; MAXFILESIZE?: string | number | boolean | null; MAXFILESIZE_LARGE?: string | number | boolean | null; MAXLIFETIME_CONN?: string | number | boolean | null; MAXREDIRS?: string | number | boolean | null; MAX_RECV_SPEED_LARGE?: string | number | boolean | null; MAX_SEND_SPEED_LARGE?: string | number | boolean | null; NETRC?: CurlNetrc | null; NETRC_FILE?: string | number | boolean | null; NEW_DIRECTORY_PERMS?: string | number | boolean | null; NEW_FILE_PERMS?: string | number | boolean | null; NOBODY?: string | number | boolean | null; NOPROGRESS?: string | number | boolean | null; NOPROXY?: string | number | boolean | null; NOSIGNAL?: string | number | boolean | null; PASSWORD?: string | number | boolean | null; PATH_AS_IS?: string | number | boolean | null; PINNEDPUBLICKEY?: string | number | boolean | null; PIPEWAIT?: string | number | boolean | null; PORT?: string | number | boolean | null; POST?: string | number | boolean | null; POSTFIELDS?: string | number | boolean | null; POSTFIELDSIZE?: string | number | boolean | null; POSTFIELDSIZE_LARGE?: string | number | boolean | null; POSTQUOTE?: string[] | null; POSTREDIR?: string | number | boolean | null; PREQUOTE?: string[] | null; PREREQFUNCTION?: ((this: EasyNativeBinding, connPrimaryIp: string, connLocalIp: string, connPrimaryPort: number, conLocalPort: number) => CurlPreReqFunc) | null; PRE_PROXY?: string | number | boolean | null; PROGRESSFUNCTION?: ((this: EasyNativeBinding, dltotal: number, dlnow: number, ultotal: number, ulnow: number) => number | CurlProgressFunc) | null; PROTOCOLS?: CurlProtocol | null; PROTOCOLS_STR?: string | number | boolean | null; PROXY?: string | number | boolean | null; PROXYAUTH?: string | number | boolean | null; PROXYHEADER?: string[] | null; PROXYPASSWORD?: string | number | boolean | null; PROXYPORT?: string | number | boolean | null; PROXYTYPE?: CurlProxy | null; PROXYUSERNAME?: string | number | boolean | null; PROXYUSERPWD?: string | number | boolean | null; PROXY_CAINFO?: string | number | boolean | null; PROXY_CAINFO_BLOB?: ArrayBuffer | Buffer | string | null; PROXY_CAPATH?: string | number | boolean | null; PROXY_CRLFILE?: string | number | boolean | null; PROXY_ISSUERCERT?: string | number | boolean | null; PROXY_ISSUERCERT_BLOB?: string | number | boolean | null; PROXY_KEYPASSWD?: string | number | boolean | null; PROXY_PINNEDPUBLICKEY?: string | number | boolean | null; PROXY_SERVICE_NAME?: string | number | boolean | null; PROXY_SSLCERT?: ArrayBuffer | Buffer | string | null; PROXY_SSLCERTTYPE?: string | number | boolean | null; PROXY_SSLCERT_BLOB?: ArrayBuffer | Buffer | string | null; PROXY_SSLKEY?: string | number | boolean | null; PROXY_SSLKEYTYPE?: string | number | boolean | null; PROXY_SSLKEY_BLOB?: ArrayBuffer | Buffer | string | null; PROXY_SSLVERSION?: string | number | boolean | null; PROXY_SSL_CIPHER_LIST?: string | number | boolean | null; PROXY_SSL_OPTIONS?: CurlSslOpt | null; PROXY_SSL_VERIFYHOST?: string | number | boolean | null; PROXY_SSL_VERIFYPEER?: string | number | boolean | null; PROXY_TLS13_CIPHERS?: string | number | boolean | null; PROXY_TLSAUTH_PASSWORD?: string | number | boolean | null; PROXY_TLSAUTH_TYPE?: string | number | boolean | null; PROXY_TLSAUTH_USERNAME?: string | number | boolean | null; PROXY_TRANSFER_MODE?: string | number | boolean | null; PUT?: string | number | boolean | null; QUOTE?: string[] | null; RANDOM_FILE?: string | number | boolean | null; RANGE?: string | number | boolean | null; READDATA?: string | number | boolean | null; READFUNCTION?: ((this: EasyNativeBinding, data: Buffer, size: number, nmemb: number) => number) | null; REDIR_PROTOCOLS?: CurlProtocol | null; REDIR_PROTOCOLS_STR?: string | number | boolean | null; REFERER?: string | number | boolean | null; REQUEST_TARGET?: string | number | boolean | null; RESOLVE?: string[] | null; RESUME_FROM?: string | number | boolean | null; RESUME_FROM_LARGE?: string | number | boolean | null; RTSP_CLIENT_CSEQ?: string | number | boolean | null; RTSP_REQUEST?: CurlRtspRequest | null; RTSP_SERVER_CSEQ?: string | number | boolean | null; RTSP_SESSION_ID?: string | number | boolean | null; RTSP_STREAM_URI?: string | number | boolean | null; RTSP_TRANSPORT?: string | number | boolean | null; SASL_AUTHZID?: string | number | boolean | null; SASL_IR?: string | number | boolean | null; SEEKFUNCTION?: ((this: EasyNativeBinding, offset: number, origin: number) => number) | null; SERVER_RESPONSE_TIMEOUT?: string | number | boolean | null; SERVICE_NAME?: string | number | boolean | null; SHARE?: Share | null; SOCKS5_AUTH?: string | number | boolean | null; SOCKS5_GSSAPI_NEC?: string | number | boolean | null; SOCKS5_GSSAPI_SERVICE?: string | number | boolean | null; SSH_AUTH_TYPES?: CurlSshAuth | null; SSH_COMPRESSION?: string | number | boolean | null; SSH_HOSTKEYDATA?: string | number | boolean | null; SSH_HOST_PUBLIC_KEY_MD5?: string | number | boolean | null; SSH_KNOWNHOSTS?: string | number | boolean | null; SSH_PRIVATE_KEYFILE?: string | number | boolean | null; SSH_PUBLIC_KEYFILE?: string | number | boolean | null; SSLCERT?: string | number | boolean | null; SSLCERTTYPE?: string | number | boolean | null; SSLCERT_BLOB?: ArrayBuffer | Buffer | string | null; SSLENGINE?: string | number | boolean | null; SSLENGINE_DEFAULT?: string | number | boolean | null; SSLKEY?: string | number | boolean | null; SSLKEYTYPE?: string | number | boolean | null; SSLKEY_BLOB?: ArrayBuffer | Buffer | string | null; SSLVERSION?: CurlSslVersion | null; SSL_CIPHER_LIST?: string | number | boolean | null; SSL_EC_CURVES?: string | number | boolean | null; SSL_ENABLE_ALPN?: string | number | boolean | null; SSL_ENABLE_NPN?: string | number | boolean | null; SSL_FALSESTART?: string | number | boolean | null; SSL_OPTIONS?: CurlSslOpt | null; SSL_SESSIONID_CACHE?: string | number | boolean | null; SSL_VERIFYHOST?: string | number | boolean | null; SSL_VERIFYPEER?: string | number | boolean | null; SSL_VERIFYSTATUS?: string | number | boolean | null; SUPPRESS_CONNECT_HEADERS?: string | number | boolean | null; TCP_FASTOPEN?: string | number | boolean | null; TCP_KEEPALIVE?: string | number | boolean | null; TCP_KEEPIDLE?: string | number | boolean | null; TCP_KEEPINTVL?: string | number | boolean | null; TCP_NODELAY?: string | number | boolean | null; TELNETOPTIONS?: string[] | null; TFTP_BLKSIZE?: string | number | boolean | null; TFTP_NO_OPTIONS?: string | number | boolean | null; TIMECONDITION?: CurlTimeCond | null; TIMEOUT?: string | number | boolean | null; TIMEOUT_MS?: string | number | boolean | null; TIMEVALUE?: string | number | boolean | null; TIMEVALUE_LARGE?: string | number | boolean | null; TLS13_CIPHERS?: string | number | boolean | null; TLSAUTH_PASSWORD?: string | number | boolean | null; TLSAUTH_TYPE?: string | number | boolean | null; TLSAUTH_USERNAME?: string | number | boolean | null; TRAILERFUNCTION?: ((this: EasyNativeBinding) => string[] | false) | null; TRANSFERTEXT?: string | number | boolean | null; TRANSFER_ENCODING?: string | number | boolean | null; UNIX_SOCKET_PATH?: string | number | boolean | null; UNRESTRICTED_AUTH?: string | number | boolean | null; UPKEEP_INTERVAL_MS?: string | number | boolean | null; UPLOAD?: string | number | boolean | null; UPLOAD_BUFFERSIZE?: string | number | boolean | null; URL?: string | number | boolean | null; USERAGENT?: string | number | boolean | null; USERNAME?: string | number | boolean | null; USERPWD?: string | number | boolean | null; USE_SSL?: CurlUseSsl | null; VERBOSE?: string | number | boolean | null; WILDCARDMATCH?: string | number | boolean | null; WRITEFUNCTION?: ((this: EasyNativeBinding, data: Buffer, size: number, nmemb: number) => number) | null; XFERINFOFUNCTION?: ((this: EasyNativeBinding, dltotal: number, dlnow: number, ultotal: number, ulnow: number) => number | CurlProgressFunc) | null; XOAUTH2_BEARER?: string | number | boolean | null; abstractUnixSocket?: string | number | boolean | null; acceptEncoding?: string | number | boolean | null; acceptTimeoutMs?: string | number | boolean | null; addressScope?: string | number | boolean | null; altSvc?: string | number | boolean | null; altSvcCtrl?: string | number | boolean | null; append?: string | number | boolean | null; autoReferer?: string | number | boolean | null; awsSigV4?: string | number | boolean | null; bufferSize?: string | number | boolean | null; caInfo?: string | number | boolean | null; caInfoBlob?: ArrayBuffer | Buffer | string | null; caPath?: string | number | boolean | null; certInfo?: string | number | boolean | null; chunkBgnFunction?: ((this: EasyNativeBinding, fileInfo: FileInfo, remains: number) => CurlChunk) | null; chunkEndFunction?: ((this: EasyNativeBinding) => CurlChunk) | null; connectOnly?: string | number | boolean | null; connectTimeout?: string | number | boolean | null; connectTimeoutMs?: string | number | boolean | null; connectTo?: string[] | null; cookie?: string | number | boolean | null; cookieFile?: string | number | boolean | null; cookieJar?: string | number | boolean | null; cookieList?: string | number | boolean | null; cookieSession?: string | number | boolean | null; crlFile?: string | number | boolean | null; crlf?: string | number | boolean | null; customRequest?: string | number | boolean | null; debugFunction?: ((this: EasyNativeBinding, type: CurlInfoDebug, data: Buffer) => 0) | null; defaultProtocol?: string | number | boolean | null; dirListOnly?: string | number | boolean | null; disallowUsernameInUrl?: string | number | boolean | null; dnsCacheTimeout?: string | number | boolean | null; dnsInterface?: string | number | boolean | null; dnsLocalIp4?: string | number | boolean | null; dnsLocalIp6?: string | number | boolean | null; dnsServers?: string | number | boolean | null; dnsShuffleAddresses?: string | number | boolean | null; dnsUseGlobalCache?: string | number | boolean | null; dohSslVerifyHost?: string | number | boolean | null; dohSslVerifyPeer?: string | number | boolean | null; dohSslVerifyStatus?: string | number | boolean | null; dohUrl?: string | number | boolean | null; egdSocket?: string | number | boolean | null; expect100TimeoutMs?: string | number | boolean | null; failOnError?: string | number | boolean | null; fileTime?: string | number | boolean | null; fnMatchFunction?: ((this: EasyNativeBinding, pattern: string, value: string) => CurlFnMatchFunc) | null; followLocation?: string | number | boolean | null; forbIdReuse?: string | number | boolean | null; freshConnect?: string | number | boolean | null; ftpAccount?: string | number | boolean | null; ftpAlternativeToUser?: string | number | boolean | null; ftpCreateMissingDirs?: string | number | boolean | null; ftpFileMethod?: CurlFtpMethod | null; ftpPort?: string | number | boolean | null; ftpSkipPasvIp?: string | number | boolean | null; ftpSslAuth?: string | number | boolean | null; ftpSslCcc?: CurlFtpSsl | null; ftpUseEprt?: string | number | boolean | null; ftpUseEpsv?: string | number | boolean | null; ftpUsePret?: string | number | boolean | null; gssapiDelegation?: CurlGssApi | null; haProxyProtocol?: string | number | boolean | null; happyEyeballsTimeoutMs?: string | number | boolean | null; header?: string | number | boolean | null; headerFunction?: ((this: EasyNativeBinding, data: Buffer, size: number, nmemb: number) => number) | null; headerOpt?: CurlHeader | null; hsts?: string | number | boolean | null; hstsCtrl?: CurlHsts | null; hstsReadFunction?: ((this: EasyNativeBinding) => null | CurlHstsCacheEntry | CurlHstsCacheEntry[]) | null; hstsWriteFunction?: ((this: EasyNativeBinding, cacheEntry: CurlHstsCacheEntry, cacheCount: CurlHstsCacheCount) => any) | null; http09Allowed?: string | number | boolean | null; http200aliases?: string[] | null; httpAuth?: string | number | boolean | null; httpContentDecoding?: string | number | boolean | null; httpGet?: string | number | boolean | null; httpHeader?: string[] | null; httpPost?: HttpPostField[] | null; httpProxyTunnel?: string | number | boolean | null; httpTransferDecoding?: string | number | boolean | null; httpVersion?: CurlHttpVersion | null; ignoreContentLength?: string | number | boolean | null; inFileSize?: string | number | boolean | null; inFileSizeLarge?: string | number | boolean | null; interface?: string | number | boolean | null; ipResolve?: CurlIpResolve | null; issuerCert?: string | number | boolean | null; issuerCertBlob?: ArrayBuffer | Buffer | string | null; keepSendingOnError?: string | number | boolean | null; keyPasswd?: string | number | boolean | null; krbLevel?: string | number | boolean | null; localPort?: string | number | boolean | null; localPortRange?: string | number | boolean | null; loginOptions?: string | number | boolean | null; lowSpeedLimit?: string | number | boolean | null; lowSpeedTime?: string | number | boolean | null; mailAuth?: string | number | boolean | null; mailFrom?: string | number | boolean | null; mailRcpt?: string[] | null; mailRcptAlllowfails?: string | number | boolean | null; maxAgeConn?: string | number | boolean | null; maxConnects?: string | number | boolean | null; maxFileSize?: string | number | boolean | null; maxFileSizeLarge?: string | number | boolean | null; maxLifetimeConn?: string | number | boolean | null; maxRecvSpeedLarge?: string | number | boolean | null; maxRedirs?: string | number | boolean | null; maxSendSpeedLarge?: string | number | boolean | null; netrc?: CurlNetrc | null; netrcFile?: string | number | boolean | null; newDirectoryPerms?: string | number | boolean | null; newFilePerms?: string | number | boolean | null; noProgress?: string | number | boolean | null; noProxy?: string | number | boolean | null; noSignal?: string | number | boolean | null; nobody?: string | number | boolean | null; password?: string | number | boolean | null; pathAsIs?: string | number | boolean | null; pinnedPublicKey?: string | number | boolean | null; pipeWait?: string | number | boolean | null; port?: string | number | boolean | null; post?: string | number | boolean | null; postFieldSize?: string | number | boolean | null; postFieldSizeLarge?: string | number | boolean | null; postFields?: string | number | boolean | null; postQuote?: string[] | null; postRedir?: string | number | boolean | null; preProxy?: string | number | boolean | null; preQuote?: string[] | null; preReqFunction?: ((this: EasyNativeBinding, connPrimaryIp: string, connLocalIp: string, connPrimaryPort: number, conLocalPort: number) => CurlPreReqFunc) | null; progressFunction?: ((this: EasyNativeBinding, dltotal: number, dlnow: number, ultotal: number, ulnow: number) => number | CurlProgressFunc) | null; protocols?: CurlProtocol | null; protocolsStr?: string | number | boolean | null; proxy?: string | number | boolean | null; proxyAuth?: string | number | boolean | null; proxyCaInfo?: string | number | boolean | null; proxyCaInfoBlob?: ArrayBuffer | Buffer | string | null; proxyCaPath?: string | number | boolean | null; proxyCrlFile?: string | number | boolean | null; proxyHeader?: string[] | null; proxyIssuerCert?: string | number | boolean | null; proxyIssuerCertBlob?: string | number | boolean | null; proxyKeyPasswd?: string | number | boolean | null; proxyPassword?: string | number | boolean | null; proxyPinnedPublicKey?: string | number | boolean | null; proxyPort?: string | number | boolean | null; proxyServiceName?: string | number | boolean | null; proxySslCert?: ArrayBuffer | Buffer | string | null; proxySslCertBlob?: ArrayBuffer | Buffer | string | null; proxySslCertType?: string | number | boolean | null; proxySslCipherList?: string | number | boolean | null; proxySslKey?: string | number | boolean | null; proxySslKeyBlob?: ArrayBuffer | Buffer | string | null; proxySslKeyType?: string | number | boolean | null; proxySslOptions?: CurlSslOpt | null; proxySslVerifyHost?: string | number | boolean | null; proxySslVerifyPeer?: string | number | boolean | null; proxySslversion?: string | number | boolean | null; proxyTls13Ciphers?: string | number | boolean | null; proxyTlsAuthPassword?: string | number | boolean | null; proxyTlsAuthType?: string | number | boolean | null; proxyTlsAuthUsername?: string | number | boolean | null; proxyTransferMode?: string | number | boolean | null; proxyType?: CurlProxy | null; proxyUsername?: string | number | boolean | null; proxyUserpwd?: string | number | boolean | null; put?: string | number | boolean | null; quote?: string[] | null; randomFile?: string | number | boolean | null; range?: string | number | boolean | null; readData?: string | number | boolean | null; readFunction?: ((this: EasyNativeBinding, data: Buffer, size: number, nmemb: number) => number) | null; redirProtocols?: CurlProtocol | null; redirProtocolsStr?: string | number | boolean | null; referer?: string | number | boolean | null; requestTarget?: string | number | boolean | null; resolve?: string[] | null; resumeFrom?: string | number | boolean | null; resumeFromLarge?: string | number | boolean | null; rtspClientCseq?: string | number | boolean | null; rtspRequest?: CurlRtspRequest | null; rtspServerCseq?: string | number | boolean | null; rtspSessionId?: string | number | boolean | null; rtspStreamUri?: string | number | boolean | null; rtspTransPort?: string | number | boolean | null; saslAuthzId?: string | number | boolean | null; saslIr?: string | number | boolean | null; seekFunction?: ((this: EasyNativeBinding, offset: number, origin: number) => number) | null; serverResponseTimeout?: string | number | boolean | null; serviceName?: string | number | boolean | null; share?: Share | null; socks5Auth?: string | number | boolean | null; socks5GssapiNec?: string | number | boolean | null; socks5GssapiService?: string | number | boolean | null; sshAuthTypes?: CurlSshAuth | null; sshCompression?: string | number | boolean | null; sshHostKeyData?: string | number | boolean | null; sshHostPublicKeyMd5?: string | number | boolean | null; sshKnownHosts?: string | number | boolean | null; sshPrivateKeyFile?: string | number | boolean | null; sshPublicKeyFile?: string | number | boolean | null; sslCert?: string | number | boolean | null; sslCertBlob?: ArrayBuffer | Buffer | string | null; sslCertType?: string | number | boolean | null; sslCipherList?: string | number | boolean | null; sslEcCurves?: string | number | boolean | null; sslEnableAlpn?: string | number | boolean | null; sslEnableNpn?: string | number | boolean | null; sslEngine?: string | number | boolean | null; sslEngineDefault?: string | number | boolean | null; sslFalsestart?: string | number | boolean | null; sslKey?: string | number | boolean | null; sslKeyBlob?: ArrayBuffer | Buffer | string | null; sslKeyType?: string | number | boolean | null; sslOptions?: CurlSslOpt | null; sslSessionIdCache?: string | number | boolean | null; sslVerifyHost?: string | number | boolean | null; sslVerifyPeer?: string | number | boolean | null; sslVerifyStatus?: string | number | boolean | null; sslversion?: CurlSslVersion | null; suppressConnectHeaders?: string | number | boolean | null; tcpFastOpen?: string | number | boolean | null; tcpKeepAlive?: string | number | boolean | null; tcpKeepIdle?: string | number | boolean | null; tcpKeepIntvl?: string | number | boolean | null; tcpNoDelay?: string | number | boolean | null; telnetOptions?: string[] | null; tftpBlkSize?: string | number | boolean | null; tftpNoOptions?: string | number | boolean | null; timeCondition?: CurlTimeCond | null; timeValue?: string | number | boolean | null; timeValueLarge?: string | number | boolean | null; timeout?: string | number | boolean | null; timeoutMs?: string | number | boolean | null; tls13Ciphers?: string | number | boolean | null; tlsAuthPassword?: string | number | boolean | null; tlsAuthType?: string | number | boolean | null; tlsAuthUsername?: string | number | boolean | null; trailerFunction?: ((this: EasyNativeBinding) => string[] | false) | null; transferEncoding?: string | number | boolean | null; transferText?: string | number | boolean | null; unixSocketPath?: string | number | boolean | null; unrestrictedAuth?: string | number | boolean | null; upkeepIntervalMs?: string | number | boolean | null; upload?: string | number | boolean | null; uploadBufferSize?: string | number | boolean | null; url?: string | number | boolean | null; useSsl?: CurlUseSsl | null; userAgent?: string | number | boolean | null; username?: string | number | boolean | null; userpwd?: string | number | boolean | null; verbose?: string | number | boolean | null; wildcardMatch?: string | number | boolean | null; writeFunction?: ((this: EasyNativeBinding, data: Buffer, size: number, nmemb: number) => number) | null; xferInfoFunction?: ((this: EasyNativeBinding, dltotal: number, dlnow: number, ultotal: number, ulnow: number) => number | CurlProgressFunc) | null; xoauth2Bearer?: string | number | boolean | null }
    • CurlyOptions

Index

Properties

Properties

Optional ABSTRACT_UNIX_SOCKET

ABSTRACT_UNIX_SOCKET: string | number | boolean | null

Path to an abstract Unix domain socket.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_ABSTRACT_UNIX_SOCKET.html

Optional ACCEPTTIMEOUT_MS

ACCEPTTIMEOUT_MS: string | number | boolean | null

Timeout for waiting for the server's connect back to be accepted.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_ACCEPTTIMEOUT_MS.html

Optional ACCEPT_ENCODING

ACCEPT_ENCODING: string | number | boolean | null

Accept-Encoding and automatic decompressing data.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_ACCEPT_ENCODING.html

Optional ADDRESS_SCOPE

ADDRESS_SCOPE: string | number | boolean | null

IPv6 scope for local addresses.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_ADDRESS_SCOPE.html

Optional ALTSVC

ALTSVC: string | number | boolean | null

Specify the Alt-Svc: cache file name.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_ALTSVC.html

Optional ALTSVC_CTRL

ALTSVC_CTRL: string | number | boolean | null

Enable and configure Alt-Svc: treatment.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_ALTSVC_CTRL.html

Optional APPEND

APPEND: string | number | boolean | null

Append to remote file.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_APPEND.html

Optional AUTOREFERER

AUTOREFERER: string | number | boolean | null

Automatically set Referer: header.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_AUTOREFERER.html

Optional AWS_SIGV4

AWS_SIGV4: string | number | boolean | null

AWS HTTP V4 Signature.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_AWS_SIGV4.html

Optional BUFFERSIZE

BUFFERSIZE: string | number | boolean | null

Ask for alternate buffer size.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_BUFFERSIZE.html

Optional CAINFO

CAINFO: string | number | boolean | null

CA cert bundle.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CAINFO.html

Optional CAINFO_BLOB

CAINFO_BLOB: ArrayBuffer | Buffer | string | null

CA cert bundle memory buffer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CAINFO_BLOB.html

Optional CAPATH

CAPATH: string | number | boolean | null

Path to CA cert bundle.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CAPATH.html

Optional CERTINFO

CERTINFO: string | number | boolean | null

Extract certificate info.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CERTINFO.html

Optional CHUNK_BGN_FUNCTION

CHUNK_BGN_FUNCTION: ((this: EasyNativeBinding, fileInfo: FileInfo, remains: number) => CurlChunk) | null

Callback for wildcard download start of chunk.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CHUNK_BGN_FUNCTION.html

Optional CHUNK_END_FUNCTION

CHUNK_END_FUNCTION: ((this: EasyNativeBinding) => CurlChunk) | null

Callback for wildcard download end of chunk.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CHUNK_END_FUNCTION.html

Optional CONNECTTIMEOUT

CONNECTTIMEOUT: string | number | boolean | null

Timeout for the connection phase.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CONNECTTIMEOUT.html

Optional CONNECTTIMEOUT_MS

CONNECTTIMEOUT_MS: string | number | boolean | null

Millisecond timeout for the connection phase.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CONNECTTIMEOUT_MS.html

Optional CONNECT_ONLY

CONNECT_ONLY: string | number | boolean | null

Only connect, nothing else.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CONNECT_ONLY.html

Optional CONNECT_TO

CONNECT_TO: string[] | null

Connect to a specific host and port.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CONNECT_TO.html

Optional COOKIE

COOKIE: string | number | boolean | null

Cookie(s) to send.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_COOKIE.html

Optional COOKIEFILE

COOKIEFILE: string | number | boolean | null

File to read cookies from.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_COOKIEFILE.html

Optional COOKIEJAR

COOKIEJAR: string | number | boolean | null

File to write cookies to.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_COOKIEJAR.html

Optional COOKIELIST

COOKIELIST: string | number | boolean | null

Add or control cookies.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_COOKIELIST.html

Optional COOKIESESSION

COOKIESESSION: string | number | boolean | null

Start a new cookie session.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_COOKIESESSION.html

Optional CRLF

CRLF: string | number | boolean | null

Convert newlines.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CRLF.html

Optional CRLFILE

CRLFILE: string | number | boolean | null

Certificate Revocation List.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CRLFILE.html

Optional CUSTOMREQUEST

CUSTOMREQUEST: string | number | boolean | null

Custom request/method.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CUSTOMREQUEST.html

Optional DEBUGFUNCTION

DEBUGFUNCTION: ((this: EasyNativeBinding, type: CurlInfoDebug, data: Buffer) => 0) | null

Callback for debug information.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DEBUGFUNCTION.html

Optional DEFAULT_PROTOCOL

DEFAULT_PROTOCOL: string | number | boolean | null

Default protocol.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DEFAULT_PROTOCOL.html

Optional DIRLISTONLY

DIRLISTONLY: string | number | boolean | null

List only.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DIRLISTONLY.html

Optional DISALLOW_USERNAME_IN_URL

DISALLOW_USERNAME_IN_URL: string | number | boolean | null

Do not allow username in URL.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DISALLOW_USERNAME_IN_URL.html

Optional DNS_CACHE_TIMEOUT

DNS_CACHE_TIMEOUT: string | number | boolean | null

Timeout for DNS cache.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DNS_CACHE_TIMEOUT.html

Optional DNS_INTERFACE

DNS_INTERFACE: string | number | boolean | null

Bind name resolves to this interface.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DNS_INTERFACE.html

Optional DNS_LOCAL_IP4

DNS_LOCAL_IP4: string | number | boolean | null

Bind name resolves to this IP4 address.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DNS_LOCAL_IP4.html

Optional DNS_LOCAL_IP6

DNS_LOCAL_IP6: string | number | boolean | null

Bind name resolves to this IP6 address.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DNS_LOCAL_IP6.html

Optional DNS_SERVERS

DNS_SERVERS: string | number | boolean | null

Preferred DNS servers.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DNS_SERVERS.html

Optional DNS_SHUFFLE_ADDRESSES

DNS_SHUFFLE_ADDRESSES: string | number | boolean | null

Shuffle addresses before use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DNS_SHUFFLE_ADDRESSES.html

Optional DNS_USE_GLOBAL_CACHE

DNS_USE_GLOBAL_CACHE: string | number | boolean | null

OBSOLETE Enable global DNS cache.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DNS_USE_GLOBAL_CACHE.html

Optional DOH_SSL_VERIFYHOST

DOH_SSL_VERIFYHOST: string | number | boolean | null

Verify the host name in the DoH (DNS-over-HTTPS) SSL certificate.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DOH_SSL_VERIFYHOST.html

Optional DOH_SSL_VERIFYPEER

DOH_SSL_VERIFYPEER: string | number | boolean | null

Verify the DoH (DNS-over-HTTPS) SSL certificate.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DOH_SSL_VERIFYPEER.html

Optional DOH_SSL_VERIFYSTATUS

DOH_SSL_VERIFYSTATUS: string | number | boolean | null

Verify the DoH (DNS-over-HTTPS) SSL certificate's status.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DOH_SSL_VERIFYSTATUS.html

Optional DOH_URL

DOH_URL: string | number | boolean | null

Use this DoH server for name resolves.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DOH_URL.html

Optional EGDSOCKET

EGDSOCKET: string | number | boolean | null

OBSOLETE Identify EGD socket for entropy.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_EGDSOCKET.html

Optional EXPECT_100_TIMEOUT_MS

EXPECT_100_TIMEOUT_MS: string | number | boolean | null

100-continue timeout.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_EXPECT_100_TIMEOUT_MS.html

Optional FAILONERROR

FAILONERROR: string | number | boolean | null

Fail on HTTP 4xx errors.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FAILONERROR.html

Optional FILETIME

FILETIME: string | number | boolean | null

Request file modification date and time.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FILETIME.html

Optional FNMATCH_FUNCTION

FNMATCH_FUNCTION: ((this: EasyNativeBinding, pattern: string, value: string) => CurlFnMatchFunc) | null

Callback for wildcard matching.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FNMATCH_FUNCTION.html

Optional FOLLOWLOCATION

FOLLOWLOCATION: string | number | boolean | null

Follow HTTP redirects.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FOLLOWLOCATION.html

Optional FORBID_REUSE

FORBID_REUSE: string | number | boolean | null

Prevent subsequent connections from re-using this.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FORBID_REUSE.html

Optional FRESH_CONNECT

FRESH_CONNECT: string | number | boolean | null

Use a new connection.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FRESH_CONNECT.html

Optional FTPPORT

FTPPORT: string | number | boolean | null

Use active FTP.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTPPORT.html

Optional FTPSSLAUTH

FTPSSLAUTH: string | number | boolean | null

Control how to do TLS.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTPSSLAUTH.html

Optional FTP_ACCOUNT

FTP_ACCOUNT: string | number | boolean | null

Send ACCT command.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTP_ACCOUNT.html

Optional FTP_ALTERNATIVE_TO_USER

FTP_ALTERNATIVE_TO_USER: string | number | boolean | null

Alternative to USER.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTP_ALTERNATIVE_TO_USER.html

Optional FTP_CREATE_MISSING_DIRS

FTP_CREATE_MISSING_DIRS: string | number | boolean | null

Create missing directories on the remote server.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTP_CREATE_MISSING_DIRS.html

Optional FTP_FILEMETHOD

FTP_FILEMETHOD: CurlFtpMethod | null

Specify how to reach files.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTP_FILEMETHOD.html

Optional FTP_SKIP_PASV_IP

FTP_SKIP_PASV_IP: string | number | boolean | null

Ignore the IP address in the PASV response.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTP_SKIP_PASV_IP.html

Optional FTP_SSL_CCC

FTP_SSL_CCC: CurlFtpSsl | null

Back to non-TLS again after authentication.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTP_SSL_CCC.html

Optional FTP_USE_EPRT

FTP_USE_EPRT: string | number | boolean | null

Use EPRT.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTP_USE_EPRT.html

Optional FTP_USE_EPSV

FTP_USE_EPSV: string | number | boolean | null

Use EPSV.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTP_USE_EPSV.html

Optional FTP_USE_PRET

FTP_USE_PRET: string | number | boolean | null

Use PRET.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTP_USE_PRET.html

Optional GSSAPI_DELEGATION

GSSAPI_DELEGATION: CurlGssApi | null

Disable GSS-API delegation.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_GSSAPI_DELEGATION.html

Optional HAPPY_EYEBALLS_TIMEOUT_MS

HAPPY_EYEBALLS_TIMEOUT_MS: string | number | boolean | null

Timeout for happy eyeballs.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS.html

Optional HAPROXYPROTOCOL

HAPROXYPROTOCOL: string | number | boolean | null

Send an HAProxy PROXY protocol v1 header.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HAPROXYPROTOCOL.html

Optional HEADER

HEADER: string | number | boolean | null

Include the header in the body output.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HEADER.html

Optional HEADERFUNCTION

HEADERFUNCTION: ((this: EasyNativeBinding, data: Buffer, size: number, nmemb: number) => number) | null

Callback for writing received headers.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HEADERFUNCTION.html

Optional HEADEROPT

HEADEROPT: CurlHeader | null

Control custom headers.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HEADEROPT.html

Optional HSTS

HSTS: string | number | boolean | null

Set HSTS cache file.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HSTS.html

Optional HSTSREADFUNCTION

HSTSREADFUNCTION: ((this: EasyNativeBinding) => null | CurlHstsCacheEntry | CurlHstsCacheEntry[]) | null

Set HSTS read callback.

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: : https://curl.haxx.se/libcurl/c/CURLOPT_HSTSREADFUNCTION.html

Optional HSTSWRITEFUNCTION

HSTSWRITEFUNCTION: ((this: EasyNativeBinding, cacheEntry: CurlHstsCacheEntry, cacheCount: CurlHstsCacheCount) => any) | null

Set HSTS write callback.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HSTSWRITEFUNCTION.html

Optional HSTS_CTRL

HSTS_CTRL: CurlHsts | null

Enable HSTS.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HSTS_CTRL.html

Optional HTTP09_ALLOWED

HTTP09_ALLOWED: string | number | boolean | null

Allow HTTP/0.9 responses.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTP09_ALLOWED.html

Optional HTTP200ALIASES

HTTP200ALIASES: string[] | null

Alternative versions of 200 OK.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTP200ALIASES.html

Optional HTTPAUTH

HTTPAUTH: string | number | boolean | null

HTTP server authentication methods.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTPAUTH.html

Optional HTTPGET

HTTPGET: string | number | boolean | null

Do an HTTP GET request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTPGET.html

Optional HTTPHEADER

HTTPHEADER: string[] | null

Custom HTTP headers.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTPHEADER.html

Optional HTTPPOST

HTTPPOST: HttpPostField[] | null

Deprecated option Multipart formpost HTTP POST.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTPPOST.html

Optional HTTPPROXYTUNNEL

HTTPPROXYTUNNEL: string | number | boolean | null

Tunnel through the HTTP proxy.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTPPROXYTUNNEL.html

Optional HTTP_CONTENT_DECODING

HTTP_CONTENT_DECODING: string | number | boolean | null

Disable Content decoding.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTP_CONTENT_DECODING.html

Optional HTTP_TRANSFER_DECODING

HTTP_TRANSFER_DECODING: string | number | boolean | null

Disable Transfer decoding.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTP_TRANSFER_DECODING.html

Optional HTTP_VERSION

HTTP_VERSION: CurlHttpVersion | null

HTTP version to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTP_VERSION.html

Optional IGNORE_CONTENT_LENGTH

IGNORE_CONTENT_LENGTH: string | number | boolean | null

Ignore Content-Length.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_IGNORE_CONTENT_LENGTH.html

Optional INFILESIZE

INFILESIZE: string | number | boolean | null

Size of file to send.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_INFILESIZE.html

Optional INFILESIZE_LARGE

INFILESIZE_LARGE: string | number | boolean | null

Size of file to send.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_INFILESIZE_LARGE.html

Optional INTERFACE

INTERFACE: string | number | boolean | null

Bind connection locally to this.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_INTERFACE.html

Optional IPRESOLVE

IPRESOLVE: CurlIpResolve | null

IP version to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_IPRESOLVE.html

Optional ISSUERCERT

ISSUERCERT: string | number | boolean | null

Issuer certificate.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_ISSUERCERT.html

Optional ISSUERCERT_BLOB

ISSUERCERT_BLOB: ArrayBuffer | Buffer | string | null

Issuer certificate memory buffer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_ISSUERCERT_BLOB.html

Optional KEEP_SENDING_ON_ERROR

KEEP_SENDING_ON_ERROR: string | number | boolean | null

Keep sending on HTTP >= 300 errors.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_KEEP_SENDING_ON_ERROR.html

Optional KEYPASSWD

KEYPASSWD: string | number | boolean | null

Client key password.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_KEYPASSWD.html

Optional KRBLEVEL

KRBLEVEL: string | number | boolean | null

Kerberos security level.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_KRBLEVEL.html

Optional LOCALPORT

LOCALPORT: string | number | boolean | null

Bind connection locally to this port.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_LOCALPORT.html

Optional LOCALPORTRANGE

LOCALPORTRANGE: string | number | boolean | null

Bind connection locally to port range.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_LOCALPORTRANGE.html

Optional LOGIN_OPTIONS

LOGIN_OPTIONS: string | number | boolean | null

Login options.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_LOGIN_OPTIONS.html

Optional LOW_SPEED_LIMIT

LOW_SPEED_LIMIT: string | number | boolean | null

Low speed limit to abort transfer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_LOW_SPEED_LIMIT.html

Optional LOW_SPEED_TIME

LOW_SPEED_TIME: string | number | boolean | null

Time to be below the speed to trigger low speed abort.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_LOW_SPEED_TIME.html

Optional MAIL_AUTH

MAIL_AUTH: string | number | boolean | null

Authentication address.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAIL_AUTH.html

Optional MAIL_FROM

MAIL_FROM: string | number | boolean | null

Address of the sender.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAIL_FROM.html

Optional MAIL_RCPT

MAIL_RCPT: string[] | null

Address of the recipients.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAIL_RCPT.html

Optional MAIL_RCPT_ALLLOWFAILS

MAIL_RCPT_ALLLOWFAILS: string | number | boolean | null

Allow RCPT TO command to fail for some recipients.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAIL_RCPT_ALLLOWFAILS.html

Optional MAXAGE_CONN

MAXAGE_CONN: string | number | boolean | null

Limit the age (idle time) of connections for reuse.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAXAGE_CONN.html

Optional MAXCONNECTS

MAXCONNECTS: string | number | boolean | null

Maximum number of connections in the connection pool.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAXCONNECTS.html

Optional MAXFILESIZE

MAXFILESIZE: string | number | boolean | null

Maximum file size to get.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAXFILESIZE.html

Optional MAXFILESIZE_LARGE

MAXFILESIZE_LARGE: string | number | boolean | null

Maximum file size to get.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAXFILESIZE_LARGE.html

Optional MAXLIFETIME_CONN

MAXLIFETIME_CONN: string | number | boolean | null

Limit the age (since creation) of connections for reuse.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAXLIFETIME_CONN.html

Optional MAXREDIRS

MAXREDIRS: string | number | boolean | null

Maximum number of redirects to follow.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAXREDIRS.html

Optional MAX_RECV_SPEED_LARGE

MAX_RECV_SPEED_LARGE: string | number | boolean | null

Cap the download speed to this.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAX_RECV_SPEED_LARGE.html

Optional MAX_SEND_SPEED_LARGE

MAX_SEND_SPEED_LARGE: string | number | boolean | null

Cap the upload speed to this.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAX_SEND_SPEED_LARGE.html

Optional NETRC

NETRC: CurlNetrc | null

Enable .netrc parsing.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_NETRC.html

Optional NETRC_FILE

NETRC_FILE: string | number | boolean | null

.netrc file name.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_NETRC_FILE.html

Optional NEW_DIRECTORY_PERMS

NEW_DIRECTORY_PERMS: string | number | boolean | null

Mode for creating new remote directories.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_NEW_DIRECTORY_PERMS.html

Optional NEW_FILE_PERMS

NEW_FILE_PERMS: string | number | boolean | null

Mode for creating new remote files.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_NEW_FILE_PERMS.html

Optional NOBODY

NOBODY: string | number | boolean | null

Do not get the body contents.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_NOBODY.html

Optional NOPROGRESS

NOPROGRESS: string | number | boolean | null

Shut off the progress meter.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_NOPROGRESS.html

Optional NOPROXY

NOPROXY: string | number | boolean | null

Filter out hosts from proxy use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_NOPROXY.html

Optional NOSIGNAL

NOSIGNAL: string | number | boolean | null

Do not install signal handlers.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_NOSIGNAL.html

Optional PASSWORD

PASSWORD: string | number | boolean | null

Password.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PASSWORD.html

Optional PATH_AS_IS

PATH_AS_IS: string | number | boolean | null

Disable squashing /../ and /./ sequences in the path.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PATH_AS_IS.html

Optional PINNEDPUBLICKEY

PINNEDPUBLICKEY: string | number | boolean | null

Set pinned SSL public key .

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PINNEDPUBLICKEY.html

Optional PIPEWAIT

PIPEWAIT: string | number | boolean | null

Wait on connection to pipeline on it.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PIPEWAIT.html

Optional PORT

PORT: string | number | boolean | null

Port number to connect to.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PORT.html

Optional POST

POST: string | number | boolean | null

Issue an HTTP POST request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_POST.html

Optional POSTFIELDS

POSTFIELDS: string | number | boolean | null

Send a POST with this data.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_POSTFIELDS.html

Optional POSTFIELDSIZE

POSTFIELDSIZE: string | number | boolean | null

The POST data is this big.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_POSTFIELDSIZE.html

Optional POSTFIELDSIZE_LARGE

POSTFIELDSIZE_LARGE: string | number | boolean | null

The POST data is this big.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_POSTFIELDSIZE_LARGE.html

Optional POSTQUOTE

POSTQUOTE: string[] | null

Commands to run after transfer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_POSTQUOTE.html

Optional POSTREDIR

POSTREDIR: string | number | boolean | null

How to act on redirects after POST.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_POSTREDIR.html

Optional PREQUOTE

PREQUOTE: string[] | null

Commands to run just before transfer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PREQUOTE.html

Optional PREREQFUNCTION

PREREQFUNCTION: ((this: EasyNativeBinding, connPrimaryIp: string, connLocalIp: string, connPrimaryPort: number, conLocalPort: number) => CurlPreReqFunc) | null

Callback to be called after a connection is established but before a request is made on that connection.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PREREQFUNCTION.html

Optional PRE_PROXY

PRE_PROXY: string | number | boolean | null

Socks proxy to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PRE_PROXY.html

Optional PROGRESSFUNCTION

PROGRESSFUNCTION: ((this: EasyNativeBinding, dltotal: number, dlnow: number, ultotal: number, ulnow: number) => number | CurlProgressFunc) | null

OBSOLETE callback for progress meter.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROGRESSFUNCTION.html

Optional PROTOCOLS

PROTOCOLS: CurlProtocol | null

Deprecated option Allowed protocols.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROTOCOLS.html

Optional PROTOCOLS_STR

PROTOCOLS_STR: string | number | boolean | null

Allowed protocols.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROTOCOLS_STR.html

Optional PROXY

PROXY: string | number | boolean | null

Proxy to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html

Optional PROXYAUTH

PROXYAUTH: string | number | boolean | null

HTTP proxy authentication methods.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXYAUTH.html

Optional PROXYHEADER

PROXYHEADER: string[] | null

Custom HTTP headers sent to proxy.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXYHEADER.html

Optional PROXYPASSWORD

PROXYPASSWORD: string | number | boolean | null

Proxy password.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXYPASSWORD.html

Optional PROXYPORT

PROXYPORT: string | number | boolean | null

Proxy port to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXYPORT.html

Optional PROXYTYPE

PROXYTYPE: CurlProxy | null

Proxy type.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXYTYPE.html

Optional PROXYUSERNAME

PROXYUSERNAME: string | number | boolean | null

Proxy user name.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXYUSERNAME.html

Optional PROXYUSERPWD

PROXYUSERPWD: string | number | boolean | null

Proxy user name and password.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXYUSERPWD.html

Optional PROXY_CAINFO

PROXY_CAINFO: string | number | boolean | null

Proxy CA cert bundle.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_CAINFO.html

Optional PROXY_CAINFO_BLOB

PROXY_CAINFO_BLOB: ArrayBuffer | Buffer | string | null

Proxy CA cert bundle memory buffer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_CAINFO_BLOB.html

Optional PROXY_CAPATH

PROXY_CAPATH: string | number | boolean | null

Path to proxy CA cert bundle.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_CAPATH.html

Optional PROXY_CRLFILE

PROXY_CRLFILE: string | number | boolean | null

Proxy Certificate Revocation List.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_CRLFILE.html

Optional PROXY_ISSUERCERT

PROXY_ISSUERCERT: string | number | boolean | null

Proxy issuer certificate.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_ISSUERCERT.html

Optional PROXY_ISSUERCERT_BLOB

PROXY_ISSUERCERT_BLOB: string | number | boolean | null

Proxy issuer certificate memory buffer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_ISSUERCERT_BLOB.html

Optional PROXY_KEYPASSWD

PROXY_KEYPASSWD: string | number | boolean | null

Proxy client key password.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_KEYPASSWD.html

Optional PROXY_PINNEDPUBLICKEY

PROXY_PINNEDPUBLICKEY: string | number | boolean | null

Set the proxy's pinned SSL public key.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_PINNEDPUBLICKEY.html

Optional PROXY_SERVICE_NAME

PROXY_SERVICE_NAME: string | number | boolean | null

Proxy authentication service name.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SERVICE_NAME.html

Optional PROXY_SSLCERT

PROXY_SSLCERT: ArrayBuffer | Buffer | string | null

Proxy client cert.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSLCERT.html

Optional PROXY_SSLCERTTYPE

PROXY_SSLCERTTYPE: string | number | boolean | null

Proxy client cert type.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSLCERTTYPE.html

Optional PROXY_SSLCERT_BLOB

PROXY_SSLCERT_BLOB: ArrayBuffer | Buffer | string | null

Proxy client cert memory buffer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSLCERT_BLOB.html

Optional PROXY_SSLKEY

PROXY_SSLKEY: string | number | boolean | null

Proxy client key.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSLKEY.html

Optional PROXY_SSLKEYTYPE

PROXY_SSLKEYTYPE: string | number | boolean | null

Proxy client key type.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSLKEYTYPE.html

Optional PROXY_SSLKEY_BLOB

PROXY_SSLKEY_BLOB: ArrayBuffer | Buffer | string | null

Proxy client key.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSLKEY_BLOB.html

Optional PROXY_SSLVERSION

PROXY_SSLVERSION: string | number | boolean | null

Proxy SSL version to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSLVERSION.html

Optional PROXY_SSL_CIPHER_LIST

PROXY_SSL_CIPHER_LIST: string | number | boolean | null

Proxy ciphers to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSL_CIPHER_LIST.html

Optional PROXY_SSL_OPTIONS

PROXY_SSL_OPTIONS: CurlSslOpt | null

Control proxy SSL behavior.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSL_OPTIONS.html

Optional PROXY_SSL_VERIFYHOST

PROXY_SSL_VERIFYHOST: string | number | boolean | null

Verify the host name in the proxy SSL certificate.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSL_VERIFYHOST.html

Optional PROXY_SSL_VERIFYPEER

PROXY_SSL_VERIFYPEER: string | number | boolean | null

Verify the proxy SSL certificate.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSL_VERIFYPEER.html

Optional PROXY_TLS13_CIPHERS

PROXY_TLS13_CIPHERS: string | number | boolean | null

Proxy TLS 1.3 cipher suites to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_TLS13_CIPHERS.html

Optional PROXY_TLSAUTH_PASSWORD

PROXY_TLSAUTH_PASSWORD: string | number | boolean | null

Proxy TLS authentication password.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_TLSAUTH_PASSWORD.html

Optional PROXY_TLSAUTH_TYPE

PROXY_TLSAUTH_TYPE: string | number | boolean | null

Proxy TLS authentication methods.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_TLSAUTH_TYPE.html

Optional PROXY_TLSAUTH_USERNAME

PROXY_TLSAUTH_USERNAME: string | number | boolean | null

Proxy TLS authentication user name.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_TLSAUTH_USERNAME.html

Optional PROXY_TRANSFER_MODE

PROXY_TRANSFER_MODE: string | number | boolean | null

Add transfer mode to URL over proxy.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_TRANSFER_MODE.html

Optional PUT

PUT: string | number | boolean | null

Deprecated option Issue an HTTP PUT request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PUT.html

Optional QUOTE

QUOTE: string[] | null

Commands to run before transfer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_QUOTE.html

Optional RANDOM_FILE

RANDOM_FILE: string | number | boolean | null

OBSOLETE Provide source for entropy random data.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RANDOM_FILE.html

Optional RANGE

RANGE: string | number | boolean | null

Range requests.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RANGE.html

Optional READDATA

READDATA: string | number | boolean | null

Data pointer to pass to the read callback.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_READDATA.html

Optional READFUNCTION

READFUNCTION: ((this: EasyNativeBinding, data: Buffer, size: number, nmemb: number) => number) | null

Callback for reading data.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_READFUNCTION.html

Optional REDIR_PROTOCOLS

REDIR_PROTOCOLS: CurlProtocol | null

Deprecated option Protocols to allow redirects to.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_REDIR_PROTOCOLS.html

Optional REDIR_PROTOCOLS_STR

REDIR_PROTOCOLS_STR: string | number | boolean | null

Protocols to allow redirects to.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_REDIR_PROTOCOLS_STR.html

Optional REFERER

REFERER: string | number | boolean | null

Referer: header.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_REFERER.html

Optional REQUEST_TARGET

REQUEST_TARGET: string | number | boolean | null

Set the request target.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_REQUEST_TARGET.html

Optional RESOLVE

RESOLVE: string[] | null

Provide fixed/fake name resolves.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RESOLVE.html

Optional RESUME_FROM

RESUME_FROM: string | number | boolean | null

Resume a transfer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RESUME_FROM.html

Optional RESUME_FROM_LARGE

RESUME_FROM_LARGE: string | number | boolean | null

Resume a transfer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RESUME_FROM_LARGE.html

Optional RTSP_CLIENT_CSEQ

RTSP_CLIENT_CSEQ: string | number | boolean | null

Client CSEQ number.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RTSP_CLIENT_CSEQ.html

Optional RTSP_REQUEST

RTSP_REQUEST: CurlRtspRequest | null

RTSP request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RTSP_REQUEST.html

Optional RTSP_SERVER_CSEQ

RTSP_SERVER_CSEQ: string | number | boolean | null

CSEQ number for RTSP Server->Client request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RTSP_SERVER_CSEQ.html

Optional RTSP_SESSION_ID

RTSP_SESSION_ID: string | number | boolean | null

RTSP session-id.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RTSP_SESSION_ID.html

Optional RTSP_STREAM_URI

RTSP_STREAM_URI: string | number | boolean | null

RTSP stream URI.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RTSP_STREAM_URI.html

Optional RTSP_TRANSPORT

RTSP_TRANSPORT: string | number | boolean | null

RTSP Transport: header.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RTSP_TRANSPORT.html

Optional SASL_AUTHZID

SASL_AUTHZID: string | number | boolean | null

SASL authorization identity (identity to act as).

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SASL_AUTHZID.html

Optional SASL_IR

SASL_IR: string | number | boolean | null

Enable SASL initial response.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SASL_IR.html

Optional SEEKFUNCTION

SEEKFUNCTION: ((this: EasyNativeBinding, offset: number, origin: number) => number) | null

Callback for seek operations.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SEEKFUNCTION.html

Optional SERVER_RESPONSE_TIMEOUT

SERVER_RESPONSE_TIMEOUT: string | number | boolean | null

Timeout for server responses.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SERVER_RESPONSE_TIMEOUT.html

Optional SERVICE_NAME

SERVICE_NAME: string | number | boolean | null

Authentication service name.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SERVICE_NAME.html

Optional SHARE

SHARE: Share | null

Share object to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SHARE.html

Optional SOCKS5_AUTH

SOCKS5_AUTH: string | number | boolean | null

Socks5 authentication methods.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SOCKS5_AUTH.html

Optional SOCKS5_GSSAPI_NEC

SOCKS5_GSSAPI_NEC: string | number | boolean | null

Socks5 GSSAPI NEC mode.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SOCKS5_GSSAPI_NEC.html

Optional SOCKS5_GSSAPI_SERVICE

SOCKS5_GSSAPI_SERVICE: string | number | boolean | null

Deprecated option Socks5 GSSAPI service name.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SOCKS5_GSSAPI_SERVICE.html

Optional SSH_AUTH_TYPES

SSH_AUTH_TYPES: CurlSshAuth | null

SSH authentication types.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSH_AUTH_TYPES.html

Optional SSH_COMPRESSION

SSH_COMPRESSION: string | number | boolean | null

Enable SSH compression.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSH_COMPRESSION.html

Optional SSH_HOSTKEYDATA

SSH_HOSTKEYDATA: string | number | boolean | null

Custom pointer to pass to ssh host key callback.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSH_HOSTKEYDATA.html

Optional SSH_HOST_PUBLIC_KEY_MD5

SSH_HOST_PUBLIC_KEY_MD5: string | number | boolean | null

MD5 of host's public key.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSH_HOST_PUBLIC_KEY_MD5.html

Optional SSH_KNOWNHOSTS

SSH_KNOWNHOSTS: string | number | boolean | null

File name with known hosts.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSH_KNOWNHOSTS.html

Optional SSH_PRIVATE_KEYFILE

SSH_PRIVATE_KEYFILE: string | number | boolean | null

File name of private key.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSH_PRIVATE_KEYFILE.html

Optional SSH_PUBLIC_KEYFILE

SSH_PUBLIC_KEYFILE: string | number | boolean | null

File name of public key.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSH_PUBLIC_KEYFILE.html

Optional SSLCERT

SSLCERT: string | number | boolean | null

Client cert.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSLCERT.html

Optional SSLCERTTYPE

SSLCERTTYPE: string | number | boolean | null

Client cert type.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSLCERTTYPE.html

Optional SSLCERT_BLOB

SSLCERT_BLOB: ArrayBuffer | Buffer | string | null

Client cert memory buffer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSLCERT_BLOB.html

Optional SSLENGINE

SSLENGINE: string | number | boolean | null

Use identifier with SSL engine.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSLENGINE.html

Optional SSLENGINE_DEFAULT

SSLENGINE_DEFAULT: string | number | boolean | null

Default SSL engine.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSLENGINE_DEFAULT.html

Optional SSLKEY

SSLKEY: string | number | boolean | null

Client key.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSLKEY.html

Optional SSLKEYTYPE

SSLKEYTYPE: string | number | boolean | null

Client key type.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSLKEYTYPE.html

Optional SSLKEY_BLOB

SSLKEY_BLOB: ArrayBuffer | Buffer | string | null

Client key memory buffer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSLKEY_BLOB.html

Optional SSLVERSION

SSLVERSION: CurlSslVersion | null

SSL version to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSLVERSION.html

Optional SSL_CIPHER_LIST

SSL_CIPHER_LIST: string | number | boolean | null

Ciphers to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_CIPHER_LIST.html

Optional SSL_EC_CURVES

SSL_EC_CURVES: string | number | boolean | null

Set key exchange curves.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_EC_CURVES.html

Optional SSL_ENABLE_ALPN

SSL_ENABLE_ALPN: string | number | boolean | null

Enable use of ALPN.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_ENABLE_ALPN.html

Optional SSL_ENABLE_NPN

SSL_ENABLE_NPN: string | number | boolean | null

OBSOLETE Enable use of NPN.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_ENABLE_NPN.html

Optional SSL_FALSESTART

SSL_FALSESTART: string | number | boolean | null

Enable TLS False Start.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_FALSESTART.html

Optional SSL_OPTIONS

SSL_OPTIONS: CurlSslOpt | null

Control SSL behavior.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_OPTIONS.html

Optional SSL_SESSIONID_CACHE

SSL_SESSIONID_CACHE: string | number | boolean | null

Disable SSL session-id cache.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_SESSIONID_CACHE.html

Optional SSL_VERIFYHOST

SSL_VERIFYHOST: string | number | boolean | null

Verify the host name in the SSL certificate.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYHOST.html

Optional SSL_VERIFYPEER

SSL_VERIFYPEER: string | number | boolean | null

Verify the SSL certificate.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYPEER.html

Optional SSL_VERIFYSTATUS

SSL_VERIFYSTATUS: string | number | boolean | null

Verify the SSL certificate's status.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYSTATUS.html

Optional SUPPRESS_CONNECT_HEADERS

SUPPRESS_CONNECT_HEADERS: string | number | boolean | null

Suppress proxy CONNECT response headers from user callbacks.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SUPPRESS_CONNECT_HEADERS.html

Optional TCP_FASTOPEN

TCP_FASTOPEN: string | number | boolean | null

Enable TCP Fast Open.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TCP_FASTOPEN.html

Optional TCP_KEEPALIVE

TCP_KEEPALIVE: string | number | boolean | null

Enable TCP keep-alive.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TCP_KEEPALIVE.html

Optional TCP_KEEPIDLE

TCP_KEEPIDLE: string | number | boolean | null

Idle time before sending keep-alive.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TCP_KEEPIDLE.html

Optional TCP_KEEPINTVL

TCP_KEEPINTVL: string | number | boolean | null

Interval between keep-alive probes.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TCP_KEEPINTVL.html

Optional TCP_NODELAY

TCP_NODELAY: string | number | boolean | null

Disable the Nagle algorithm.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TCP_NODELAY.html

Optional TELNETOPTIONS

TELNETOPTIONS: string[] | null

TELNET options.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TELNETOPTIONS.html

Optional TFTP_BLKSIZE

TFTP_BLKSIZE: string | number | boolean | null

TFTP block size.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TFTP_BLKSIZE.html

Optional TFTP_NO_OPTIONS

TFTP_NO_OPTIONS: string | number | boolean | null

Do not send TFTP options requests.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TFTP_NO_OPTIONS.html

Optional TIMECONDITION

TIMECONDITION: CurlTimeCond | null

Make a time conditional request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TIMECONDITION.html

Optional TIMEOUT

TIMEOUT: string | number | boolean | null

Timeout for the entire request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TIMEOUT.html

Optional TIMEOUT_MS

TIMEOUT_MS: string | number | boolean | null

Millisecond timeout for the entire request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TIMEOUT_MS.html

Optional TIMEVALUE

TIMEVALUE: string | number | boolean | null

Time value for the time conditional request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TIMEVALUE.html

Optional TIMEVALUE_LARGE

TIMEVALUE_LARGE: string | number | boolean | null

Time value for the time conditional request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TIMEVALUE_LARGE.html

Optional TLS13_CIPHERS

TLS13_CIPHERS: string | number | boolean | null

TLS 1.3 cipher suites to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TLS13_CIPHERS.html

Optional TLSAUTH_PASSWORD

TLSAUTH_PASSWORD: string | number | boolean | null

TLS authentication password.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TLSAUTH_PASSWORD.html

Optional TLSAUTH_TYPE

TLSAUTH_TYPE: string | number | boolean | null

TLS authentication methods.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TLSAUTH_TYPE.html

Optional TLSAUTH_USERNAME

TLSAUTH_USERNAME: string | number | boolean | null

TLS authentication user name.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TLSAUTH_USERNAME.html

Optional TRAILERFUNCTION

TRAILERFUNCTION: ((this: EasyNativeBinding) => string[] | false) | null

Set callback for sending trailing headers.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TRAILERFUNCTION.html

Optional TRANSFERTEXT

TRANSFERTEXT: string | number | boolean | null

Use text transfer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TRANSFERTEXT.html

Optional TRANSFER_ENCODING

TRANSFER_ENCODING: string | number | boolean | null

Request Transfer-Encoding.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TRANSFER_ENCODING.html

Optional UNIX_SOCKET_PATH

UNIX_SOCKET_PATH: string | number | boolean | null

Path to a Unix domain socket.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_UNIX_SOCKET_PATH.html

Optional UNRESTRICTED_AUTH

UNRESTRICTED_AUTH: string | number | boolean | null

Do not restrict authentication to original host.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_UNRESTRICTED_AUTH.html

Optional UPKEEP_INTERVAL_MS

UPKEEP_INTERVAL_MS: string | number | boolean | null

Sets the interval at which connection upkeep are performed.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_UPKEEP_INTERVAL_MS.html

Optional UPLOAD

UPLOAD: string | number | boolean | null

Upload data.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_UPLOAD.html

Optional UPLOAD_BUFFERSIZE

UPLOAD_BUFFERSIZE: string | number | boolean | null

Set upload buffer size.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_UPLOAD_BUFFERSIZE.html

Optional URL

URL: string | number | boolean | null

URL to work on.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_URL.html

Optional USERAGENT

USERAGENT: string | number | boolean | null

User-Agent: header.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_USERAGENT.html

Optional USERNAME

USERNAME: string | number | boolean | null

User name.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_USERNAME.html

Optional USERPWD

USERPWD: string | number | boolean | null

User name and password.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_USERPWD.html

Optional USE_SSL

USE_SSL: CurlUseSsl | null

Use TLS/SSL.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_USE_SSL.html

Optional VERBOSE

VERBOSE: string | number | boolean | null

Display verbose information.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_VERBOSE.html

Optional WILDCARDMATCH

WILDCARDMATCH: string | number | boolean | null

Transfer multiple files according to a file name pattern.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_WILDCARDMATCH.html

Optional WRITEFUNCTION

WRITEFUNCTION: ((this: EasyNativeBinding, data: Buffer, size: number, nmemb: number) => number) | null

Callback for writing data.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_WRITEFUNCTION.html

Optional XFERINFOFUNCTION

XFERINFOFUNCTION: ((this: EasyNativeBinding, dltotal: number, dlnow: number, ultotal: number, ulnow: number) => number | CurlProgressFunc) | null

Callback for progress meter.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_XFERINFOFUNCTION.html

Optional XOAUTH2_BEARER

XOAUTH2_BEARER: string | number | boolean | null

OAuth2 bearer token.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_XOAUTH2_BEARER.html

Optional abstractUnixSocket

abstractUnixSocket: string | number | boolean | null

Path to an abstract Unix domain socket.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_ABSTRACT_UNIX_SOCKET.html

Optional acceptEncoding

acceptEncoding: string | number | boolean | null

Accept-Encoding and automatic decompressing data.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_ACCEPT_ENCODING.html

Optional acceptTimeoutMs

acceptTimeoutMs: string | number | boolean | null

Timeout for waiting for the server's connect back to be accepted.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_ACCEPTTIMEOUT_MS.html

Optional addressScope

addressScope: string | number | boolean | null

IPv6 scope for local addresses.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_ADDRESS_SCOPE.html

Optional altSvc

altSvc: string | number | boolean | null

Specify the Alt-Svc: cache file name.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_ALTSVC.html

Optional altSvcCtrl

altSvcCtrl: string | number | boolean | null

Enable and configure Alt-Svc: treatment.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_ALTSVC_CTRL.html

Optional append

append: string | number | boolean | null

Append to remote file.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_APPEND.html

Optional autoReferer

autoReferer: string | number | boolean | null

Automatically set Referer: header.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_AUTOREFERER.html

Optional awsSigV4

awsSigV4: string | number | boolean | null

AWS HTTP V4 Signature.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_AWS_SIGV4.html

Optional bufferSize

bufferSize: string | number | boolean | null

Ask for alternate buffer size.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_BUFFERSIZE.html

Optional caInfo

caInfo: string | number | boolean | null

CA cert bundle.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CAINFO.html

Optional caInfoBlob

caInfoBlob: ArrayBuffer | Buffer | string | null

CA cert bundle memory buffer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CAINFO_BLOB.html

Optional caPath

caPath: string | number | boolean | null

Path to CA cert bundle.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CAPATH.html

Optional certInfo

certInfo: string | number | boolean | null

Extract certificate info.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CERTINFO.html

Optional chunkBgnFunction

chunkBgnFunction: ((this: EasyNativeBinding, fileInfo: FileInfo, remains: number) => CurlChunk) | null

Callback for wildcard download start of chunk.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CHUNK_BGN_FUNCTION.html

Optional chunkEndFunction

chunkEndFunction: ((this: EasyNativeBinding) => CurlChunk) | null

Callback for wildcard download end of chunk.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CHUNK_END_FUNCTION.html

Optional connectOnly

connectOnly: string | number | boolean | null

Only connect, nothing else.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CONNECT_ONLY.html

Optional connectTimeout

connectTimeout: string | number | boolean | null

Timeout for the connection phase.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CONNECTTIMEOUT.html

Optional connectTimeoutMs

connectTimeoutMs: string | number | boolean | null

Millisecond timeout for the connection phase.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CONNECTTIMEOUT_MS.html

Optional connectTo

connectTo: string[] | null

Connect to a specific host and port.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CONNECT_TO.html

Optional cookie

cookie: string | number | boolean | null

Cookie(s) to send.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_COOKIE.html

Optional cookieFile

cookieFile: string | number | boolean | null

File to read cookies from.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_COOKIEFILE.html

Optional cookieJar

cookieJar: string | number | boolean | null

File to write cookies to.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_COOKIEJAR.html

Optional cookieList

cookieList: string | number | boolean | null

Add or control cookies.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_COOKIELIST.html

Optional cookieSession

cookieSession: string | number | boolean | null

Start a new cookie session.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_COOKIESESSION.html

Optional crlFile

crlFile: string | number | boolean | null

Certificate Revocation List.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CRLFILE.html

Optional crlf

crlf: string | number | boolean | null

Convert newlines.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CRLF.html

Optional curlyBaseUrl

curlyBaseUrl: undefined | string

If set, this value will always prefix the URL of the request.

No special handling is done, so make sure you set the url correctly later on.

Optional curlyLowerCaseHeaders

curlyLowerCaseHeaders: undefined | false | true

If true, curly will lower case all headers before returning then.

By default this is false.

Optional curlyProgressCallback

curlyProgressCallback: CurlOptionValueType["xferInfoFunction"]

Set this to a callback function that should be used as the progress callback.

This is the only reliable way to set the progress callback.

remarks

This basically calls one of the following methods, depending on if any of the streams feature is being used or not:

  • If using streams: {@link "Curl".Curl.setStreamProgressCallback | Curl#setStreamProgressCallback}
  • else: {@link "Curl".Curl.setProgressCallback | Curl#setProgressCallback}

Optional curlyResponseBodyParser

curlyResponseBodyParser: CurlyResponseBodyParser | false

If set to a function this will always be called for all requests, ignoring other response body parsers.

This can also be set to false, which will disable the response parsing and will make the raw Buffer of the response to be returned.

Optional curlyResponseBodyParsers

curlyResponseBodyParsers: CurlyResponseBodyParsersProperty

Add more response body parsers, or overwrite existing ones.

This object is merged with the curly.defaultResponseBodyParsers

Optional curlyStreamResponse

curlyStreamResponse: undefined | false | true

If true, curly will return the response data as a stream.

The curly call will resolve as soon as the stream is available.

When using this option, if an error is thrown in the internal {@link "Curl".Curl | Curl} instance after the curly call has been resolved (it resolves as soon as the stream is available) it will cause the error event to be emitted on the stream itself, this way it's possible to handle these too, if necessary. The error object will have the property isCurlError set to true.

Calling destroy() on the stream will always cause the Curl instance to emit the error event. Even if an error argument was not supplied to stream.destroy().

By default this is false.

remarks

Make sure your libcurl version is greater than or equal 7.69.1. Versions older than that one are not reliable for streams usage.

This basically enables the CurlFeature.StreamResponse feature flag in the internal {@link "Curl".Curl | Curl} instance.

Optional curlyStreamResponseHighWaterMark

curlyStreamResponseHighWaterMark: undefined | number

This will set the hightWaterMark option in the response stream, if curlyStreamResponse is true.

remarks

This basically calls {@link "Curl".Curl.setStreamResponseHighWaterMark | Curl#setStreamResponseHighWaterMark} method in the internal {@link "Curl".Curl | Curl} instance.

Optional curlyStreamUpload

curlyStreamUpload: Readable | null

If set, the contents of this stream will be uploaded to the server.

Keep in mind that if you set this option you SHOULD not set progressFunction or xferInfoFunction, as these are used internally.

If you need to set a progress callback, use the curlyProgressCallback option.

If the stream set here is destroyed before libcurl finishes uploading it, the error Curl upload stream was unexpectedly destroyed (Code 42) will be emitted in the internal {@link "Curl".Curl | Curl} instance, and so will cause the curly call to be rejected with that error.

If the stream was destroyed with a specific error, this error will be passed instead.

By default this is not set.

remarks

Make sure your libcurl version is greater than or equal 7.69.1. Versions older than that one are not reliable for streams usage.

This basically calls {@link "Curl".Curl.setUploadStream | Curl#setUploadStream} method in the internal {@link "Curl".Curl | Curl} instance.

Optional customRequest

customRequest: string | number | boolean | null

Custom request/method.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_CUSTOMREQUEST.html

Optional debugFunction

debugFunction: ((this: EasyNativeBinding, type: CurlInfoDebug, data: Buffer) => 0) | null

Callback for debug information.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DEBUGFUNCTION.html

Optional defaultProtocol

defaultProtocol: string | number | boolean | null

Default protocol.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DEFAULT_PROTOCOL.html

Optional dirListOnly

dirListOnly: string | number | boolean | null

List only.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DIRLISTONLY.html

Optional disallowUsernameInUrl

disallowUsernameInUrl: string | number | boolean | null

Do not allow username in URL.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DISALLOW_USERNAME_IN_URL.html

Optional dnsCacheTimeout

dnsCacheTimeout: string | number | boolean | null

Timeout for DNS cache.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DNS_CACHE_TIMEOUT.html

Optional dnsInterface

dnsInterface: string | number | boolean | null

Bind name resolves to this interface.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DNS_INTERFACE.html

Optional dnsLocalIp4

dnsLocalIp4: string | number | boolean | null

Bind name resolves to this IP4 address.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DNS_LOCAL_IP4.html

Optional dnsLocalIp6

dnsLocalIp6: string | number | boolean | null

Bind name resolves to this IP6 address.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DNS_LOCAL_IP6.html

Optional dnsServers

dnsServers: string | number | boolean | null

Preferred DNS servers.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DNS_SERVERS.html

Optional dnsShuffleAddresses

dnsShuffleAddresses: string | number | boolean | null

Shuffle addresses before use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DNS_SHUFFLE_ADDRESSES.html

Optional dnsUseGlobalCache

dnsUseGlobalCache: string | number | boolean | null

OBSOLETE Enable global DNS cache.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DNS_USE_GLOBAL_CACHE.html

Optional dohSslVerifyHost

dohSslVerifyHost: string | number | boolean | null

Verify the host name in the DoH (DNS-over-HTTPS) SSL certificate.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DOH_SSL_VERIFYHOST.html

Optional dohSslVerifyPeer

dohSslVerifyPeer: string | number | boolean | null

Verify the DoH (DNS-over-HTTPS) SSL certificate.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DOH_SSL_VERIFYPEER.html

Optional dohSslVerifyStatus

dohSslVerifyStatus: string | number | boolean | null

Verify the DoH (DNS-over-HTTPS) SSL certificate's status.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DOH_SSL_VERIFYSTATUS.html

Optional dohUrl

dohUrl: string | number | boolean | null

Use this DoH server for name resolves.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_DOH_URL.html

Optional egdSocket

egdSocket: string | number | boolean | null

OBSOLETE Identify EGD socket for entropy.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_EGDSOCKET.html

Optional expect100TimeoutMs

expect100TimeoutMs: string | number | boolean | null

100-continue timeout.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_EXPECT_100_TIMEOUT_MS.html

Optional failOnError

failOnError: string | number | boolean | null

Fail on HTTP 4xx errors.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FAILONERROR.html

Optional fileTime

fileTime: string | number | boolean | null

Request file modification date and time.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FILETIME.html

Optional fnMatchFunction

fnMatchFunction: ((this: EasyNativeBinding, pattern: string, value: string) => CurlFnMatchFunc) | null

Callback for wildcard matching.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FNMATCH_FUNCTION.html

Optional followLocation

followLocation: string | number | boolean | null

Follow HTTP redirects.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FOLLOWLOCATION.html

Optional forbIdReuse

forbIdReuse: string | number | boolean | null

Prevent subsequent connections from re-using this.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FORBID_REUSE.html

Optional freshConnect

freshConnect: string | number | boolean | null

Use a new connection.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FRESH_CONNECT.html

Optional ftpAccount

ftpAccount: string | number | boolean | null

Send ACCT command.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTP_ACCOUNT.html

Optional ftpAlternativeToUser

ftpAlternativeToUser: string | number | boolean | null

Alternative to USER.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTP_ALTERNATIVE_TO_USER.html

Optional ftpCreateMissingDirs

ftpCreateMissingDirs: string | number | boolean | null

Create missing directories on the remote server.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTP_CREATE_MISSING_DIRS.html

Optional ftpFileMethod

ftpFileMethod: CurlFtpMethod | null

Specify how to reach files.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTP_FILEMETHOD.html

Optional ftpPort

ftpPort: string | number | boolean | null

Use active FTP.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTPPORT.html

Optional ftpSkipPasvIp

ftpSkipPasvIp: string | number | boolean | null

Ignore the IP address in the PASV response.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTP_SKIP_PASV_IP.html

Optional ftpSslAuth

ftpSslAuth: string | number | boolean | null

Control how to do TLS.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTPSSLAUTH.html

Optional ftpSslCcc

ftpSslCcc: CurlFtpSsl | null

Back to non-TLS again after authentication.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTP_SSL_CCC.html

Optional ftpUseEprt

ftpUseEprt: string | number | boolean | null

Use EPRT.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTP_USE_EPRT.html

Optional ftpUseEpsv

ftpUseEpsv: string | number | boolean | null

Use EPSV.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTP_USE_EPSV.html

Optional ftpUsePret

ftpUsePret: string | number | boolean | null

Use PRET.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_FTP_USE_PRET.html

Optional gssapiDelegation

gssapiDelegation: CurlGssApi | null

Disable GSS-API delegation.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_GSSAPI_DELEGATION.html

Optional haProxyProtocol

haProxyProtocol: string | number | boolean | null

Send an HAProxy PROXY protocol v1 header.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HAPROXYPROTOCOL.html

Optional happyEyeballsTimeoutMs

happyEyeballsTimeoutMs: string | number | boolean | null

Timeout for happy eyeballs.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS.html

Optional header

header: string | number | boolean | null

Include the header in the body output.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HEADER.html

Optional headerFunction

headerFunction: ((this: EasyNativeBinding, data: Buffer, size: number, nmemb: number) => number) | null

Callback for writing received headers.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HEADERFUNCTION.html

Optional headerOpt

headerOpt: CurlHeader | null

Control custom headers.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HEADEROPT.html

Optional hsts

hsts: string | number | boolean | null

Set HSTS cache file.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HSTS.html

Optional hstsCtrl

hstsCtrl: CurlHsts | null

Enable HSTS.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HSTS_CTRL.html

Optional hstsReadFunction

hstsReadFunction: ((this: EasyNativeBinding) => null | CurlHstsCacheEntry | CurlHstsCacheEntry[]) | null

Set HSTS read callback.

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: : https://curl.haxx.se/libcurl/c/CURLOPT_HSTSREADFUNCTION.html

Optional hstsWriteFunction

hstsWriteFunction: ((this: EasyNativeBinding, cacheEntry: CurlHstsCacheEntry, cacheCount: CurlHstsCacheCount) => any) | null

Set HSTS write callback.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HSTSWRITEFUNCTION.html

Optional http09Allowed

http09Allowed: string | number | boolean | null

Allow HTTP/0.9 responses.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTP09_ALLOWED.html

Optional http200aliases

http200aliases: string[] | null

Alternative versions of 200 OK.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTP200ALIASES.html

Optional httpAuth

httpAuth: string | number | boolean | null

HTTP server authentication methods.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTPAUTH.html

Optional httpContentDecoding

httpContentDecoding: string | number | boolean | null

Disable Content decoding.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTP_CONTENT_DECODING.html

Optional httpGet

httpGet: string | number | boolean | null

Do an HTTP GET request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTPGET.html

Optional httpHeader

httpHeader: string[] | null

Custom HTTP headers.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTPHEADER.html

Optional httpPost

httpPost: HttpPostField[] | null

Deprecated option Multipart formpost HTTP POST.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTPPOST.html

Optional httpProxyTunnel

httpProxyTunnel: string | number | boolean | null

Tunnel through the HTTP proxy.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTPPROXYTUNNEL.html

Optional httpTransferDecoding

httpTransferDecoding: string | number | boolean | null

Disable Transfer decoding.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTP_TRANSFER_DECODING.html

Optional httpVersion

httpVersion: CurlHttpVersion | null

HTTP version to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_HTTP_VERSION.html

Optional ignoreContentLength

ignoreContentLength: string | number | boolean | null

Ignore Content-Length.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_IGNORE_CONTENT_LENGTH.html

Optional inFileSize

inFileSize: string | number | boolean | null

Size of file to send.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_INFILESIZE.html

Optional inFileSizeLarge

inFileSizeLarge: string | number | boolean | null

Size of file to send.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_INFILESIZE_LARGE.html

Optional interface

interface: string | number | boolean | null

Bind connection locally to this.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_INTERFACE.html

Optional ipResolve

ipResolve: CurlIpResolve | null

IP version to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_IPRESOLVE.html

Optional issuerCert

issuerCert: string | number | boolean | null

Issuer certificate.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_ISSUERCERT.html

Optional issuerCertBlob

issuerCertBlob: ArrayBuffer | Buffer | string | null

Issuer certificate memory buffer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_ISSUERCERT_BLOB.html

Optional keepSendingOnError

keepSendingOnError: string | number | boolean | null

Keep sending on HTTP >= 300 errors.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_KEEP_SENDING_ON_ERROR.html

Optional keyPasswd

keyPasswd: string | number | boolean | null

Client key password.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_KEYPASSWD.html

Optional krbLevel

krbLevel: string | number | boolean | null

Kerberos security level.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_KRBLEVEL.html

Optional localPort

localPort: string | number | boolean | null

Bind connection locally to this port.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_LOCALPORT.html

Optional localPortRange

localPortRange: string | number | boolean | null

Bind connection locally to port range.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_LOCALPORTRANGE.html

Optional loginOptions

loginOptions: string | number | boolean | null

Login options.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_LOGIN_OPTIONS.html

Optional lowSpeedLimit

lowSpeedLimit: string | number | boolean | null

Low speed limit to abort transfer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_LOW_SPEED_LIMIT.html

Optional lowSpeedTime

lowSpeedTime: string | number | boolean | null

Time to be below the speed to trigger low speed abort.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_LOW_SPEED_TIME.html

Optional mailAuth

mailAuth: string | number | boolean | null

Authentication address.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAIL_AUTH.html

Optional mailFrom

mailFrom: string | number | boolean | null

Address of the sender.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAIL_FROM.html

Optional mailRcpt

mailRcpt: string[] | null

Address of the recipients.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAIL_RCPT.html

Optional mailRcptAlllowfails

mailRcptAlllowfails: string | number | boolean | null

Allow RCPT TO command to fail for some recipients.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAIL_RCPT_ALLLOWFAILS.html

Optional maxAgeConn

maxAgeConn: string | number | boolean | null

Limit the age (idle time) of connections for reuse.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAXAGE_CONN.html

Optional maxConnects

maxConnects: string | number | boolean | null

Maximum number of connections in the connection pool.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAXCONNECTS.html

Optional maxFileSize

maxFileSize: string | number | boolean | null

Maximum file size to get.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAXFILESIZE.html

Optional maxFileSizeLarge

maxFileSizeLarge: string | number | boolean | null

Maximum file size to get.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAXFILESIZE_LARGE.html

Optional maxLifetimeConn

maxLifetimeConn: string | number | boolean | null

Limit the age (since creation) of connections for reuse.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAXLIFETIME_CONN.html

Optional maxRecvSpeedLarge

maxRecvSpeedLarge: string | number | boolean | null

Cap the download speed to this.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAX_RECV_SPEED_LARGE.html

Optional maxRedirs

maxRedirs: string | number | boolean | null

Maximum number of redirects to follow.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAXREDIRS.html

Optional maxSendSpeedLarge

maxSendSpeedLarge: string | number | boolean | null

Cap the upload speed to this.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_MAX_SEND_SPEED_LARGE.html

Optional netrc

netrc: CurlNetrc | null

Enable .netrc parsing.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_NETRC.html

Optional netrcFile

netrcFile: string | number | boolean | null

.netrc file name.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_NETRC_FILE.html

Optional newDirectoryPerms

newDirectoryPerms: string | number | boolean | null

Mode for creating new remote directories.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_NEW_DIRECTORY_PERMS.html

Optional newFilePerms

newFilePerms: string | number | boolean | null

Mode for creating new remote files.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_NEW_FILE_PERMS.html

Optional noProgress

noProgress: string | number | boolean | null

Shut off the progress meter.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_NOPROGRESS.html

Optional noProxy

noProxy: string | number | boolean | null

Filter out hosts from proxy use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_NOPROXY.html

Optional noSignal

noSignal: string | number | boolean | null

Do not install signal handlers.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_NOSIGNAL.html

Optional nobody

nobody: string | number | boolean | null

Do not get the body contents.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_NOBODY.html

Optional password

password: string | number | boolean | null

Password.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PASSWORD.html

Optional pathAsIs

pathAsIs: string | number | boolean | null

Disable squashing /../ and /./ sequences in the path.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PATH_AS_IS.html

Optional pinnedPublicKey

pinnedPublicKey: string | number | boolean | null

Set pinned SSL public key .

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PINNEDPUBLICKEY.html

Optional pipeWait

pipeWait: string | number | boolean | null

Wait on connection to pipeline on it.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PIPEWAIT.html

Optional port

port: string | number | boolean | null

Port number to connect to.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PORT.html

Optional post

post: string | number | boolean | null

Issue an HTTP POST request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_POST.html

Optional postFieldSize

postFieldSize: string | number | boolean | null

The POST data is this big.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_POSTFIELDSIZE.html

Optional postFieldSizeLarge

postFieldSizeLarge: string | number | boolean | null

The POST data is this big.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_POSTFIELDSIZE_LARGE.html

Optional postFields

postFields: string | number | boolean | null

Send a POST with this data.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_POSTFIELDS.html

Optional postQuote

postQuote: string[] | null

Commands to run after transfer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_POSTQUOTE.html

Optional postRedir

postRedir: string | number | boolean | null

How to act on redirects after POST.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_POSTREDIR.html

Optional preProxy

preProxy: string | number | boolean | null

Socks proxy to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PRE_PROXY.html

Optional preQuote

preQuote: string[] | null

Commands to run just before transfer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PREQUOTE.html

Optional preReqFunction

preReqFunction: ((this: EasyNativeBinding, connPrimaryIp: string, connLocalIp: string, connPrimaryPort: number, conLocalPort: number) => CurlPreReqFunc) | null

Callback to be called after a connection is established but before a request is made on that connection.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PREREQFUNCTION.html

Optional progressFunction

progressFunction: ((this: EasyNativeBinding, dltotal: number, dlnow: number, ultotal: number, ulnow: number) => number | CurlProgressFunc) | null

OBSOLETE callback for progress meter.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROGRESSFUNCTION.html

Optional protocols

protocols: CurlProtocol | null

Deprecated option Allowed protocols.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROTOCOLS.html

Optional protocolsStr

protocolsStr: string | number | boolean | null

Allowed protocols.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROTOCOLS_STR.html

Optional proxy

proxy: string | number | boolean | null

Proxy to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html

Optional proxyAuth

proxyAuth: string | number | boolean | null

HTTP proxy authentication methods.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXYAUTH.html

Optional proxyCaInfo

proxyCaInfo: string | number | boolean | null

Proxy CA cert bundle.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_CAINFO.html

Optional proxyCaInfoBlob

proxyCaInfoBlob: ArrayBuffer | Buffer | string | null

Proxy CA cert bundle memory buffer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_CAINFO_BLOB.html

Optional proxyCaPath

proxyCaPath: string | number | boolean | null

Path to proxy CA cert bundle.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_CAPATH.html

Optional proxyCrlFile

proxyCrlFile: string | number | boolean | null

Proxy Certificate Revocation List.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_CRLFILE.html

Optional proxyHeader

proxyHeader: string[] | null

Custom HTTP headers sent to proxy.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXYHEADER.html

Optional proxyIssuerCert

proxyIssuerCert: string | number | boolean | null

Proxy issuer certificate.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_ISSUERCERT.html

Optional proxyIssuerCertBlob

proxyIssuerCertBlob: string | number | boolean | null

Proxy issuer certificate memory buffer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_ISSUERCERT_BLOB.html

Optional proxyKeyPasswd

proxyKeyPasswd: string | number | boolean | null

Proxy client key password.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_KEYPASSWD.html

Optional proxyPassword

proxyPassword: string | number | boolean | null

Proxy password.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXYPASSWORD.html

Optional proxyPinnedPublicKey

proxyPinnedPublicKey: string | number | boolean | null

Set the proxy's pinned SSL public key.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_PINNEDPUBLICKEY.html

Optional proxyPort

proxyPort: string | number | boolean | null

Proxy port to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXYPORT.html

Optional proxyServiceName

proxyServiceName: string | number | boolean | null

Proxy authentication service name.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SERVICE_NAME.html

Optional proxySslCert

proxySslCert: ArrayBuffer | Buffer | string | null

Proxy client cert.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSLCERT.html

Optional proxySslCertBlob

proxySslCertBlob: ArrayBuffer | Buffer | string | null

Proxy client cert memory buffer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSLCERT_BLOB.html

Optional proxySslCertType

proxySslCertType: string | number | boolean | null

Proxy client cert type.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSLCERTTYPE.html

Optional proxySslCipherList

proxySslCipherList: string | number | boolean | null

Proxy ciphers to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSL_CIPHER_LIST.html

Optional proxySslKey

proxySslKey: string | number | boolean | null

Proxy client key.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSLKEY.html

Optional proxySslKeyBlob

proxySslKeyBlob: ArrayBuffer | Buffer | string | null

Proxy client key.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSLKEY_BLOB.html

Optional proxySslKeyType

proxySslKeyType: string | number | boolean | null

Proxy client key type.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSLKEYTYPE.html

Optional proxySslOptions

proxySslOptions: CurlSslOpt | null

Control proxy SSL behavior.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSL_OPTIONS.html

Optional proxySslVerifyHost

proxySslVerifyHost: string | number | boolean | null

Verify the host name in the proxy SSL certificate.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSL_VERIFYHOST.html

Optional proxySslVerifyPeer

proxySslVerifyPeer: string | number | boolean | null

Verify the proxy SSL certificate.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSL_VERIFYPEER.html

Optional proxySslversion

proxySslversion: string | number | boolean | null

Proxy SSL version to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_SSLVERSION.html

Optional proxyTls13Ciphers

proxyTls13Ciphers: string | number | boolean | null

Proxy TLS 1.3 cipher suites to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_TLS13_CIPHERS.html

Optional proxyTlsAuthPassword

proxyTlsAuthPassword: string | number | boolean | null

Proxy TLS authentication password.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_TLSAUTH_PASSWORD.html

Optional proxyTlsAuthType

proxyTlsAuthType: string | number | boolean | null

Proxy TLS authentication methods.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_TLSAUTH_TYPE.html

Optional proxyTlsAuthUsername

proxyTlsAuthUsername: string | number | boolean | null

Proxy TLS authentication user name.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_TLSAUTH_USERNAME.html

Optional proxyTransferMode

proxyTransferMode: string | number | boolean | null

Add transfer mode to URL over proxy.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXY_TRANSFER_MODE.html

Optional proxyType

proxyType: CurlProxy | null

Proxy type.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXYTYPE.html

Optional proxyUsername

proxyUsername: string | number | boolean | null

Proxy user name.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXYUSERNAME.html

Optional proxyUserpwd

proxyUserpwd: string | number | boolean | null

Proxy user name and password.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PROXYUSERPWD.html

Optional put

put: string | number | boolean | null

Deprecated option Issue an HTTP PUT request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_PUT.html

Optional quote

quote: string[] | null

Commands to run before transfer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_QUOTE.html

Optional randomFile

randomFile: string | number | boolean | null

OBSOLETE Provide source for entropy random data.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RANDOM_FILE.html

Optional range

range: string | number | boolean | null

Range requests.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RANGE.html

Optional readData

readData: string | number | boolean | null

Data pointer to pass to the read callback.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_READDATA.html

Optional readFunction

readFunction: ((this: EasyNativeBinding, data: Buffer, size: number, nmemb: number) => number) | null

Callback for reading data.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_READFUNCTION.html

Optional redirProtocols

redirProtocols: CurlProtocol | null

Deprecated option Protocols to allow redirects to.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_REDIR_PROTOCOLS.html

Optional redirProtocolsStr

redirProtocolsStr: string | number | boolean | null

Protocols to allow redirects to.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_REDIR_PROTOCOLS_STR.html

Optional referer

referer: string | number | boolean | null

Referer: header.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_REFERER.html

Optional requestTarget

requestTarget: string | number | boolean | null

Set the request target.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_REQUEST_TARGET.html

Optional resolve

resolve: string[] | null

Provide fixed/fake name resolves.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RESOLVE.html

Optional resumeFrom

resumeFrom: string | number | boolean | null

Resume a transfer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RESUME_FROM.html

Optional resumeFromLarge

resumeFromLarge: string | number | boolean | null

Resume a transfer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RESUME_FROM_LARGE.html

Optional rtspClientCseq

rtspClientCseq: string | number | boolean | null

Client CSEQ number.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RTSP_CLIENT_CSEQ.html

Optional rtspRequest

rtspRequest: CurlRtspRequest | null

RTSP request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RTSP_REQUEST.html

Optional rtspServerCseq

rtspServerCseq: string | number | boolean | null

CSEQ number for RTSP Server->Client request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RTSP_SERVER_CSEQ.html

Optional rtspSessionId

rtspSessionId: string | number | boolean | null

RTSP session-id.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RTSP_SESSION_ID.html

Optional rtspStreamUri

rtspStreamUri: string | number | boolean | null

RTSP stream URI.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RTSP_STREAM_URI.html

Optional rtspTransPort

rtspTransPort: string | number | boolean | null

RTSP Transport: header.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_RTSP_TRANSPORT.html

Optional saslAuthzId

saslAuthzId: string | number | boolean | null

SASL authorization identity (identity to act as).

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SASL_AUTHZID.html

Optional saslIr

saslIr: string | number | boolean | null

Enable SASL initial response.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SASL_IR.html

Optional seekFunction

seekFunction: ((this: EasyNativeBinding, offset: number, origin: number) => number) | null

Callback for seek operations.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SEEKFUNCTION.html

Optional serverResponseTimeout

serverResponseTimeout: string | number | boolean | null

Timeout for server responses.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SERVER_RESPONSE_TIMEOUT.html

Optional serviceName

serviceName: string | number | boolean | null

Authentication service name.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SERVICE_NAME.html

Optional share

share: Share | null

Share object to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SHARE.html

Optional socks5Auth

socks5Auth: string | number | boolean | null

Socks5 authentication methods.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SOCKS5_AUTH.html

Optional socks5GssapiNec

socks5GssapiNec: string | number | boolean | null

Socks5 GSSAPI NEC mode.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SOCKS5_GSSAPI_NEC.html

Optional socks5GssapiService

socks5GssapiService: string | number | boolean | null

Deprecated option Socks5 GSSAPI service name.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SOCKS5_GSSAPI_SERVICE.html

Optional sshAuthTypes

sshAuthTypes: CurlSshAuth | null

SSH authentication types.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSH_AUTH_TYPES.html

Optional sshCompression

sshCompression: string | number | boolean | null

Enable SSH compression.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSH_COMPRESSION.html

Optional sshHostKeyData

sshHostKeyData: string | number | boolean | null

Custom pointer to pass to ssh host key callback.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSH_HOSTKEYDATA.html

Optional sshHostPublicKeyMd5

sshHostPublicKeyMd5: string | number | boolean | null

MD5 of host's public key.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSH_HOST_PUBLIC_KEY_MD5.html

Optional sshKnownHosts

sshKnownHosts: string | number | boolean | null

File name with known hosts.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSH_KNOWNHOSTS.html

Optional sshPrivateKeyFile

sshPrivateKeyFile: string | number | boolean | null

File name of private key.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSH_PRIVATE_KEYFILE.html

Optional sshPublicKeyFile

sshPublicKeyFile: string | number | boolean | null

File name of public key.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSH_PUBLIC_KEYFILE.html

Optional sslCert

sslCert: string | number | boolean | null

Client cert.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSLCERT.html

Optional sslCertBlob

sslCertBlob: ArrayBuffer | Buffer | string | null

Client cert memory buffer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSLCERT_BLOB.html

Optional sslCertType

sslCertType: string | number | boolean | null

Client cert type.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSLCERTTYPE.html

Optional sslCipherList

sslCipherList: string | number | boolean | null

Ciphers to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_CIPHER_LIST.html

Optional sslEcCurves

sslEcCurves: string | number | boolean | null

Set key exchange curves.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_EC_CURVES.html

Optional sslEnableAlpn

sslEnableAlpn: string | number | boolean | null

Enable use of ALPN.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_ENABLE_ALPN.html

Optional sslEnableNpn

sslEnableNpn: string | number | boolean | null

OBSOLETE Enable use of NPN.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_ENABLE_NPN.html

Optional sslEngine

sslEngine: string | number | boolean | null

Use identifier with SSL engine.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSLENGINE.html

Optional sslEngineDefault

sslEngineDefault: string | number | boolean | null

Default SSL engine.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSLENGINE_DEFAULT.html

Optional sslFalsestart

sslFalsestart: string | number | boolean | null

Enable TLS False Start.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_FALSESTART.html

Optional sslKey

sslKey: string | number | boolean | null

Client key.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSLKEY.html

Optional sslKeyBlob

sslKeyBlob: ArrayBuffer | Buffer | string | null

Client key memory buffer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSLKEY_BLOB.html

Optional sslKeyType

sslKeyType: string | number | boolean | null

Client key type.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSLKEYTYPE.html

Optional sslOptions

sslOptions: CurlSslOpt | null

Control SSL behavior.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_OPTIONS.html

Optional sslSessionIdCache

sslSessionIdCache: string | number | boolean | null

Disable SSL session-id cache.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_SESSIONID_CACHE.html

Optional sslVerifyHost

sslVerifyHost: string | number | boolean | null

Verify the host name in the SSL certificate.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYHOST.html

Optional sslVerifyPeer

sslVerifyPeer: string | number | boolean | null

Verify the SSL certificate.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYPEER.html

Optional sslVerifyStatus

sslVerifyStatus: string | number | boolean | null

Verify the SSL certificate's status.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYSTATUS.html

Optional sslversion

sslversion: CurlSslVersion | null

SSL version to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SSLVERSION.html

Optional suppressConnectHeaders

suppressConnectHeaders: string | number | boolean | null

Suppress proxy CONNECT response headers from user callbacks.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_SUPPRESS_CONNECT_HEADERS.html

Optional tcpFastOpen

tcpFastOpen: string | number | boolean | null

Enable TCP Fast Open.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TCP_FASTOPEN.html

Optional tcpKeepAlive

tcpKeepAlive: string | number | boolean | null

Enable TCP keep-alive.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TCP_KEEPALIVE.html

Optional tcpKeepIdle

tcpKeepIdle: string | number | boolean | null

Idle time before sending keep-alive.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TCP_KEEPIDLE.html

Optional tcpKeepIntvl

tcpKeepIntvl: string | number | boolean | null

Interval between keep-alive probes.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TCP_KEEPINTVL.html

Optional tcpNoDelay

tcpNoDelay: string | number | boolean | null

Disable the Nagle algorithm.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TCP_NODELAY.html

Optional telnetOptions

telnetOptions: string[] | null

TELNET options.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TELNETOPTIONS.html

Optional tftpBlkSize

tftpBlkSize: string | number | boolean | null

TFTP block size.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TFTP_BLKSIZE.html

Optional tftpNoOptions

tftpNoOptions: string | number | boolean | null

Do not send TFTP options requests.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TFTP_NO_OPTIONS.html

Optional timeCondition

timeCondition: CurlTimeCond | null

Make a time conditional request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TIMECONDITION.html

Optional timeValue

timeValue: string | number | boolean | null

Time value for the time conditional request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TIMEVALUE.html

Optional timeValueLarge

timeValueLarge: string | number | boolean | null

Time value for the time conditional request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TIMEVALUE_LARGE.html

Optional timeout

timeout: string | number | boolean | null

Timeout for the entire request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TIMEOUT.html

Optional timeoutMs

timeoutMs: string | number | boolean | null

Millisecond timeout for the entire request.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TIMEOUT_MS.html

Optional tls13Ciphers

tls13Ciphers: string | number | boolean | null

TLS 1.3 cipher suites to use.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TLS13_CIPHERS.html

Optional tlsAuthPassword

tlsAuthPassword: string | number | boolean | null

TLS authentication password.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TLSAUTH_PASSWORD.html

Optional tlsAuthType

tlsAuthType: string | number | boolean | null

TLS authentication methods.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TLSAUTH_TYPE.html

Optional tlsAuthUsername

tlsAuthUsername: string | number | boolean | null

TLS authentication user name.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TLSAUTH_USERNAME.html

Optional trailerFunction

trailerFunction: ((this: EasyNativeBinding) => string[] | false) | null

Set callback for sending trailing headers.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TRAILERFUNCTION.html

Optional transferEncoding

transferEncoding: string | number | boolean | null

Request Transfer-Encoding.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TRANSFER_ENCODING.html

Optional transferText

transferText: string | number | boolean | null

Use text transfer.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_TRANSFERTEXT.html

Optional unixSocketPath

unixSocketPath: string | number | boolean | null

Path to a Unix domain socket.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_UNIX_SOCKET_PATH.html

Optional unrestrictedAuth

unrestrictedAuth: string | number | boolean | null

Do not restrict authentication to original host.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_UNRESTRICTED_AUTH.html

Optional upkeepIntervalMs

upkeepIntervalMs: string | number | boolean | null

Sets the interval at which connection upkeep are performed.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_UPKEEP_INTERVAL_MS.html

Optional upload

upload: string | number | boolean | null

Upload data.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_UPLOAD.html

Optional uploadBufferSize

uploadBufferSize: string | number | boolean | null

Set upload buffer size.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_UPLOAD_BUFFERSIZE.html

Optional url

url: string | number | boolean | null

URL to work on.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_URL.html

Optional useSsl

useSsl: CurlUseSsl | null

Use TLS/SSL.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_USE_SSL.html

Optional userAgent

userAgent: string | number | boolean | null

User-Agent: header.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_USERAGENT.html

Optional username

username: string | number | boolean | null

User name.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_USERNAME.html

Optional userpwd

userpwd: string | number | boolean | null

User name and password.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_USERPWD.html

Optional verbose

verbose: string | number | boolean | null

Display verbose information.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_VERBOSE.html

Optional wildcardMatch

wildcardMatch: string | number | boolean | null

Transfer multiple files according to a file name pattern.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_WILDCARDMATCH.html

Optional writeFunction

writeFunction: ((this: EasyNativeBinding, data: Buffer, size: number, nmemb: number) => number) | null

Callback for writing data.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_WRITEFUNCTION.html

Optional xferInfoFunction

xferInfoFunction: ((this: EasyNativeBinding, dltotal: number, dlnow: number, ultotal: number, ulnow: number) => number | CurlProgressFunc) | null

Callback for progress meter.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_XFERINFOFUNCTION.html

Optional xoauth2Bearer

xoauth2Bearer: string | number | boolean | null

OAuth2 bearer token.

Official libcurl documentation: : https://curl.haxx.se/libcurl/c/CURLOPT_XOAUTH2_BEARER.html