File: app/js/es6-promise/README.md

Recommend this page to a friend!
  Classes of Sergey Beskorovayniy   Vuex Examples   app/js/es6-promise/README.md   Download  
File: app/js/es6-promise/README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: Vuex Examples
Example apps using Vuex state management pattern
Author: By
Last change: Update of app/js/es6-promise/README.md
Date: 2 years ago
Size: 2,193 bytes
 

Contents

Class file image Download

ES6-Promise (subset of rsvp.js)

This is a polyfill of the ES6 Promise. The implementation is a subset of rsvp.js extracted by @jakearchibald, 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 <a href="http://www.html5rocks.com/en/tutorials/es6/promises/">JavaScript Promises HTML5Rocks article</a>.

Downloads

Node.js

To install:

npm install es6-promise

To use:

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

Bower

To install:

bower install es6-promise --save

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' {
  // ...
});

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

You will need to have PhantomJS installed globally in order to run the tests.

npm install -g phantomjs

  • `npm run build` to build
  • `npm test` to run tests
  • `npm start` to run a build watcher, and webserver to test
  • `npm run test:server` for a testem test runner and watching builder