README.md

najax

Fast, flexible, unit-tested jquery-ajax-stye serverside requests.

jQuery ajax is stupid simple. This project provides a lightweight wrapper for the nodejs http request object that enables jquery ajax style syntax when making serverside requests to other webpages in node.js

It features very flexible method overloads to suit various styles, including with jquery style deferreds.

It seamlessly handles ssl and makes some reasonable assumptions based on inputs but as usual everything can be overridden by passing an options object.

Changelog

0.2.0

Breaking changes!

• success and error callback arguments are now in jQuery.ajax order and format.
• contentType must now be the full string, i.e. application/json, not just json.
• Undocumented encoder option deprecated. Any object can already override its own toString().
• CRLF (\n) removed from end of POST message body. It did not match HTTP spec.

Getting Started

Install the module with: npm install najax

var najax = require('najax');
najax('http://www.google.com', function(html){ console.log(html); }); // "awesome"
najax('http://www.google.com', { type:'POST' }, function(html){ console.log(html); }); // "awesome"
najax({ url:'http://www.google.com', type:'POST', success: function(html){ console.log(html); }); // "awesome"
najax({ url:'http://www.google.com', type:'POST' }).success(function(resp){}).error(function(err){}); // "awesome"

najax.get, najax.post, najax.put, najax.delete...

Run unit tests

• cd dir
• npm -g install grunt
• npm install
• grunt test

Examples

(Coming soon)

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

License

Copyright (c) 2012-2015 Alan Clarke Licensed under the MIT license.