Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 1.39 KB

README.md

File metadata and controls

70 lines (44 loc) · 1.39 KB
Raw

Brodo.js

Brodo.js a minimal, lightweight and fast ajax library written in vanilla js

##Getting Started

Just include the brodo.js file in you project:

<script src="lib/brodo.js"></script>

There are 4 methods available, each of them can take one argument: params.

####API

get(params)

getJSON(params)

post(params)

ajax(params)

####Params Params can be a URL string or an object, in this case can contains the following keys:

url: a valid string URL [REQUIRED],

method: any valid HTTP method. Default: GET,

body: if defined must be a js object,

headers: headers, if defined, must be a js object with valid header key and values,

callback: callback is a function that will be called once the state of the request is DONE. It should be in node-style callback(err, res)

Example:

params = {
    url: 'http://api.example.com',
    method: 'POST',
    body: {key1: value, key2: value ... }
    headers: {'Authorization ': 'OAuth ' + access_token, 'Content-Type': 'application/json'},
    callback: function(error, response) {
        console.log(arguments)
    }
}

Examples

Brodo.ajax({
  url: 'https://api.github.com/zen',
  callback: function(err, res) {console.log(arguments)}
})

or simply

Brodo.ajax('https://api.github.com/zen');

Version

0.1

License

MIT