httpGetRequest

GET, POST

port to use for localhost if no full URI is provided

object with headers to pass to HTTP request, properties must be all lower case

an object with cookies to send with request, if even empty rescookies will be set in the response

file name where to save response, in case of error response the error body will be saved as well, it uses sync file operations

a writable stream where to save data

data to be sent with the request as x-www-form-urlencoded

data to be sent with the request in the body as JSON

file to be uploaded in the POST body, not as multipart

file size to be uploaded if obtained separately

content type for post data

an array of objects for multipart/form-data post, { name: "..", data: ".." [ file: ".."] }, for files a Buffer can be used in data

do not parse known content types like json, xml

post files using chunked encoding

an object to be passed to qs.stringify

additional query parameters to be added to the url as an object or as encoded string

a function to sign the request signer(this)

if true the body needs a checksum in the signature

a Date or timestamp to be used in conditional requests

add If-Modified-Since header using params.mtime if present or if file is given use file last modified timestamp, mtime

timeout in milliseconds after which the request is aborted if no data received

abort the request after this amount of time in ms, must be big enough to allow for all data to be received

if the content being downloaded becomes greater than this size the request will be aborted

how many times to retry the request on error or timeout

timeout in milliseconds for retries, with every subsequent timeout it will be multiplied by retryMultiplier

retry request if received non 2xx response status, if this is a function then it must return true in order to retry the request, otherwise it is treated as a boolean value, if true then retry on all non-2xx responses

a function to be called before retrying, it can update any parameter, most related: _uri, retryTimeout, retryMultiplier

how many times to retry on aborted connections, default is retryCount

on not ok status raise and eror on return with JSON body if present or generic message

if true then do not follow redirect locations for 30-[1,2,3,7] statuses

a function to be called before parsing the xml/json content, called in the context of the http object

a list of headers to be passed in redirects

authorization user, if also `password`` is provided then it will use Basic authorization, if only user is provided then Bearer

response data if file was not specified

if the content type is a known type like json or xml this property will hold a reference to the parsed document or null in case or parse error

HTTP response status code

Date object with the last modified time of the requested file

response headers as an object

parsed cookies from the response if request `cookies`` is not empty

size of the response body or file

response content type

true if the status is between 200 and 299