tree: b832045a31fe81c6f766c356fb0c70e1055ec30c [path history] [tgz]
  1. .release.json
  2. Brocfile.js
  3. CHANGELOG.md
  4. LICENSE
  5. README.md
  6. bin/
  7. bower.json
  8. config/
  9. dist/
  10. lib/
  11. package.json
  12. server/
  13. testem.json
node_modules/es6-promise/README.md

ES6-Promise (subset of rsvp.js)

This is a polyfill of the ES6 Promise. The implementation is a subset of rsvp.js, if you're wanting extra features and more debugging options, check out the full library.

For API details and how to use promises, see the JavaScript Promises HTML5Rocks article.

Downloads

Node.js

To install:

npm install es6-promise

To use:

var Promise = require('es6-promise').Promise;

Usage in IE<9

catch is a reserved word in IE<9, meaning promise.catch(func) throws a syntax error. To work around this, you can use a string to access the property as shown in the following example.

However, please remember that such technique is already provided by most common minifiers, making the resulting code safe for old browsers and production:

promise['catch'](function(err) {
  // ...
});

Or use .then instead:

promise.then(undefined, function(err) {
  // ...
});

Auto-polyfill

To polyfill the global environment (either in Node or in the browser via CommonJS) use the following code snippet:

require('es6-promise').polyfill();

Notice that we don't assign the result of polyfill() to any variable. The polyfill() method will patch the global environment (in this case to the Promise name) when called.

Building & Testing

  • npm run build-all && npm test - Run Mocha tests through Node and PhantomJS.