Create new instance.
An object configuring the request.
An object containing data to be encoded into the HTTP body of the request.
Format to encode data
in the body of request.
An object contain key-values to be added as custom headers in the request.
The HTTP method, like "GET", "POST", etc.
Query parameters to merge with the url. Query parameters can also be part of the original url value.
A password to encode for Basic Authentication.
The absolute HTTP URL for the request.
A username to encode for Basic Authentication.
Instantiate an HTTP
object.
Generated using TypeDoc
HTTP
The HTTP and HTTPResponse objects are used to run synchronous HTTP requests to communicate with APIs, or just read pages from the web. A full set of custom settings can be passed, and all HTTP methods (GET, POST, PUT, DELETE, etc.) are supported.
Example
var http = HTTP.create(); // create HTTP object var response = http.request({ "url": "http://myurl.com/api", "method": "POST", "data": { "key":"value" }, "headers": { "HeaderName": "HeaderValue" } }); if (response.success) { var text = response.responseText; var data = response.responseData; } else { console.log(response.statusCode); console.log(response.error); }