clarify polyfill usage

This commit is contained in:
Sebastian McKenzie 2014-11-23 15:17:49 +11:00
parent c7965df42d
commit 4097da09bd
2 changed files with 16 additions and 15 deletions

View File

@ -1,19 +1,15 @@
# Caveats # Caveats
## Async/Generators In order for certain features to work they require certain polyfills. You can
satisfy **all** 6to5 feature requirements by using the included
[polyfill](polyfill.md). You may alternatively selectively include what you need:
The [regenerator runtime](https://github.com/facebook/regenerator/blob/master/runtime.js) | Feature | Requirements |
and an [ES6 polyfill](polyfill.md) are required in order for generators to work. | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| Array destructuring | `Array.isArray`, `Array.from` |
### Async/Comprehensions | Async functions, Generators | [experimental option](usage.md#experimental), [regenerator runtime](https://github.com/facebook/regenerator/blob/master/runtime.js) |
| Comprehensions | [experimental option](usage.md#experimental), `Array.isArray`, `Array.from` |
[Experimental support](usage.md#experimental) must be enabled for these proposed | Spread | `Array.isArray`, `Array.from` |
ES7 features to work.
### Array comprehension/Array destructuring/Spread
An [ES6 polyfill](polyfill.md) is required. More specifically a polyfill for
`Array.isArray` and `Array.from`.
## Classes ## Classes

View File

@ -5,13 +5,18 @@
[es6-shim](https://github.com/paulmillr/es6-shim) and [es6-shim](https://github.com/paulmillr/es6-shim) and
[es6-symbol](https://github.com/medikoo/es6-symbol) polyfills. [es6-symbol](https://github.com/medikoo/es6-symbol) polyfills.
## Node This will emulate a full ES6 environment. This polyfill is automatically loaded
when using [6to5-node](usage.md#node).
## Usage
### Node
```javascript ```javascript
require("6to5/polyfill"); require("6to5/polyfill");
``` ```
## Browser ### Browser
Available from the `browser-polyfill.js` file within the 6to5 directory of an Available from the `browser-polyfill.js` file within the 6to5 directory of an
npm release. npm release.