https://github.com/jacomyal/djax

A lightweight subset of jQuery.ajax
https://github.com/jacomyal/djax

Last synced: 21 days ago
JSON representation

A lightweight subset of jQuery.ajax

• Host: GitHub
• URL: https://github.com/jacomyal/djax
• Owner: jacomyal
• License: mit
• Created: 2014-10-17T08:48:20.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T00:09:56.000Z (almost 2 years ago)
• Last Synced: 2024-05-02T00:56:37.409Z (7 months ago)
• Language: JavaScript
• Size: 1.4 MB
• Stars: 8
• Watchers: 3
• Forks: 1
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Djax - a lightweight jQuery.ajax subset

**version: 2.1.0**

## Description

**Djax** is a subset of jQuery.ajax, with the most used features supported. It has initially been developed as domino-ajax, for dealing with REST APIs in domino.js, a JavaScript cascading controller for rich internet applications.

You can install djax from NPM: `npm install --save djax`.

If you are using jQuery, it is recommanded to use jQuery.ajax instead, which supports more features, and is probably better tested.

Here are the supported options:

- **url**: A string containing the URL to which the request is sent.

- **type**: The HTTP verb used.

- **dataType**: The type of data that you're expecting back from the server.

- **contentType**: The type of request to make, default is "GET"

- **data**: Data to be sent to the server.

- **error**: A function to be called if the request fails.

- **success**: A function to be called if the request succeeds.

- **headers**: An object of additional header key/value pairs to send along with requests using the XMLHttpRequest transport.

- **beforeSend**: A pre-request callback function that can be used to modify the XHR object before it is sent.

- **timeout**: Set a timeout (in milliseconds) for the request.

- **xhrFields**: an object whose properties will be assigned to the native XHR object, useful to enable `withCredentials` for instance.

The ajax function returns an object with the following attributes, to deal with promises:

- **xhr**: A reference to the XHR.

- **done**: An alternative construct to the success callback option.

- **fail**: An alternative construct to the error callback option.

- **then**: Incorporates the functionality of the #done and #fail methods.

I invite you to read [djax's code](./djax.js) or [jQuery.ajax documentation](http://api.jquery.com/jquery.ajax/) to know more about how this function works. To see examples, you can check the unit tests in [test/unit.js](./test/unit.js).

Finally, if you see common features that are missing or that are not implemented exactly as in jQuery 3.x, please report them on the related [Github issues page](https://github.com/jacomyal/djax/issues).