57 lines
1.5 KiB
Markdown
57 lines
1.5 KiB
Markdown
---
|
|
layout: docs
|
|
title: Polyfill
|
|
description: How to use the Polyfill.
|
|
permalink: /docs/usage/polyfill/
|
|
---
|
|
|
|
<p class="lead">
|
|
6to5 includes a polyfill that includes a custom
|
|
<a href="https://github.com/facebook/regenerator/blob/master/runtime.js">regenerator runtime</a>
|
|
and <a href="https://github.com/zloirock/core-js">core.js</a>.
|
|
</p>
|
|
|
|
This will emulate a full ES6 environment. This polyfill is automatically loaded
|
|
when using `6to5-node` and `6to5/register`.
|
|
|
|
## Usage in Node/Browserify
|
|
|
|
You need to include the polyfill require at the top the **entry point** to
|
|
your application.
|
|
|
|
```js
|
|
require('6to5/polyfill');
|
|
```
|
|
|
|
Fortunately, this is automatically loaded when using:
|
|
|
|
```js
|
|
require('6to5/register');
|
|
```
|
|
|
|
## Usage in Browser
|
|
|
|
Available from the `browser-polyfill.js` file within the 6to5 directory of an
|
|
npm release. This needs to be included **before** all your compiled 6to5 code.
|
|
You can either prepend it to your compiled code or include it in a `<script>`
|
|
before it.
|
|
|
|
**NOTE:** Do not `require` this via browserify etc, use `6to5/polyfill`.
|
|
|
|
<blockquote class="to5-callout to5-callout-warning">
|
|
<h4>Polyfills are not perfect</h4>
|
|
<p>
|
|
Due to limitations in various ES5 environments not every polyfill will work
|
|
in every environment.
|
|
</p>
|
|
</blockquote>
|
|
|
|
<blockquote class="to5-callout to5-callout-warning">
|
|
<h4>Certain polyfills not included</h4>
|
|
<p>
|
|
Certain polyfills are too large/complex for their implemented features to
|
|
justify including them for all builds. You may have to include additional
|
|
polyfills for a subset of ES6 features.
|
|
</p>
|
|
</blockquote>
|