parrot-module-ajax

Make easy do AJAX petitions with different backend. Using with URL module for better experience.

Browser Compatibility

Install

npm install myModule --save

Get Started

This module makes easier to use an AJAX handler.

Documentation

parrot

.ajax(<Object> or <String>)

Returns the result of AJAX request.

The default options for any ajax request are:

method       : 'get'
send         : {}
headers      : {}
async        : true
datatype     : 'json'
content_type : 'application/x-www-form-urlencoded'

Using URL Objects

There are different ways to provide the URL of the AJAX request, but the most common pattern is to give a parrot.url object:

parrot.url.ajax parrot.url.login(), (err, result) ->

If you want to write less code:

parrot.url.ajax 'login', (err, result) ->

You may need to modify the settings of the URL Object before the ajax request:

parrot.url.ajax parrot.url.login(send:user), (err, result) ->

A short version could be:

parrot.url.ajax 'login', send:user, (err, result) ->

Using simple URL's

Also, you can provide a URL that you are not registering but that follows a parrot.url similar interface (extra field for the url because it is not calculated based on the parrot.environment).

object = url: 'http://echo.jsontest.com/key/value/one/two', method: 'GET'
parrot.url.ajax object, (err, result) ->

Is it possible a shorter version of this piece of code? Of course!

parrot.url.ajax 'http://echo.jsontest.com/key/value/one/two', (err, result) ->

There is no problem if you need to specify another options of the AJAX or as URL Object:

parrot.url.ajax 'http://echo.jsontest.com/key/value/one/two', async:false, send:user (err, result) ->

License

MIT © ParrotJS