Skip to content

callmecavs/jax.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Jax.js

Jax.js on NPM

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.

Follow these steps to get started:

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.

import jax from 'jax.js'

Call

Jax uses Promises under the hood. Making a GET request uses the standard Promise syntax:

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

Built With Love