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.

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

Hierarchy (View Summary, Expand)

CurlOptionValueType
- CurlyOptions

Index

Properties

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

Properties

`Optional`ABSTRACT_UNIX_SOCKET

ABSTRACT_UNIX_SOCKET?: null | string | number | boolean

Path to an abstract Unix domain socket.

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

`Optional`abstractUnixSocket

abstractUnixSocket?: null | string | number | boolean

Path to an abstract Unix domain socket.

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

`Optional`ACCEPT_ENCODING

ACCEPT_ENCODING?: null | string | number | boolean

Accept-Encoding and automatic decompressing data.

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

`Optional`acceptEncoding

acceptEncoding?: null | string | number | boolean

Accept-Encoding and automatic decompressing data.

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

`Optional`ACCEPTTIMEOUT_MS

ACCEPTTIMEOUT_MS?: null | string | number | boolean

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`acceptTimeoutMs

acceptTimeoutMs?: null | string | number | boolean

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`ADDRESS_SCOPE

ADDRESS_SCOPE?: null | string | number | boolean

IPv6 scope for local addresses.

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

`Optional`addressScope

addressScope?: null | string | number | boolean

IPv6 scope for local addresses.

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

`Optional`altSvc

altSvc?: null | string | number | boolean

Specify the Alt-Svc: cache filename.

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

`Optional`ALTSVC

ALTSVC?: null | string | number | boolean

Specify the Alt-Svc: cache filename.

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

`Optional`ALTSVC_CTRL

ALTSVC_CTRL?: null | string | number | boolean

Enable and configure Alt-Svc: treatment.

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

`Optional`altSvcCtrl

altSvcCtrl?: null | string | number | boolean

Enable and configure Alt-Svc: treatment.

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

`Optional`append

append?: null | string | number | boolean

Append to remote file.

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

`Optional`APPEND

APPEND?: null | string | number | boolean

Append to remote file.

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

`Optional`autoReferer

autoReferer?: null | string | number | boolean

Automatically set Referer: header.

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

`Optional`AUTOREFERER

AUTOREFERER?: null | string | number | boolean

Automatically set Referer: header.

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

`Optional`AWS_SIGV4

AWS_SIGV4?: null | string | number | boolean

AWS HTTP V4 Signature. See

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

`Optional`awsSigV4

awsSigV4?: null | string | number | boolean

AWS HTTP V4 Signature. See

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

`Optional`bufferSize

bufferSize?: null | string | number | boolean

Ask for alternate buffer size.

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

`Optional`BUFFERSIZE

BUFFERSIZE?: null | string | number | boolean

Ask for alternate buffer size.

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

`Optional`CA_CACHE_TIMEOUT

CA_CACHE_TIMEOUT?: null | string | number | boolean

Timeout for CA cache.

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

`Optional`caCacheTimeout

caCacheTimeout?: null | string | number | boolean

Timeout for CA cache.

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

`Optional`caInfo

caInfo?: null | string | number | boolean

CA cert bundle.

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

`Optional`CAINFO

CAINFO?: null | string | number | boolean

CA cert bundle.

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

`Optional`CAINFO_BLOB

CAINFO_BLOB?: null | string | ArrayBuffer | Buffer<ArrayBufferLike>

CA cert bundle memory buffer.

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

`Optional`caInfoBlob

caInfoBlob?: null | string | ArrayBuffer | Buffer<ArrayBufferLike>

CA cert bundle memory buffer.

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

`Optional`caPath

caPath?: null | string | number | boolean

Path to CA cert bundle.

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

`Optional`CAPATH

CAPATH?: null | string | number | boolean

Path to CA cert bundle.

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

`Optional`certInfo

certInfo?: null | string | number | boolean

Extract certificate info.

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

`Optional`CERTINFO

CERTINFO?: null | string | number | boolean

Extract certificate info.

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

`Optional`CHUNK_BGN_FUNCTION

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

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?: null | ((this: Easy) => CurlChunk)

Callback for wildcard download end of chunk.

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

`Optional`chunkBgnFunction

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

Callback for wildcard download start of chunk.

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

`Optional`chunkEndFunction

chunkEndFunction?: null | ((this: Easy) => CurlChunk)

Callback for wildcard download end of chunk.

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

`Optional`CONNECT_ONLY

CONNECT_ONLY?: null | string | number | boolean

Only connect, nothing else.

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

`Optional`CONNECT_TO

CONNECT_TO?: null | string[]

Connect to a specific host and port.

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

`Optional`connectOnly

connectOnly?: null | string | number | boolean

Only connect, nothing else.

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

`Optional`connectTimeout

connectTimeout?: null | string | number | boolean

Timeout for the connection phase.

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

`Optional`CONNECTTIMEOUT

CONNECTTIMEOUT?: null | string | number | boolean

Timeout for the connection phase.

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

`Optional`CONNECTTIMEOUT_MS

CONNECTTIMEOUT_MS?: null | string | number | boolean

Millisecond timeout for the connection phase.

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

`Optional`connectTimeoutMs

connectTimeoutMs?: null | string | number | boolean

Millisecond timeout for the connection phase.

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

`Optional`connectTo

connectTo?: null | string[]

Connect to a specific host and port.

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

`Optional`cookie

cookie?: null | string | number | boolean

Cookie(s) to send.

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

`Optional`COOKIE

COOKIE?: null | string | number | boolean

Cookie(s) to send.

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

`Optional`cookieFile

cookieFile?: null | string | number | boolean

File to read cookies from.

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

`Optional`COOKIEFILE

COOKIEFILE?: null | string | number | boolean

File to read cookies from.

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

`Optional`cookieJar

cookieJar?: null | string | number | boolean

File to write cookies to.

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

`Optional`COOKIEJAR

COOKIEJAR?: null | string | number | boolean

File to write cookies to.

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

`Optional`cookieList

cookieList?: null | string | number | boolean

Add or control cookies.

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

`Optional`COOKIELIST

COOKIELIST?: null | string | number | boolean

Add or control cookies.

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

`Optional`cookieSession

cookieSession?: null | string | number | boolean

Start a new cookie session.

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

`Optional`COOKIESESSION

COOKIESESSION?: null | string | number | boolean

Start a new cookie session.

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

`Optional`crlf

crlf?: null | string | number | boolean

Convert newlines.

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

`Optional`CRLF

CRLF?: null | string | number | boolean

Convert newlines.

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

`Optional`crlFile

crlFile?: null | string | number | boolean

Certificate Revocation List.

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

`Optional`CRLFILE

CRLFILE?: null | string | number | boolean

Certificate Revocation List.

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

`Optional`curlyBaseUrl

curlyBaseUrl?: 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?: boolean

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

By default this is false.

`Optional`curlyMimePost

curlyMimePost?: CurlyMimePart[]

Array of MIME parts to upload as multipart/form-data.

This will automatically build a CurlMime structure internally and set it using the MIMEPOST option. For stream-based parts, the unpause callback is automatically generated, so you don't need to provide it.

Remarks

Requires libcurl 7.56.0 or later.

Example

Basic multipart upload:

await curly.post('https://httpbin.org/post', {
  curlyMimePost: [
    { type: 'data', name: 'username', data: 'john_doe' },
    { type: 'file', name: 'avatar', file: '/path/to/image.png', mimeType: 'image/png' }
  ]
})

Example

With streams:

import { createReadStream } from 'fs'

await curly.post('https://httpbin.org/post', {
  curlyMimePost: [
    { type: 'data', name: 'field', data: 'value' },
    {
      type: 'stream',
      name: 'document',
      stream: createReadStream('/path/to/file.txt'),
      size: 12345
    }
  ]
})

See Easy.setMimePost for more details.

`Optional`curlyProgressCallback

curlyProgressCallback?:
    | null
    | (
        (
            this: Easy,
            dltotal: number,
            dlnow: number,
            ultotal: number,
            ulnow: number,
        ) => number
    )

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: Curl#setStreamProgressCallback
else: Curl#setProgressCallback

`Optional`curlyResponseBodyParser

curlyResponseBodyParser?: false | CurlyResponseBodyParser

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?: boolean

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 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 inherit from the CurlError class.

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 Curl instance.

`Optional`curlyStreamResponseHighWaterMark

curlyStreamResponseHighWaterMark?: number

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

Remarks

This basically calls Curl#setStreamResponseHighWaterMark method in the internal Curl instance.

`Optional`curlyStreamUpload

curlyStreamUpload?: null | Readable

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 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 Curl#setUploadStream method in the internal Curl instance.

`Optional`customRequest

customRequest?: null | string | number | boolean

Custom request/method.

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

`Optional`CUSTOMREQUEST

CUSTOMREQUEST?: null | string | number | boolean

Custom request/method.

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

`Optional`debugFunction

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

Callback for debug information.

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

`Optional`DEBUGFUNCTION

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

Callback for debug information.

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

`Optional`DEFAULT_PROTOCOL

DEFAULT_PROTOCOL?: null | string | number | boolean

Default protocol.

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

`Optional`defaultProtocol

defaultProtocol?: null | string | number | boolean

Default protocol.

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

`Optional`dirListOnly

dirListOnly?: null | string | number | boolean

List only.

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

`Optional`DIRLISTONLY

DIRLISTONLY?: null | string | number | boolean

List only.

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

`Optional`DISALLOW_USERNAME_IN_URL

DISALLOW_USERNAME_IN_URL?: null | string | number | boolean

Do not allow username in URL.

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

`Optional`disallowUsernameInUrl

disallowUsernameInUrl?: null | string | number | boolean

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?: null | string | number | boolean

Timeout for DNS cache.

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

`Optional`DNS_INTERFACE

DNS_INTERFACE?: null | string | number | boolean

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?: null | string | number | boolean

Bind name resolves to this IP4 address. See

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

`Optional`DNS_LOCAL_IP6

DNS_LOCAL_IP6?: null | string | number | boolean

Bind name resolves to this IP6 address. See

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

`Optional`DNS_SERVERS

DNS_SERVERS?: null | string | number | boolean

Preferred DNS servers.

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

`Optional`DNS_SHUFFLE_ADDRESSES

DNS_SHUFFLE_ADDRESSES?: null | string | number | boolean

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?: null | string | number | boolean

OBSOLETE Enable global DNS cache.

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

`Optional`dnsCacheTimeout

dnsCacheTimeout?: null | string | number | boolean

Timeout for DNS cache.

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

`Optional`dnsInterface

dnsInterface?: null | string | number | boolean

Bind name resolves to this interface.

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

`Optional`dnsLocalIp4

dnsLocalIp4?: null | string | number | boolean

Bind name resolves to this IP4 address. See

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

`Optional`dnsLocalIp6

dnsLocalIp6?: null | string | number | boolean

Bind name resolves to this IP6 address. See

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

`Optional`dnsServers

dnsServers?: null | string | number | boolean

Preferred DNS servers.

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

`Optional`dnsShuffleAddresses

dnsShuffleAddresses?: null | string | number | boolean

Shuffle addresses before use.

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

`Optional`dnsUseGlobalCache

dnsUseGlobalCache?: null | string | number | boolean

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?: null | string | number | boolean

Verify the hostname 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?: null | string | number | boolean

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?: null | string | number | boolean

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?: null | string | number | boolean

Use this DoH server for name resolves.

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

`Optional`dohSslVerifyHost

dohSslVerifyHost?: null | string | number | boolean

Verify the hostname 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?: null | string | number | boolean

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?: null | string | number | boolean

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?: null | string | number | boolean

Use this DoH server for name resolves.

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

`Optional`ech

ech?: null | string | number | boolean

Set the configuration for ECH.

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

`Optional`ECH

ECH?: null | string | number | boolean

Set the configuration for ECH.

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

`Optional`egdSocket

egdSocket?: null | string | number | boolean

OBSOLETE Identify EGD socket for entropy.

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

`Optional`EGDSOCKET

EGDSOCKET?: null | string | number | boolean

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?: null | string | number | boolean

100-continue timeout. See

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

`Optional`expect100TimeoutMs

expect100TimeoutMs?: null | string | number | boolean

100-continue timeout. See

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

`Optional`failOnError

failOnError?: null | string | number | boolean

Fail on HTTP 4xx errors.

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

`Optional`FAILONERROR

FAILONERROR?: null | string | number | boolean

Fail on HTTP 4xx errors.

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

`Optional`fileTime

fileTime?: null | string | number | boolean

Request file modification date and time.

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

`Optional`FILETIME

FILETIME?: null | string | number | boolean

Request file modification date and time.

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

`Optional`FNMATCH_FUNCTION

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

Callback for wildcard matching.

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

`Optional`fnMatchFunction

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

Callback for wildcard matching.

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

`Optional`followLocation

followLocation?: null | string | number | boolean

Follow HTTP redirects.

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

`Optional`FOLLOWLOCATION

FOLLOWLOCATION?: null | string | number | boolean

Follow HTTP redirects.

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

`Optional`FORBID_REUSE

FORBID_REUSE?: null | string | number | boolean

Prevent subsequent connections from reusing this.

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

`Optional`forbIdReuse

forbIdReuse?: null | string | number | boolean

Prevent subsequent connections from reusing this.

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

`Optional`FRESH_CONNECT

FRESH_CONNECT?: null | string | number | boolean

Use a new connection.

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

`Optional`freshConnect

freshConnect?: null | string | number | boolean

Use a new connection.

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

`Optional`FTP_ACCOUNT

FTP_ACCOUNT?: null | string | number | boolean

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?: null | string | number | boolean

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?: null | string | number | boolean

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?: null | CurlFtpMethod

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?: null | string | number | boolean

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?: null | CurlFtpSsl

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?: null | string | number | boolean

Use EPRT.

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

`Optional`FTP_USE_EPSV

FTP_USE_EPSV?: null | string | number | boolean

Use EPSV.

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

`Optional`FTP_USE_PRET

FTP_USE_PRET?: null | string | number | boolean

Use PRET.

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

`Optional`ftpAccount

ftpAccount?: null | string | number | boolean

Send ACCT command.

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

`Optional`ftpAlternativeToUser

ftpAlternativeToUser?: null | string | number | boolean

Alternative to USER.

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

`Optional`ftpCreateMissingDirs

ftpCreateMissingDirs?: null | string | number | boolean

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?: null | CurlFtpMethod

Specify how to reach files.

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

`Optional`ftpPort

ftpPort?: null | string | number | boolean

Use active FTP.

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

`Optional`FTPPORT

FTPPORT?: null | string | number | boolean

Use active FTP.

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

`Optional`ftpSkipPasvIp

ftpSkipPasvIp?: null | string | number | boolean

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?: null | string | number | boolean

Control how to do TLS.

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

`Optional`FTPSSLAUTH

FTPSSLAUTH?: null | string | number | boolean

Control how to do TLS.

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

`Optional`ftpSslCcc

ftpSslCcc?: null | CurlFtpSsl

Back to non-TLS again after authentication.

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

`Optional`ftpUseEprt

ftpUseEprt?: null | string | number | boolean

Use EPRT.

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

`Optional`ftpUseEpsv

ftpUseEpsv?: null | string | number | boolean

Use EPSV.

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

`Optional`ftpUsePret

ftpUsePret?: null | string | number | boolean

Use PRET.

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

`Optional`GSSAPI_DELEGATION

GSSAPI_DELEGATION?: null | CurlGssApi

Disable GSS-API delegation.

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

`Optional`gssapiDelegation

gssapiDelegation?: null | CurlGssApi

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?: null | string | number | boolean

Timeout for happy eyeballs.

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

`Optional`happyEyeballsTimeoutMs

happyEyeballsTimeoutMs?: null | string | number | boolean

Timeout for happy eyeballs.

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

`Optional`HAPROXY_CLIENT_IP

HAPROXY_CLIENT_IP?: null | string | number | boolean

Spoof the client IP in an HAProxy PROXY protocol v1 header.

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

`Optional`haProxyClientIp

haProxyClientIp?: null | string | number | boolean

Spoof the client IP in an HAProxy PROXY protocol v1 header.

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

`Optional`haProxyProtocol

haProxyProtocol?: null | string | number | boolean

Send an HAProxy PROXY protocol v1 header.

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

`Optional`HAPROXYPROTOCOL

HAPROXYPROTOCOL?: null | string | number | boolean

Send an HAProxy PROXY protocol v1 header.

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

`Optional`header

header?: null | string | number | boolean

Include the header in the body output.

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

`Optional`HEADER

HEADER?: null | string | number | boolean

Include the header in the body output.

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

`Optional`headerFunction

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

Callback for writing received headers.

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

`Optional`HEADERFUNCTION

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

Callback for writing received headers.

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

`Optional`headerOpt

headerOpt?: null | CurlHeader

Control custom headers.

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

`Optional`HEADEROPT

HEADEROPT?: null | CurlHeader

Control custom headers.

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

`Optional`hsts

hsts?: null | string | number | boolean

Set HSTS cache file.

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

`Optional`HSTS

HSTS?: null | string | number | boolean

Set HSTS cache file.

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

`Optional`HSTS_CTRL

HSTS_CTRL?: null | CurlHsts

Enable HSTS.

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

`Optional`hstsCtrl

hstsCtrl?: null | CurlHsts

Enable HSTS.

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

`Optional`hstsReadFunction

hstsReadFunction?:
    | null
    | (
        (
            this: Easy,
            options: { maxHostLengthBytes: number },
        ) => null | CurlHstsCacheEntry | CurlHstsCacheEntry[]
    )

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`HSTSREADFUNCTION

HSTSREADFUNCTION?:
    | null
    | (
        (
            this: Easy,
            options: { maxHostLengthBytes: number },
        ) => null | CurlHstsCacheEntry | CurlHstsCacheEntry[]
    )

Set HSTS read callback.

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

`Optional`hstsWriteFunction

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

Set HSTS write callback.

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

`Optional`HSTSWRITEFUNCTION

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

Set HSTS write callback.

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

`Optional`HTTP_CONTENT_DECODING

HTTP_CONTENT_DECODING?: null | string | number | boolean

Disable Content decoding.

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

`Optional`HTTP_TRANSFER_DECODING

HTTP_TRANSFER_DECODING?: null | string | number | boolean

Disable Transfer decoding.

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

`Optional`HTTP_VERSION

HTTP_VERSION?: null | CurlHttpVersion

HTTP version to use.

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

`Optional`HTTP09_ALLOWED

HTTP09_ALLOWED?: null | string | number | boolean

Allow HTTP/0.9 responses.

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

`Optional`http09Allowed

http09Allowed?: null | string | number | boolean

Allow HTTP/0.9 responses.

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

`Optional`http200aliases

http200aliases?: null | string[]

Alternative versions of 200 OK. See

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

`Optional`HTTP200ALIASES

HTTP200ALIASES?: null | string[]

Alternative versions of 200 OK. See

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

`Optional`httpAuth

httpAuth?: null | string | number | boolean

HTTP server authentication methods.

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

`Optional`HTTPAUTH

HTTPAUTH?: null | string | number | boolean

HTTP server authentication methods.

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

`Optional`httpContentDecoding

httpContentDecoding?: null | string | number | boolean

Disable Content decoding.

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

`Optional`httpGet

httpGet?: null | string | number | boolean

Do an HTTP GET request.

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

`Optional`HTTPGET

HTTPGET?: null | string | number | boolean

Do an HTTP GET request.

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

`Optional`httpHeader

httpHeader?: null | string[]

Custom HTTP headers.

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

`Optional`HTTPHEADER

HTTPHEADER?: null | string[]

Custom HTTP headers.

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

`Optional`httpPost

httpPost?: null | HttpPostField[]

Deprecated option Multipart formpost HTTP POST.

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

`Optional`HTTPPOST

HTTPPOST?: null | HttpPostField[]

Deprecated option Multipart formpost HTTP POST.

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

`Optional`httpProxyTunnel

httpProxyTunnel?: null | string | number | boolean

Tunnel through the HTTP proxy.

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

`Optional`HTTPPROXYTUNNEL

HTTPPROXYTUNNEL?: null | string | number | boolean

Tunnel through the HTTP proxy.

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

`Optional`httpTransferDecoding

httpTransferDecoding?: null | string | number | boolean

Disable Transfer decoding.

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

`Optional`httpVersion

httpVersion?: null | CurlHttpVersion

HTTP version to use.

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

`Optional`IGNORE_CONTENT_LENGTH

IGNORE_CONTENT_LENGTH?: null | string | number | boolean

Ignore Content-Length.

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

`Optional`ignoreContentLength

ignoreContentLength?: null | string | number | boolean

Ignore Content-Length.

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

`Optional`inFileSize

inFileSize?: null | string | number | boolean

Size of file to send.

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

`Optional`INFILESIZE

INFILESIZE?: null | string | number | boolean

Size of file to send.

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

`Optional`INFILESIZE_LARGE

INFILESIZE_LARGE?: null | string | number | boolean

Size of file to send.

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

`Optional`inFileSizeLarge

inFileSizeLarge?: null | string | number | boolean

Size of file to send.

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

`Optional`interface

interface?: null | string | number | boolean

Bind connection locally to this.

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

`Optional`INTERFACE

INTERFACE?: null | string | number | boolean

Bind connection locally to this.

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

`Optional`interleaveFunction

interleaveFunction?:
| null
| ((this: Easy, data: Buffer, size: number, nmemb: number) => number)

Callback for RTSP interleaved data.

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

`Optional`INTERLEAVEFUNCTION

INTERLEAVEFUNCTION?:
| null
| ((this: Easy, data: Buffer, size: number, nmemb: number) => number)

Callback for RTSP interleaved data.

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

`Optional`ipResolve

ipResolve?: null | CurlIpResolve

IP version to use.

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

`Optional`IPRESOLVE

IPRESOLVE?: null | CurlIpResolve

IP version to use.

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

`Optional`issuerCert

issuerCert?: null | string | number | boolean

Issuer certificate.

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

`Optional`ISSUERCERT

ISSUERCERT?: null | string | number | boolean

Issuer certificate.

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

`Optional`ISSUERCERT_BLOB

ISSUERCERT_BLOB?: null | string | ArrayBuffer | Buffer<ArrayBufferLike>

Issuer certificate memory buffer.

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

`Optional`issuerCertBlob

issuerCertBlob?: null | string | ArrayBuffer | Buffer<ArrayBufferLike>

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?: null | string | number | boolean

Keep sending on HTTP >= 300 errors.

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

`Optional`keepSendingOnError

keepSendingOnError?: null | string | number | boolean

Keep sending on HTTP >= 300 errors.

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

`Optional`keyPasswd

keyPasswd?: null | string | number | boolean

Client key password.

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

`Optional`KEYPASSWD

KEYPASSWD?: null | string | number | boolean

Client key password.

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

`Optional`krbLevel

krbLevel?: null | string | number | boolean

OBSOLETE. Kerberos security level.

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

`Optional`KRBLEVEL

KRBLEVEL?: null | string | number | boolean

OBSOLETE. Kerberos security level.

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

`Optional`localPort

localPort?: null | string | number | boolean

Bind connection locally to this port.

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

`Optional`LOCALPORT

LOCALPORT?: null | string | number | boolean

Bind connection locally to this port.

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

`Optional`localPortRange

localPortRange?: null | string | number | boolean

Bind connection locally to port range.

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

`Optional`LOCALPORTRANGE

LOCALPORTRANGE?: null | string | number | boolean

Bind connection locally to port range.

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

`Optional`LOGIN_OPTIONS

LOGIN_OPTIONS?: null | string | number | boolean

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

`Optional`loginOptions

loginOptions?: null | string | number | boolean

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

`Optional`LOW_SPEED_LIMIT

LOW_SPEED_LIMIT?: null | string | number | boolean

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?: null | string | number | boolean

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`lowSpeedLimit

lowSpeedLimit?: null | string | number | boolean

Low speed limit to abort transfer.

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

`Optional`lowSpeedTime

lowSpeedTime?: null | string | number | boolean

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?: null | string | number | boolean

Authentication address.

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

`Optional`MAIL_FROM

MAIL_FROM?: null | string | number | boolean

Address of the sender.

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

`Optional`MAIL_RCPT

MAIL_RCPT?: null | string[]

Address of the recipients.

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

`Optional`MAIL_RCPT_ALLOWFAILS

MAIL_RCPT_ALLOWFAILS?: null | string | number | boolean

Allow RCPT TO command to fail for some recipients.

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

`Optional`mailAuth

mailAuth?: null | string | number | boolean

Authentication address.

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

`Optional`mailFrom

mailFrom?: null | string | number | boolean

Address of the sender.

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

`Optional`mailRcpt

mailRcpt?: null | string[]

Address of the recipients.

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

`Optional`mailRcptAllowfails

mailRcptAllowfails?: null | string | number | boolean

Allow RCPT TO command to fail for some recipients.

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

`Optional`MAX_RECV_SPEED_LARGE

MAX_RECV_SPEED_LARGE?: null | string | number | boolean

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?: null | string | number | boolean

Cap the upload speed to this.

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

`Optional`MAXAGE_CONN

MAXAGE_CONN?: null | string | number | boolean

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

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

`Optional`maxAgeConn

maxAgeConn?: null | string | number | boolean

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?: null | string | number | boolean

Maximum number of connections in the connection pool.

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

`Optional`MAXCONNECTS

MAXCONNECTS?: null | string | number | boolean

Maximum number of connections in the connection pool.

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

`Optional`maxFileSize

maxFileSize?: null | string | number | boolean

Maximum file size to get.

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

`Optional`MAXFILESIZE

MAXFILESIZE?: null | string | number | boolean

Maximum file size to get.

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

`Optional`MAXFILESIZE_LARGE

MAXFILESIZE_LARGE?: null | string | number | boolean

Maximum file size to get.

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

`Optional`maxFileSizeLarge

maxFileSizeLarge?: null | string | number | boolean

Maximum file size to get.

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

`Optional`MAXLIFETIME_CONN

MAXLIFETIME_CONN?: null | string | number | boolean

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

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

`Optional`maxLifetimeConn

maxLifetimeConn?: null | string | number | boolean

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?: null | string | number | boolean

Cap the download speed to this.

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

`Optional`maxRedirs

maxRedirs?: null | string | number | boolean

Maximum number of redirects to follow.

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

`Optional`MAXREDIRS

MAXREDIRS?: null | string | number | boolean

Maximum number of redirects to follow.

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

`Optional`maxSendSpeedLarge

maxSendSpeedLarge?: null | string | number | boolean

Cap the upload speed to this.

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

`Optional`MIME_OPTIONS

MIME_OPTIONS?: null | FormEscape

Set MIME option flags.

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

`Optional`mimeOptions

mimeOptions?: null | FormEscape

Set MIME option flags.

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

`Optional`mimePost

mimePost?: null | CurlMime

Post/send MIME data.

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

`Optional`MIMEPOST

MIMEPOST?: null | CurlMime

Post/send MIME data.

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

`Optional`netrc

netrc?: null | CurlNetrc

Enable .netrc parsing.

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

`Optional`NETRC

NETRC?: null | CurlNetrc

Enable .netrc parsing.

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

`Optional`NETRC_FILE

NETRC_FILE?: null | string | number | boolean

.netrc filename.

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

`Optional`netrcFile

netrcFile?: null | string | number | boolean

.netrc filename.

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

`Optional`NEW_DIRECTORY_PERMS

NEW_DIRECTORY_PERMS?: null | string | number | boolean

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?: null | string | number | boolean

Mode for creating new remote files.

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

`Optional`newDirectoryPerms

newDirectoryPerms?: null | string | number | boolean

Mode for creating new remote directories.

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

`Optional`newFilePerms

newFilePerms?: null | string | number | boolean

Mode for creating new remote files.

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

`Optional`nobody

nobody?: null | string | number | boolean

Do not get the body contents.

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

`Optional`NOBODY

NOBODY?: null | string | number | boolean

Do not get the body contents.

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

`Optional`noProgress

noProgress?: null | string | number | boolean

Shut off the progress meter.

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

`Optional`NOPROGRESS

NOPROGRESS?: null | string | number | boolean

Shut off the progress meter.

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

`Optional`noProxy

noProxy?: null | string | number | boolean

Filter out hosts from proxy use.

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

`Optional`NOPROXY

NOPROXY?: null | string | number | boolean

Filter out hosts from proxy use.

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

`Optional`noSignal

noSignal?: null | string | number | boolean

Do not install signal handlers.

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

`Optional`NOSIGNAL

NOSIGNAL?: null | string | number | boolean

Do not install signal handlers.

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

`Optional`password

password?: null | string | number | boolean

Password.

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

`Optional`PASSWORD

PASSWORD?: null | string | number | boolean

Password.

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

`Optional`PATH_AS_IS

PATH_AS_IS?: null | string | number | boolean

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

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

`Optional`pathAsIs

pathAsIs?: null | string | number | boolean

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

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

`Optional`pinnedPublicKey

pinnedPublicKey?: null | string | number | boolean

Set pinned SSL public key .

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

`Optional`PINNEDPUBLICKEY

PINNEDPUBLICKEY?: null | string | number | boolean

Set pinned SSL public key .

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

`Optional`pipeWait

pipeWait?: null | string | number | boolean

Wait on connection to pipeline on it.

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

`Optional`PIPEWAIT

PIPEWAIT?: null | string | number | boolean

Wait on connection to pipeline on it.

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

`Optional`port

port?: null | string | number | boolean

Port number to connect to.

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

`Optional`PORT

PORT?: null | string | number | boolean

Port number to connect to.

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

`Optional`post

post?: null | string | number | boolean

Make an HTTP POST.

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

`Optional`POST

POST?: null | string | number | boolean

Make an HTTP POST.

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

`Optional`postFields

postFields?: null | string | number | boolean

Send a POST with this data - does not copy it.

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

`Optional`POSTFIELDS

POSTFIELDS?: null | string | number | boolean

Send a POST with this data - does not copy it.

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

`Optional`postFieldSize

postFieldSize?: null | string | number | boolean

The POST data is this big.

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

`Optional`POSTFIELDSIZE

POSTFIELDSIZE?: null | string | number | boolean

The POST data is this big.

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

`Optional`POSTFIELDSIZE_LARGE

POSTFIELDSIZE_LARGE?: null | string | number | boolean

The POST data is this big.

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

`Optional`postFieldSizeLarge

postFieldSizeLarge?: null | string | number | boolean

The POST data is this big.

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

`Optional`postQuote

postQuote?: null | string[]

Commands to run after transfer.

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

`Optional`POSTQUOTE

POSTQUOTE?: null | string[]

Commands to run after transfer.

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

`Optional`postRedir

postRedir?: null | string | number | boolean

How to act on redirects after POST.

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

`Optional`POSTREDIR

POSTREDIR?: null | string | number | boolean

How to act on redirects after POST.

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

`Optional`PRE_PROXY

PRE_PROXY?: null | string | number | boolean

Socks proxy to use.

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

`Optional`preProxy

preProxy?: null | string | number | boolean

Socks proxy to use.

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

`Optional`preQuote

preQuote?: null | string[]

Commands to run just before transfer.

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

`Optional`PREQUOTE

PREQUOTE?: null | string[]

Commands to run just before transfer.

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

`Optional`preReqFunction

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

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`PREREQFUNCTION

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

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?:
    | null
    | (
        (
            this: Easy,
            dltotal: number,
            dlnow: number,
            ultotal: number,
            ulnow: number,
        ) => number
    )

OBSOLETE callback for progress meter.

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

`Optional`PROGRESSFUNCTION

PROGRESSFUNCTION?:
    | null
    | (
        (
            this: Easy,
            dltotal: number,
            dlnow: number,
            ultotal: number,
            ulnow: number,
        ) => number
    )

OBSOLETE callback for progress meter.

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

`Optional`protocols

protocols?: null | CurlProtocol

Deprecated option Allowed protocols.

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

`Optional`PROTOCOLS

PROTOCOLS?: null | CurlProtocol

Deprecated option Allowed protocols.

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

`Optional`PROTOCOLS_STR

PROTOCOLS_STR?: null | string | number | boolean

Allowed protocols.

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

`Optional`protocolsStr

protocolsStr?: null | string | number | boolean

Allowed protocols.

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

`Optional`proxy

proxy?: null | string | number | boolean

Proxy to use.

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

`Optional`PROXY

PROXY?: null | string | number | boolean

Proxy to use.

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

`Optional`PROXY_CAINFO

PROXY_CAINFO?: null | string | number | boolean

Proxy CA cert bundle.

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

`Optional`PROXY_CAINFO_BLOB

PROXY_CAINFO_BLOB?: null | string | ArrayBuffer | Buffer<ArrayBufferLike>

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?: null | string | number | boolean

Path to proxy CA cert bundle.

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

`Optional`PROXY_CRLFILE

PROXY_CRLFILE?: null | string | number | boolean

Proxy Certificate Revocation List.

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

`Optional`PROXY_ISSUERCERT

PROXY_ISSUERCERT?: null | string | number | boolean

Proxy issuer certificate.

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

`Optional`PROXY_ISSUERCERT_BLOB

PROXY_ISSUERCERT_BLOB?: null | string | number | boolean

Proxy issuer certificate memory buffer.

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

`Optional`PROXY_KEYPASSWD

PROXY_KEYPASSWD?: null | string | number | boolean

Proxy client key password.

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

`Optional`PROXY_PINNEDPUBLICKEY

PROXY_PINNEDPUBLICKEY?: null | string | number | boolean

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?: null | string | number | boolean

Proxy authentication service name.

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

`Optional`PROXY_SSL_CIPHER_LIST

PROXY_SSL_CIPHER_LIST?: null | string | number | boolean

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?: null | CurlSslOpt

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?: null | string | number | boolean

Verify the hostname 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?: null | string | number | boolean

Verify the proxy SSL certificate.

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

`Optional`PROXY_SSLCERT

PROXY_SSLCERT?: null | string | ArrayBuffer | Buffer<ArrayBufferLike>

Proxy client cert.

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

`Optional`PROXY_SSLCERT_BLOB

PROXY_SSLCERT_BLOB?: null | string | ArrayBuffer | Buffer<ArrayBufferLike>

Proxy client cert memory buffer.

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

`Optional`PROXY_SSLCERTTYPE

PROXY_SSLCERTTYPE?: null | string | number | boolean

Proxy client cert type.

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

`Optional`PROXY_SSLKEY

PROXY_SSLKEY?: null | string | number | boolean

Proxy client key.

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

`Optional`PROXY_SSLKEY_BLOB

PROXY_SSLKEY_BLOB?: null | string | ArrayBuffer | Buffer<ArrayBufferLike>

Proxy client key.

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

`Optional`PROXY_SSLKEYTYPE

PROXY_SSLKEYTYPE?: null | string | number | boolean

Proxy client key type.

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

`Optional`PROXY_SSLVERSION

PROXY_SSLVERSION?: null | string | number | boolean

Proxy SSL version to use.

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

`Optional`PROXY_TLS13_CIPHERS

PROXY_TLS13_CIPHERS?: null | string | number | boolean

Proxy TLS 1.3 cipher suites to use. See

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

`Optional`PROXY_TLSAUTH_PASSWORD

PROXY_TLSAUTH_PASSWORD?: null | string | number | boolean

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?: null | string | number | boolean

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?: null | string | number | boolean

Proxy TLS authentication username.

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

`Optional`PROXY_TRANSFER_MODE

PROXY_TRANSFER_MODE?: null | string | number | boolean

Add transfer mode to URL over proxy.

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

`Optional`proxyAuth

proxyAuth?: null | string | number | boolean

HTTP proxy authentication methods.

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

`Optional`PROXYAUTH

PROXYAUTH?: null | string | number | boolean

HTTP proxy authentication methods.

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

`Optional`proxyCaInfo

proxyCaInfo?: null | string | number | boolean

Proxy CA cert bundle.

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

`Optional`proxyCaInfoBlob

proxyCaInfoBlob?: null | string | ArrayBuffer | Buffer<ArrayBufferLike>

Proxy CA cert bundle memory buffer.

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

`Optional`proxyCaPath

proxyCaPath?: null | string | number | boolean

Path to proxy CA cert bundle.

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

`Optional`proxyCrlFile

proxyCrlFile?: null | string | number | boolean

Proxy Certificate Revocation List.

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

`Optional`proxyHeader

proxyHeader?: null | string[]

Custom HTTP headers sent to proxy.

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

`Optional`PROXYHEADER

PROXYHEADER?: null | string[]

Custom HTTP headers sent to proxy.

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

`Optional`proxyIssuerCert

proxyIssuerCert?: null | string | number | boolean

Proxy issuer certificate.

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

`Optional`proxyIssuerCertBlob

proxyIssuerCertBlob?: null | string | number | boolean

Proxy issuer certificate memory buffer.

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

`Optional`proxyKeyPasswd

proxyKeyPasswd?: null | string | number | boolean

Proxy client key password.

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

`Optional`proxyPassword

proxyPassword?: null | string | number | boolean

Proxy password.

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

`Optional`PROXYPASSWORD

PROXYPASSWORD?: null | string | number | boolean

Proxy password.

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

`Optional`proxyPinnedPublicKey

proxyPinnedPublicKey?: null | string | number | boolean

Set the proxy's pinned SSL public key.

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

`Optional`proxyPort

proxyPort?: null | string | number | boolean

Proxy port to use.

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

`Optional`PROXYPORT

PROXYPORT?: null | string | number | boolean

Proxy port to use.

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

`Optional`proxyServiceName

proxyServiceName?: null | string | number | boolean

Proxy authentication service name.

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

`Optional`proxySslCert

proxySslCert?: null | string | ArrayBuffer | Buffer<ArrayBufferLike>

Proxy client cert.

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

`Optional`proxySslCertBlob

proxySslCertBlob?: null | string | ArrayBuffer | Buffer<ArrayBufferLike>

Proxy client cert memory buffer.

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

`Optional`proxySslCertType

proxySslCertType?: null | string | number | boolean

Proxy client cert type.

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

`Optional`proxySslCipherList

proxySslCipherList?: null | string | number | boolean

Proxy ciphers to use.

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

`Optional`proxySslKey

proxySslKey?: null | string | number | boolean

Proxy client key.

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

`Optional`proxySslKeyBlob

proxySslKeyBlob?: null | string | ArrayBuffer | Buffer<ArrayBufferLike>

Proxy client key.

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

`Optional`proxySslKeyType

proxySslKeyType?: null | string | number | boolean

Proxy client key type.

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

`Optional`proxySslOptions

proxySslOptions?: null | CurlSslOpt

Control proxy SSL behavior.

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

`Optional`proxySslVerifyHost

proxySslVerifyHost?: null | string | number | boolean

Verify the hostname in the proxy SSL certificate.

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

`Optional`proxySslVerifyPeer

proxySslVerifyPeer?: null | string | number | boolean

Verify the proxy SSL certificate.

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

`Optional`proxySslversion

proxySslversion?: null | string | number | boolean

Proxy SSL version to use.

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

`Optional`proxyTls13Ciphers

proxyTls13Ciphers?: null | string | number | boolean

Proxy TLS 1.3 cipher suites to use. See

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

`Optional`proxyTlsAuthPassword

proxyTlsAuthPassword?: null | string | number | boolean

Proxy TLS authentication password.

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

`Optional`proxyTlsAuthType

proxyTlsAuthType?: null | string | number | boolean

Proxy TLS authentication methods.

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

`Optional`proxyTlsAuthUsername

proxyTlsAuthUsername?: null | string | number | boolean

Proxy TLS authentication username.

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

`Optional`proxyTransferMode

proxyTransferMode?: null | string | number | boolean

Add transfer mode to URL over proxy.

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

`Optional`proxyType

proxyType?: null | CurlProxy

Proxy type.

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

`Optional`PROXYTYPE

PROXYTYPE?: null | CurlProxy

Proxy type.

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

`Optional`proxyUsername

proxyUsername?: null | string | number | boolean

Proxy username.

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

`Optional`PROXYUSERNAME

PROXYUSERNAME?: null | string | number | boolean

Proxy username.

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

`Optional`proxyUserpwd

proxyUserpwd?: null | string | number | boolean

Proxy username and password.

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

`Optional`PROXYUSERPWD

PROXYUSERPWD?: null | string | number | boolean

Proxy username and password.

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

`Optional`put

put?: null | string | number | boolean

Deprecated option Issue an HTTP PUT request.

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

`Optional`PUT

PUT?: null | string | number | boolean

Deprecated option Issue an HTTP PUT request.

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

`Optional`QUICK_EXIT

QUICK_EXIT?: null | string | number | boolean

To be set by toplevel tools like "curl" to skip lengthy cleanups when they are about to call exit() anyway.

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

`Optional`quickExit

quickExit?: null | string | number | boolean

To be set by toplevel tools like "curl" to skip lengthy cleanups when they are about to call exit() anyway.

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

`Optional`quote

quote?: null | string[]

Commands to run before transfer.

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

`Optional`QUOTE

QUOTE?: null | string[]

Commands to run before transfer.

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

`Optional`RANDOM_FILE

RANDOM_FILE?: null | string | number | boolean

OBSOLETE Provide source for entropy random data.

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

`Optional`randomFile

randomFile?: null | string | number | boolean

OBSOLETE Provide source for entropy random data.

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

`Optional`range

range?: null | string | number | boolean

Range requests.

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

`Optional`RANGE

RANGE?: null | string | number | boolean

Range requests.

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

`Optional`readData

readData?: null | string | number | boolean

Data pointer to pass to the read callback.

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

`Optional`READDATA

READDATA?: null | string | number | boolean

Data pointer to pass to the read callback.

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

`Optional`readFunction

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

Callback for reading data.

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

`Optional`READFUNCTION

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

Callback for reading data.

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

`Optional`REDIR_PROTOCOLS

REDIR_PROTOCOLS?: null | CurlProtocol

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?: null | string | number | boolean

Protocols to allow redirects to.

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

`Optional`redirProtocols

redirProtocols?: null | CurlProtocol

Deprecated option Protocols to allow redirects to.

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

`Optional`redirProtocolsStr

redirProtocolsStr?: null | string | number | boolean

Protocols to allow redirects to.

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

`Optional`referer

referer?: null | string | number | boolean

Referer: header.

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

`Optional`REFERER

REFERER?: null | string | number | boolean

Referer: header.

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

`Optional`REQUEST_TARGET

REQUEST_TARGET?: null | string | number | boolean

Set the request target.

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

`Optional`requestTarget

requestTarget?: null | string | number | boolean

Set the request target.

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

`Optional`resolve

resolve?: null | string[]

Provide fixed/fake name resolves.

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

`Optional`RESOLVE

RESOLVE?: null | string[]

Provide fixed/fake name resolves.

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

`Optional`RESUME_FROM

RESUME_FROM?: null | string | number | boolean

Resume a transfer.

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

`Optional`RESUME_FROM_LARGE

RESUME_FROM_LARGE?: null | string | number | boolean

Resume a transfer.

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

`Optional`resumeFrom

resumeFrom?: null | string | number | boolean

Resume a transfer.

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

`Optional`resumeFromLarge

resumeFromLarge?: null | string | number | boolean

Resume a transfer.

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

`Optional`RTSP_CLIENT_CSEQ

RTSP_CLIENT_CSEQ?: null | string | number | boolean

Client CSEQ number.

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

`Optional`RTSP_REQUEST

RTSP_REQUEST?: null | CurlRtspRequest

RTSP request.

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

`Optional`RTSP_SERVER_CSEQ

RTSP_SERVER_CSEQ?: null | string | number | boolean

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?: null | string | number | boolean

RTSP session-id.

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

`Optional`RTSP_STREAM_URI

RTSP_STREAM_URI?: null | string | number | boolean

RTSP stream URI.

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

`Optional`RTSP_TRANSPORT

RTSP_TRANSPORT?: null | string | number | boolean

RTSP Transport: header.

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

`Optional`rtspClientCseq

rtspClientCseq?: null | string | number | boolean

Client CSEQ number.

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

`Optional`rtspRequest

rtspRequest?: null | CurlRtspRequest

RTSP request.

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

`Optional`rtspServerCseq

rtspServerCseq?: null | string | number | boolean

CSEQ number for RTSP Server->Client request.

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

`Optional`rtspSessionId

rtspSessionId?: null | string | number | boolean

RTSP session-id.

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

`Optional`rtspStreamUri

rtspStreamUri?: null | string | number | boolean

RTSP stream URI.

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

`Optional`rtspTransPort

rtspTransPort?: null | string | number | boolean

RTSP Transport: header.

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

`Optional`SASL_AUTHZID

SASL_AUTHZID?: null | string | number | boolean

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?: null | string | number | boolean

Enable SASL initial response.

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

`Optional`saslAuthzId

saslAuthzId?: null | string | number | boolean

SASL authorization identity (identity to act as).

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

`Optional`saslIr

saslIr?: null | string | number | boolean

Enable SASL initial response.

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

`Optional`seekFunction

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

Callback for seek operations.

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

`Optional`SEEKFUNCTION

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

Callback for seek operations.

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

`Optional`SERVER_RESPONSE_TIMEOUT

SERVER_RESPONSE_TIMEOUT?: null | string | number | boolean

Timeout for server responses.

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

`Optional`SERVER_RESPONSE_TIMEOUT_MS

SERVER_RESPONSE_TIMEOUT_MS?: null | string | number | boolean

Timeout for server responses.

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

`Optional`serverResponseTimeout

serverResponseTimeout?: null | string | number | boolean

Timeout for server responses.

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

`Optional`serverResponseTimeoutMs

serverResponseTimeoutMs?: null | string | number | boolean

Timeout for server responses.

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

`Optional`SERVICE_NAME

SERVICE_NAME?: null | string | number | boolean

Authentication service name.

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

`Optional`serviceName

serviceName?: null | string | number | boolean

Authentication service name.

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

`Optional`share

share?: null | Share

Share object to use.

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

`Optional`SHARE

SHARE?: null | Share

Share object to use.

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

`Optional`SOCKS5_AUTH

SOCKS5_AUTH?: null | string | number | boolean

Socks5 authentication methods. See

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

`Optional`SOCKS5_GSSAPI_NEC

SOCKS5_GSSAPI_NEC?: null | string | number | boolean

Socks5 GSSAPI NEC mode. See

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

`Optional`SOCKS5_GSSAPI_SERVICE

SOCKS5_GSSAPI_SERVICE?: null | string | number | boolean

Deprecated option Socks5 GSSAPI service name. See

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

`Optional`socks5Auth

socks5Auth?: null | string | number | boolean

Socks5 authentication methods. See

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

`Optional`socks5GssapiNec

socks5GssapiNec?: null | string | number | boolean

Socks5 GSSAPI NEC mode. See

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

`Optional`socks5GssapiService

socks5GssapiService?: null | string | number | boolean

Deprecated option Socks5 GSSAPI service name. See

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

`Optional`SSH_AUTH_TYPES

SSH_AUTH_TYPES?: null | CurlSshAuth

SSH authentication types.

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

`Optional`SSH_COMPRESSION

SSH_COMPRESSION?: null | string | number | boolean

Enable SSH compression.

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

`Optional`SSH_HOST_PUBLIC_KEY_MD5

SSH_HOST_PUBLIC_KEY_MD5?: null | string | number | boolean

MD5 of host's public key. See

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

`Optional`SSH_HOST_PUBLIC_KEY_SHA256

SSH_HOST_PUBLIC_KEY_SHA256?: null | string | number | boolean

SHA256 of host's public key. See

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

`Optional`SSH_HOSTKEYFUNCTION

SSH_HOSTKEYFUNCTION?:
| null
| ((this: Easy, keytype: CurlSshKeyType, key: Buffer) => CurlSshKeyMatch)

Callback for checking host key handling.

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

`Optional`SSH_KNOWNHOSTS

SSH_KNOWNHOSTS?: null | string | number | boolean

Filename with known hosts.

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

`Optional`SSH_PRIVATE_KEYFILE

SSH_PRIVATE_KEYFILE?: null | string | number | boolean

Filename of the private key.

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

`Optional`SSH_PUBLIC_KEYFILE

SSH_PUBLIC_KEYFILE?: null | string | number | boolean

Filename of the public key.

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

`Optional`sshAuthTypes

sshAuthTypes?: null | CurlSshAuth

SSH authentication types.

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

`Optional`sshCompression

sshCompression?: null | string | number | boolean

Enable SSH compression.

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

`Optional`sshHostKeyFunction

sshHostKeyFunction?:
| null
| ((this: Easy, keytype: CurlSshKeyType, key: Buffer) => CurlSshKeyMatch)

Callback for checking host key handling.

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

`Optional`sshHostPublicKeyMd5

sshHostPublicKeyMd5?: null | string | number | boolean

MD5 of host's public key. See

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

`Optional`sshHostPublicKeySha256

sshHostPublicKeySha256?: null | string | number | boolean

SHA256 of host's public key. See

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

`Optional`sshKnownHosts

sshKnownHosts?: null | string | number | boolean

Filename with known hosts.

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

`Optional`sshPrivateKeyFile

sshPrivateKeyFile?: null | string | number | boolean

Filename of the private key.

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

`Optional`sshPublicKeyFile

sshPublicKeyFile?: null | string | number | boolean

Filename of the public key.

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

`Optional`SSL_CIPHER_LIST

SSL_CIPHER_LIST?: null | string | number | boolean

Ciphers to use.

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

`Optional`SSL_EC_CURVES

SSL_EC_CURVES?: null | string | number | boolean

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?: null | string | number | boolean

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?: null | string | number | boolean

OBSOLETE Enable use of NPN.

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

`Optional`SSL_FALSESTART

SSL_FALSESTART?: null | string | number | boolean

Deprecated option Enable TLS False Start.

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

`Optional`SSL_OPTIONS

SSL_OPTIONS?: null | CurlSslOpt

Control SSL behavior.

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

`Optional`SSL_SESSIONID_CACHE

SSL_SESSIONID_CACHE?: null | string | number | boolean

Disable SSL session-id cache.

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

`Optional`SSL_SIGNATURE_ALGORITHMS

SSL_SIGNATURE_ALGORITHMS?: null | string | number | boolean

TLS signature algorithms to use.

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

`Optional`SSL_VERIFYHOST

SSL_VERIFYHOST?: null | string | number | boolean

Verify the hostname in the SSL certificate.

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

`Optional`SSL_VERIFYPEER

SSL_VERIFYPEER?: null | string | number | boolean

Verify the SSL certificate.

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

`Optional`SSL_VERIFYSTATUS

SSL_VERIFYSTATUS?: null | string | number | boolean

Verify the SSL certificate's status.

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

`Optional`sslCert

sslCert?: null | string | number | boolean

Client cert.

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

`Optional`SSLCERT

SSLCERT?: null | string | number | boolean

Client cert.

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

`Optional`SSLCERT_BLOB

SSLCERT_BLOB?: null | string | ArrayBuffer | Buffer<ArrayBufferLike>

Client cert memory buffer.

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

`Optional`sslCertBlob

sslCertBlob?: null | string | ArrayBuffer | Buffer<ArrayBufferLike>

Client cert memory buffer.

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

`Optional`sslCertType

sslCertType?: null | string | number | boolean

Client cert type.

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

`Optional`SSLCERTTYPE

SSLCERTTYPE?: null | string | number | boolean

Client cert type.

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

`Optional`sslCipherList

sslCipherList?: null | string | number | boolean

Ciphers to use.

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

`Optional`sslEcCurves

sslEcCurves?: null | string | number | boolean

Set key exchange curves.

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

`Optional`sslEnableAlpn

sslEnableAlpn?: null | string | number | boolean

Enable use of ALPN.

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

`Optional`sslEnableNpn

sslEnableNpn?: null | string | number | boolean

OBSOLETE Enable use of NPN.

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

`Optional`sslEngine

sslEngine?: null | string | number | boolean

Use identifier with SSL engine.

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

`Optional`SSLENGINE

SSLENGINE?: null | string | number | boolean

Use identifier with SSL engine.

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

`Optional`SSLENGINE_DEFAULT

SSLENGINE_DEFAULT?: null | string | number | boolean

Default SSL engine.

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

`Optional`sslEngineDefault

sslEngineDefault?: null | string | number | boolean

Default SSL engine.

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

`Optional`sslFalsestart

sslFalsestart?: null | string | number | boolean

Deprecated option Enable TLS False Start.

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

`Optional`sslKey

sslKey?: null | string | number | boolean

Client key.

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

`Optional`SSLKEY

SSLKEY?: null | string | number | boolean

Client key.

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

`Optional`SSLKEY_BLOB

SSLKEY_BLOB?: null | string | ArrayBuffer | Buffer<ArrayBufferLike>

Client key memory buffer.

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

`Optional`sslKeyBlob

sslKeyBlob?: null | string | ArrayBuffer | Buffer<ArrayBufferLike>

Client key memory buffer.

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

`Optional`sslKeyType

sslKeyType?: null | string | number | boolean

Client key type.

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

`Optional`SSLKEYTYPE

SSLKEYTYPE?: null | string | number | boolean

Client key type.

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

`Optional`sslOptions

sslOptions?: null | CurlSslOpt

Control SSL behavior.

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

`Optional`sslSessionIdCache

sslSessionIdCache?: null | string | number | boolean

Disable SSL session-id cache.

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

`Optional`sslSignatureAlgorithms

sslSignatureAlgorithms?: null | string | number | boolean

TLS signature algorithms to use.

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

`Optional`sslVerifyHost

sslVerifyHost?: null | string | number | boolean

Verify the hostname in the SSL certificate.

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

`Optional`sslVerifyPeer

sslVerifyPeer?: null | string | number | boolean

Verify the SSL certificate.

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

`Optional`sslVerifyStatus

sslVerifyStatus?: null | string | number | boolean

Verify the SSL certificate's status.

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

`Optional`sslversion

sslversion?: null | CurlSslVersion

SSL version to use.

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

`Optional`SSLVERSION

SSLVERSION?: null | CurlSslVersion

SSL version to use.

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

`Optional`STREAM_DEPENDS

STREAM_DEPENDS?: null | Easy

This HTTP/2 stream depends on another.

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

`Optional`STREAM_DEPENDS_E

STREAM_DEPENDS_E?: null | Easy

This HTTP/2 stream depends on another exclusively.

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

`Optional`STREAM_WEIGHT

STREAM_WEIGHT?: null | string | number | boolean

Set this HTTP/2 stream's weight.

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

`Optional`streamDepends

streamDepends?: null | Easy

This HTTP/2 stream depends on another.

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

`Optional`streamDependsE

streamDependsE?: null | Easy

This HTTP/2 stream depends on another exclusively.

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

`Optional`streamWeight

streamWeight?: null | string | number | boolean

Set this HTTP/2 stream's weight.

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

`Optional`SUPPRESS_CONNECT_HEADERS

SUPPRESS_CONNECT_HEADERS?: null | string | number | boolean

Suppress proxy CONNECT response headers from user callbacks.

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

`Optional`suppressConnectHeaders

suppressConnectHeaders?: null | string | number | boolean

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?: null | string | number | boolean

Enable TCP Fast Open.

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

`Optional`TCP_KEEPALIVE

TCP_KEEPALIVE?: null | string | number | boolean

Enable TCP keep-alive.

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

`Optional`TCP_KEEPCNT

TCP_KEEPCNT?: null | string | number | boolean

Maximum number of keep-alive probes.

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

`Optional`TCP_KEEPIDLE

TCP_KEEPIDLE?: null | string | number | boolean

Idle time before sending keep-alive.

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

`Optional`TCP_KEEPINTVL

TCP_KEEPINTVL?: null | string | number | boolean

Interval between keep-alive probes.

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

`Optional`TCP_NODELAY

TCP_NODELAY?: null | string | number | boolean

Disable the Nagle algorithm.

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

`Optional`tcpFastOpen

tcpFastOpen?: null | string | number | boolean

Enable TCP Fast Open.

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

`Optional`tcpKeepAlive

tcpKeepAlive?: null | string | number | boolean

Enable TCP keep-alive.

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

`Optional`tcpKeepCnt

tcpKeepCnt?: null | string | number | boolean

Maximum number of keep-alive probes.

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

`Optional`tcpKeepIdle

tcpKeepIdle?: null | string | number | boolean

Idle time before sending keep-alive.

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

`Optional`tcpKeepIntvl

tcpKeepIntvl?: null | string | number | boolean

Interval between keep-alive probes.

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

`Optional`tcpNoDelay

tcpNoDelay?: null | string | number | boolean

Disable the Nagle algorithm.

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

`Optional`telnetOptions

telnetOptions?: null | string[]

TELNET options.

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

`Optional`TELNETOPTIONS

TELNETOPTIONS?: null | string[]

TELNET options.

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

`Optional`TFTP_BLKSIZE

TFTP_BLKSIZE?: null | string | number | boolean

TFTP block size.

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

`Optional`TFTP_NO_OPTIONS

TFTP_NO_OPTIONS?: null | string | number | boolean

Do not send TFTP options requests.

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

`Optional`tftpBlkSize

tftpBlkSize?: null | string | number | boolean

TFTP block size.

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

`Optional`tftpNoOptions

tftpNoOptions?: null | string | number | boolean

Do not send TFTP options requests.

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

`Optional`timeCondition

timeCondition?: null | CurlTimeCond

Make a time conditional request.

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

`Optional`TIMECONDITION

TIMECONDITION?: null | CurlTimeCond

Make a time conditional request.

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

`Optional`timeout

timeout?: null | string | number | boolean

Timeout for the entire request.

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

`Optional`TIMEOUT

TIMEOUT?: null | string | number | boolean

Timeout for the entire request.

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

`Optional`TIMEOUT_MS

TIMEOUT_MS?: null | string | number | boolean

Millisecond timeout for the entire request.

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

`Optional`timeoutMs

timeoutMs?: null | string | number | boolean

Millisecond timeout for the entire request.

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

`Optional`timeValue

timeValue?: null | string | number | boolean

Time value for the time conditional request.

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

`Optional`TIMEVALUE

TIMEVALUE?: null | string | number | boolean

Time value for the time conditional request.

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

`Optional`TIMEVALUE_LARGE

TIMEVALUE_LARGE?: null | string | number | boolean

Time value for the time conditional request.

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

`Optional`timeValueLarge

timeValueLarge?: null | string | number | boolean

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?: null | string | number | boolean

TLS 1.3 cipher suites to use. See

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

`Optional`tls13Ciphers

tls13Ciphers?: null | string | number | boolean

TLS 1.3 cipher suites to use. See

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

`Optional`TLSAUTH_PASSWORD

TLSAUTH_PASSWORD?: null | string | number | boolean

TLS authentication password.

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

`Optional`TLSAUTH_TYPE

TLSAUTH_TYPE?: null | string | number | boolean

TLS authentication methods.

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

`Optional`TLSAUTH_USERNAME

TLSAUTH_USERNAME?: null | string | number | boolean

TLS authentication username.

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

`Optional`tlsAuthPassword

tlsAuthPassword?: null | string | number | boolean

TLS authentication password.

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

`Optional`tlsAuthType

tlsAuthType?: null | string | number | boolean

TLS authentication methods.

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

`Optional`tlsAuthUsername

tlsAuthUsername?: null | string | number | boolean

TLS authentication username.

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

`Optional`trailerFunction

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

Set callback for sending trailing headers.

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

`Optional`TRAILERFUNCTION

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

Set callback for sending trailing headers.

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

`Optional`TRANSFER_ENCODING

TRANSFER_ENCODING?: null | string | number | boolean

Request Transfer-Encoding.

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

`Optional`transferEncoding

transferEncoding?: null | string | number | boolean

Request Transfer-Encoding.

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

`Optional`transferText

transferText?: null | string | number | boolean

Use text transfer.

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

`Optional`TRANSFERTEXT

TRANSFERTEXT?: null | string | number | boolean

Use text transfer.

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

`Optional`UNIX_SOCKET_PATH

UNIX_SOCKET_PATH?: null | string | number | boolean

Path to a Unix domain socket.

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

`Optional`unixSocketPath

unixSocketPath?: null | string | number | boolean

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?: null | string | number | boolean

Do not restrict authentication to original host.

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

`Optional`unrestrictedAuth

unrestrictedAuth?: null | string | number | boolean

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?: null | string | number | boolean

Sets the interval at which connection upkeep are performed.

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

`Optional`upkeepIntervalMs

upkeepIntervalMs?: null | string | number | boolean

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?: null | string | number | boolean

Upload data.

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

`Optional`UPLOAD

UPLOAD?: null | string | number | boolean

Upload data.

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

`Optional`UPLOAD_BUFFERSIZE

UPLOAD_BUFFERSIZE?: null | string | number | boolean

Set upload buffer size.

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

`Optional`UPLOAD_FLAGS

UPLOAD_FLAGS?: null | string | number | boolean

Set upload flags.

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

`Optional`uploadBufferSize

uploadBufferSize?: null | string | number | boolean

Set upload buffer size.

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

`Optional`uploadFlags

uploadFlags?: null | string | number | boolean

Set upload flags.

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

`Optional`url

url?: null | string | number | boolean

URL to work on.

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

`Optional`URL

URL?: null | string | number | boolean

URL to work on.

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

`Optional`USE_SSL

USE_SSL?: null | CurlUseSsl

Use TLS/SSL.

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

`Optional`userAgent

userAgent?: null | string | number | boolean

User-Agent: header.

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

`Optional`USERAGENT

USERAGENT?: null | string | number | boolean

User-Agent: header.

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

`Optional`username

username?: null | string | number | boolean

Username.

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

`Optional`USERNAME

USERNAME?: null | string | number | boolean

Username.

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

`Optional`userpwd

userpwd?: null | string | number | boolean

Username and password.

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

`Optional`USERPWD

USERPWD?: null | string | number | boolean

Username and password.

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

`Optional`useSsl

useSsl?: null | CurlUseSsl

Use TLS/SSL.

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

`Optional`verbose

verbose?: null | string | number | boolean

Display verbose information.

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

`Optional`VERBOSE

VERBOSE?: null | string | number | boolean

Display verbose information.

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

`Optional`wildcardMatch

wildcardMatch?: null | string | number | boolean

Transfer multiple files according to a filename pattern.

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

`Optional`WILDCARDMATCH

WILDCARDMATCH?: null | string | number | boolean

Transfer multiple files according to a filename pattern.

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

`Optional`writeFunction

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

Callback for writing data.

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

`Optional`WRITEFUNCTION

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

Callback for writing data.

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

`Optional`WS_OPTIONS

WS_OPTIONS?: null | CurlWsOptions

Set WebSocket options.

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

`Optional`wsOptions

wsOptions?: null | CurlWsOptions

Set WebSocket options.

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

`Optional`xferInfoFunction

xferInfoFunction?:
    | null
    | (
        (
            this: Easy,
            dltotal: number,
            dlnow: number,
            ultotal: number,
            ulnow: number,
        ) => number
    )

Callback for progress meter.

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

`Optional`XFERINFOFUNCTION

XFERINFOFUNCTION?:
    | null
    | (
        (
            this: Easy,
            dltotal: number,
            dlnow: number,
            ultotal: number,
            ulnow: number,
        ) => number
    )

Callback for progress meter.

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

`Optional`XOAUTH2_BEARER

XOAUTH2_BEARER?: null | string | number | boolean

OAuth2 bearer token. See

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

`Optional`xoauth2Bearer

xoauth2Bearer?: null | string | number | boolean

OAuth2 bearer token. See

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

Interface CurlyOptions

Hierarchy (View Summary, Expand)

Index

Properties

Properties

OptionalABSTRACT_UNIX_SOCKET

OptionalabstractUnixSocket

OptionalACCEPT_ENCODING

OptionalacceptEncoding

OptionalACCEPTTIMEOUT_MS

OptionalacceptTimeoutMs

OptionalADDRESS_SCOPE

OptionaladdressScope

OptionalaltSvc

OptionalALTSVC

OptionalALTSVC_CTRL

OptionalaltSvcCtrl

Optionalappend

OptionalAPPEND

OptionalautoReferer

OptionalAUTOREFERER

OptionalAWS_SIGV4

OptionalawsSigV4

OptionalbufferSize

OptionalBUFFERSIZE

OptionalCA_CACHE_TIMEOUT

OptionalcaCacheTimeout

OptionalcaInfo

OptionalCAINFO

OptionalCAINFO_BLOB

OptionalcaInfoBlob

OptionalcaPath

OptionalCAPATH

OptionalcertInfo

OptionalCERTINFO

OptionalCHUNK_BGN_FUNCTION

OptionalCHUNK_END_FUNCTION

OptionalchunkBgnFunction

OptionalchunkEndFunction

OptionalCONNECT_ONLY

OptionalCONNECT_TO

OptionalconnectOnly

OptionalconnectTimeout

OptionalCONNECTTIMEOUT

OptionalCONNECTTIMEOUT_MS

OptionalconnectTimeoutMs

OptionalconnectTo

Optionalcookie

OptionalCOOKIE

OptionalcookieFile

OptionalCOOKIEFILE

OptionalcookieJar

OptionalCOOKIEJAR

OptionalcookieList

OptionalCOOKIELIST

OptionalcookieSession

OptionalCOOKIESESSION

Optionalcrlf

OptionalCRLF

OptionalcrlFile

OptionalCRLFILE

OptionalcurlyBaseUrl

OptionalcurlyLowerCaseHeaders

OptionalcurlyMimePost

Remarks

Example

Example

OptionalcurlyProgressCallback

Remarks

OptionalcurlyResponseBodyParser

OptionalcurlyResponseBodyParsers

OptionalcurlyStreamResponse

Remarks

OptionalcurlyStreamResponseHighWaterMark

Remarks

OptionalcurlyStreamUpload

Remarks

OptionalcustomRequest

OptionalCUSTOMREQUEST

OptionaldebugFunction

`Optional`ABSTRACT_UNIX_SOCKET

`Optional`abstractUnixSocket

`Optional`ACCEPT_ENCODING

`Optional`acceptEncoding

`Optional`ACCEPTTIMEOUT_MS

`Optional`acceptTimeoutMs

`Optional`ADDRESS_SCOPE

`Optional`addressScope

`Optional`altSvc

`Optional`ALTSVC

`Optional`ALTSVC_CTRL

`Optional`altSvcCtrl

`Optional`append

`Optional`APPEND

`Optional`autoReferer

`Optional`AUTOREFERER

`Optional`AWS_SIGV4

`Optional`awsSigV4

`Optional`bufferSize

`Optional`BUFFERSIZE

`Optional`CA_CACHE_TIMEOUT

`Optional`caCacheTimeout

`Optional`caInfo

`Optional`CAINFO

`Optional`CAINFO_BLOB

`Optional`caInfoBlob

`Optional`caPath

`Optional`CAPATH

`Optional`certInfo

`Optional`CERTINFO

`Optional`CHUNK_BGN_FUNCTION

`Optional`CHUNK_END_FUNCTION

`Optional`chunkBgnFunction

`Optional`chunkEndFunction

`Optional`CONNECT_ONLY

`Optional`CONNECT_TO

`Optional`connectOnly

`Optional`connectTimeout

`Optional`CONNECTTIMEOUT

`Optional`CONNECTTIMEOUT_MS

`Optional`connectTimeoutMs

`Optional`connectTo

`Optional`cookie

`Optional`COOKIE

`Optional`cookieFile

`Optional`COOKIEFILE

`Optional`cookieJar

`Optional`COOKIEJAR

`Optional`cookieList

`Optional`COOKIELIST

`Optional`cookieSession

`Optional`COOKIESESSION

`Optional`crlf

`Optional`CRLF

`Optional`crlFile

`Optional`CRLFILE

`Optional`curlyBaseUrl

`Optional`curlyLowerCaseHeaders

`Optional`curlyMimePost

`Optional`curlyProgressCallback

`Optional`curlyResponseBodyParser

`Optional`curlyResponseBodyParsers

`Optional`curlyStreamResponse

`Optional`curlyStreamResponseHighWaterMark

`Optional`curlyStreamUpload

`Optional`customRequest

`Optional`CUSTOMREQUEST

`Optional`debugFunction

`Optional`DEBUGFUNCTION

`Optional`DEFAULT_PROTOCOL

`Optional`defaultProtocol

`Optional`dirListOnly

`Optional`DIRLISTONLY

`Optional`DISALLOW_USERNAME_IN_URL

`Optional`disallowUsernameInUrl

`Optional`DNS_CACHE_TIMEOUT

`Optional`DNS_INTERFACE

`Optional`DNS_LOCAL_IP4

`Optional`DNS_LOCAL_IP6

`Optional`DNS_SERVERS