Skip to content
This repository has been archived by the owner on May 29, 2018. It is now read-only.

Latest commit

 

History

History
74 lines (61 loc) · 2.03 KB

README.md

File metadata and controls

74 lines (61 loc) · 2.03 KB

http.js is now deprecated since the introduction and adoption of the Fetch API, which is available in most modern browsers.
For use in older browsers, we recommend a polyfill, such as GitHub's implementation.

http.js

Make AJAX/HTTP requests from client-side JavaScript.

Introduction

http.js provides a super simple, super easy way to make AJAX/HTTP requests. It's basically a few tiny functions to simplify XMLHttpRequest calls.

Usage

http.js currently all HTTP methods. GET and POST requests are supported in short-hand form.

Pass in your options to the request function (all are optional; defaults are shown):

var options = {
    async: true,
    contentType: 'text/plain',
    data: null,
    headers: {},
    method: 'GET',
    onerror: function() {},
    onload: function() {},
    onreadystatechange: function() {},
    url: './',
    props: []
}

Or use the shorthand functions get and post, which can take in a similar options object but without the need for a method.

Example usage

We can try a simple GET request:

http.get({
    url: '/api/users',
    onload: function() { console.log(JSON.parse(this.responseText)) }
});

Or a POST request:

var data = { name: 'http.js' }
http.post({
    url: '/api/things',
    data: JSON.stringify(data),
    contentType: 'application/json',
    onload: function() { console.log(JSON.parse(this.responseText)) }
});

Even a random DELETE:

http.request({
    method: 'DELETE',
    url: '/api/users/2',
    onload: function() { console.log(JSON.parse(this.status)) }
});

A request with a custom timeout:

http.get({
    url: '/api/poll',
    contentType: 'application/json',
    onload: function() { console.log(JSON.parse(this.responseText)) },
    timeout: 3,
    ontimeout: function() { console.log('Poll request timed out!') },
    props: ['timeout', 'ontimeout']
});