Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/callmecavs/jax.js
A tiny Promise wrapper for GET requests.
https://github.com/callmecavs/jax.js
ajax get promise request xmlhttprequest
Last synced: 15 days ago
JSON representation
A tiny Promise wrapper for GET requests.
- Host: GitHub
- URL: https://github.com/callmecavs/jax.js
- Owner: callmecavs
- License: mit
- Created: 2015-11-09T17:24:07.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-01-27T16:18:37.000Z (almost 8 years ago)
- Last Synced: 2024-12-26T11:33:13.756Z (29 days ago)
- Topics: ajax, get, promise, request, xmlhttprequest
- Language: JavaScript
- Homepage:
- Size: 26.4 KB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jax.js
[](https://www.npmjs.com/package/jax.js)
A tiny Promise wrapper for GET requests.
## Usage
Jax was developed with a modern JavaScript workflow in mind. To use it, it's recommended you have a build system in place that can transpile ES6, and bundle modules. For a minimal boilerplate that does so, check out [outset](https://github.com/callmecavs/outset).
Follow these steps to get started:
* [Install](#install)
* [Import](#import)
* [Call](#call)
### Install
Using NPM, install Jax.js, and add it to your package.json dependencies.
```
$ npm install jax.js --save
```
### Import
Import Jax from `node_modules`, naming it whatever you prefer.
```es6
import jax from 'jax.js'
```
### Call
Jax uses [Promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) under the hood. Making a GET request uses the standard Promise syntax:
```es6
jax('url')
.then(response => {
// the request is done, and the status === 200
// ...
})
.catch(status => {
// the request is done, but the status !== 200
// ...
})
```
Because `then` returns a Promise, you can chain it.
## Browser Support
Targeting evergreen browsers. Note that **IE does not natively support Promises, but Edge does.**
## License
MIT. © 2016 Michael Cavalea
[](http://forthebadge.com)