Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(transform-runtime): document overriding corejs definitions #2043

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(transform-runtime): document overriding corejs definitions #2043

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
32 changes: 31 additions & 1 deletion docs/plugin-transform-runtime.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ require("@babel/core").transform("code", {

### `corejs`

`false`, `2`, `3` or `{ version: 2 | 3, proposals: boolean }`, defaults to `false`.
`false`, `2`, `3` or `{ version: 2 | 3, proposals: boolean, definitions?: Object }`, defaults to `false`.

e.g. `['@babel/plugin-transform-runtime', { corejs: 3 }],`

Expand All @@ -106,6 +106,36 @@ This option requires changing the dependency used to provide the necessary runti
| `2` | `npm install --save @babel/runtime-corejs2` |
| `3` | `npm install --save @babel/runtime-corejs3` |

If needed, you can customize the `core-js` polyfill definitions that `@babel/plugin-transform-runtime` uses during transformations by specifying the `definitions` key to override [the defaults](https://github.com/babel/babel/blob/master/packages/babel-plugin-transform-runtime/src/runtime-corejs3-definitions.js).

For example, to disable polyfilling the `Symbol` built-in, all Array static methods and `String.prototype.repeat` instance method:

```json
{
"plugins": [
[
"@babel/plugin-transform-runtime",
{
"corejs": {
"version": 3,
"definitions": {
"BuiltIns": {
"Symbol": false
},
"StaticProperties": {
"Array": false
},
"InstanceProperties": {
"repeat": false
}
}
}
}
]
]
}
```

### `helpers`

`boolean`, defaults to `true`.
Expand Down