@fdaciuk/ajax

Ajax

Ajax module in Vanilla JS

You can use this module with AMD, CommonJS or just like a method of window object!

Installation

Bower

You can install via bower:

bower install ajax

Manual installation

Just download dist/ajax.min.js file, and add dist/ajax.min.js on your HTML file:

<script src="js/ajax.min.js"></script>

CommonJS (via NPM)

npm i --save @fdaciuk/ajax

CDN

You can just add the following line to your HTML file:

<script src="https://cdnjs.cloudflare.com/ajax/libs/fdaciuk-ajax/0.0.15/ajax.min.js"></script>

Usage

AMD

define([ 'Ajax' ], function( Ajax ) {
  var ajax = new Ajax();
  ...
});

CommonJS

var Ajax = require( '@fdaciuk/ajax' );
var ajax = new Ajax();
...

Method of window object

var ajax = new window.Ajax();

or

var ajax = new Ajax();

Enjoy ;)

Methods

get(url)

Get data as a JSON object.

var ajax = new Ajax();
ajax.get( '/api/users' );
ajax.get( '/api/users/john' );

post(url, [ data ])

Save a new register or update part of this one.

var ajax = new Ajax();
ajax.post( '/api/users', { slug: 'john' });

put(url, [ data ])

Update an entire register.

var ajax = new Ajax();
ajax.put( '/api/users', { slug: 'john', age: 37 });

delete(url, [ data ])

Delete a register.

var ajax = new Ajax();
ajax.delete( '/api/users', { id: 1 });

Return methods

then(response, xhrObject)

Promise that returns if the request was successful.

var ajax = new Ajax();
ajax.get( '/api/users' ).then(function( response, xhr ) {
  // Do something
});

catch(response, xhrObject)

Promise that returns if the request has an error.

var ajax = new Ajax();
ajax.post( '/api/users', { slug: 'john' }).catch(function( response, xhr ) {
  // Do something
});

always(response, xhrObject)

That promise always returns, independent if the status is done or error.

var ajax = new Ajax();
ajax.post( '/api/users', { slug: 'john' }).always(function( response, xhr ) {
  // Do something
});

Deprecated return methods

done(response, xhrObject)

Promise that returns if the request was successful.

done is deprecated. Use then instead.

var ajax = new Ajax();
ajax.get( '/api/users' ).done(function( response, xhr ) {
  // Do something
});

error(response, xhrObject)

Promise that returns if the request has an error.

error is deprecated. Use catch instead.

var ajax = new Ajax();
ajax.post( '/api/users', { slug: 'john' }).error(function( response, xhr ) {
  // Do something
});

Contributing

Check CONTRIBUTING.md

Code coverage and Statistics

https://github.com/reportz/ajax

License

MIT © Fernando Daciuk