Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HTTP

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);
}

Hierarchy

  • HTTP

Index

Constructors

Methods

Constructors

constructor

Methods

request

  • request(settings: { data?: {}; encoding?: "json" | "form"; headers?: {}; method: string; parameters?: {}; password?: string; url: string; username?: string }): HTTPResponse

  • Parameters

    • settings: { data?: {}; encoding?: "json" | "form"; headers?: {}; method: string; parameters?: {}; password?: string; url: string; username?: string }

      An object configuring the request.

      • Optional data?: {}

        An object containing data to be encoded into the HTTP body of the request.

        • [x: string]: string
      • Optional encoding?: "json" | "form"

        Format to encode data in the body of request.

      • Optional headers?: {}

        An object contain key-values to be added as custom headers in the request.

        • [x: string]: string
      • method: string

        The HTTP method, like "GET", "POST", etc.

      • Optional parameters?: {}

        Query parameters to merge with the url. Query parameters can also be part of the original url value.

        • [x: string]: string
      • Optional password?: string

        A password to encode for Basic Authentication.

      • url: string

        The absolute HTTP URL for the request.

      • Optional username?: string

        A username to encode for Basic Authentication.

    Returns HTTPResponse

Static create

Generated using TypeDoc