litespeed.js/docs/services/http.md

Lite & fast micro javascript framework that is easy to learn

# HTTP

The HTTP service allows you to create HTTP calls and receive Javascript promises to manage your call response results.

All of Litespeed.js internal HTTP calls used by the framework are managed by the HTTP service.

Currently the HTTP service uses the XMLHttpRequest API to handle all HTTP calls but in future releases we do intend to start using the newer Fetch API. 

## API

- [get(url)](#get)
- [post(url, headers, payload)](#post)
- [put(url, headers, payload)](#put)
- [patch(url, headers, payload)](#patch)
- [delete(url)](#delete)
- [addGlobalParam(key, value)](#addGlobalParam)
- [addGlobalHeader(key, value)](#addGlobalHeader)

### get

Make and HTTP GET request

Param | Type | Description
--- | --- | ---
**url** | string | HTTP URL to the resource you want to request

#### Return Value

This method returns a Javascript [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) object.

#### Example

```js
http.get('https://example.com')
    .then(function (response) {
            // Handle Success
        }, function (error) {
            // Handle Error
        }
    );
```

### post

Make and HTTP POST request

Param | Type | Description
--- | --- | ---
**url** | string | HTTP URL to the resource you want to request
**headers** | object | HTTP headers object combined from key and values
**payload** | string | HTTP payload

#### Return Value

This method returns a Javascript [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) object.

#### Example

```js
http.post('https://example.com/resource', {'Content-type': 'application/json'}, '{name: "John", age: 31, city: "New York"}')
    .then(function (response) {
            // Handle Success
        }, function (error) {
            // Handle Error
        }
    );
```

### put

Make and HTTP PUT request

Param | Type | Description
--- | --- | ---
**url** | string | HTTP URL to the resource you want to request
**headers** | object | HTTP headers object combined from key and values
**payload** | string | HTTP payload

#### Return Value

This method returns a Javascript [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) object.

#### Example

```js
http.put('https://example.com/resource', {'Content-type': 'application/json'}, '{name: "John", age: 31, city: "New York"}')
    .then(function (response) {
            // Handle Success
        }, function (error) {
            // Handle Error
        }
    );
```

### patch

Make and HTTP PATCH request

Param | Type | Description
--- | --- | ---
**url** | string | HTTP URL to the resource you want to request
**headers** | object | HTTP headers object combined from key and values
**payload** | string | HTTP payload

#### Return Value

This method returns a Javascript [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) object.

#### Example

```js
http.patch('https://example.com/resource', {'Content-type': 'application/json'}, '{name: "John", age: 31, city: "New York"}')
    .then(function (response) {
            // Handle Success
        }, function (error) {
            // Handle Error
        }
    );
```

### delete

Make and HTTP DELETE request

Param | Type | Description
--- | --- | ---
**url** | string | HTTP URL to the resource you want to request

#### Return Value

This method returns a Javascript [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) object.

#### Example

```js
http.delete('https://example.com/resource')
    .then(function (response) {
            // Handle Success
        }, function (error) {
            // Handle Error
        }
    );
```

### addGlobalParam

Add a global query param to all your HTTP requests. The parameter you will be adding using this method will be attached to any HTTP request sent using the HTTP service.

Param | Type | Description
--- | --- | ---
**key** | string | Parameter name
**value** | string | Parameter value

#### Return Value

Items New elements of the Array.

#### Example

```js
http.addGlobalParam('version', 'beta');
```

### addGlobalHeader

Add a global header to all your HTTP requests. The HEADER you will be adding using this method will be attached to any HTTP request sent using the HTTP service.

Param | Type | Description
--- | --- | ---
**key** | string | Header name
**value** | string | Header value

#### Return Value

Items New elements of the Array.

#### Example

```js
http.addGlobalHeader('Content-type', 'application/json');
```