# babel-plugin-polyfill-es-shims

## Install

Using npm:

```sh
npm install --save-dev babel-plugin-polyfill-es-shims
```

or using yarn:

```sh
yarn add babel-plugin-polyfill-es-shims --dev
```

## Usage

Add this plugin to your Babel configuration:

```json
{
  "plugins": [["polyfill-es-shims", { "method": "usage-pure" }]]
}
```

This package supports the `usage-pure` and `usage-global` methods.

## Supported polyfills

This polyfill provider is compatible with polyfills that follow the [`es-shims-api`](https://github.com/es-shims/es-shim-api) specification. Those polyfills must live under the [`@es-shims`](https://github.com/es-shims) organization, but for historical reasons some of them are owned by different people: they are explicitly marked as such in the following tables.

<!--
### Proposals (Stage 3)

| Builtin object or function                                                         | Package name                                                                                                             | Owner |
| :--------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------- | :---- |
| `ArrayBuffer.prototype.detached`                                                   | [`arraybuffer.prototype.detached`](https://github.com/es-shims/ArrayBuffer.prototype.detached)                           |
| `ArrayBuffer.prototype.transfer`                                                   | [`arraybuffer.prototype.transfer`](https://github.com/es-shims/ArrayBuffer.prototype.transfer)                           |
| `ArrayBuffer.prototype.transferToFixedLength`                                      | [`arraybuffer.prototype.transfertofixedlength`](https://github.com/es-shims/ArrayBuffer.prototype.transferToFixedLength) |
| `DisposableStack`, `AsyncDisposableStack`, `Symbol.dispose`, `Symbol.asyncDispose` | [`disposablestack`](https://github.com/es-shims/DisposableStack)                                                         |
| `Iterator`, `Iterator.from`, `Iterator.prototype.*` helpers                        | [`es-iterator-helpers`](https://github.com/es-shims/iterator-helpers)                                                    |
| `Promise.withResolvers`                                                            | [`promise.withresolvers`](https://github.com/es-shims/Promise.withResolvers)                                             |
| `Set.prototype.difference`                                                         | [`set.prototype.difference`](https://github.com/es-shims/Set.prototype.difference)                                       |
| `Set.prototype.intersection`                                                       | [`set.prototype.intersection`](https://github.com/es-shims/Set.prototype.intersection)                                   |
| `Set.prototype.isDisjointFrom`                                                     | [`set.prototype.isDisjointFrom`](https://github.com/es-shims/Set.prototype.isDisjointFrom)                               |
| `Set.prototype.isSubsetOf`                                                         | [`set.prototype.isSubsetOf`](https://github.com/es-shims/Set.prototype.isSubsetOf)                                       |
| `Set.prototype.isSupersetOf`                                                       | [`set.prototype.isSupersetOf`](https://github.com/es-shims/Set.prototype.isSupersetOf)                                   |
| `Set.prototype.symmetricDifference`                                                | [`set.prototype.symmetricDifference`](https://github.com/es-shims/Set.prototype.symmetricDifference)                     |
| `Set.prototype.union`                                                              | [`set.prototype.union`](https://github.com/es-shims/Set.prototype.union)                                                 |
| `SuppressedError`                                                                  | [`suppressed-error`](https://github.com/es-shims/SuppressedError)                                                        |
-->

### ES2024

| Builtin object or function      | Package name                                                                                 | Owner |
| :------------------------------ | :------------------------------------------------------------------------------------------- | :---- |
| `String.prototype.isWellFormed` | [`string.prototype.iswellformed`](https://github.com/es-shims/String.prototype.isWellFormed) |
| `String.prototype.toWellFormed` | [`string.prototype.towellformed`](https://github.com/es-shims/String.prototype.toWellFormed) |

### ES2023

| Builtin object or function      | Package name                                                                                 | Owner |
| :------------------------------ | :------------------------------------------------------------------------------------------- | :---- |
| `Array.prototype.findLast`      | [`array.prototype.findlast`](https://github.com/es-shims/Array.prototype.findLast)           |
| `Array.prototype.findLastIndex` | [`array.prototype.findlastindex`](https://github.com/es-shims/Array.prototype.findLastIndex) |
| `Array.prototype.toReversed`    | [`array.prototype.toreversed`](https://github.com/es-shims/Array.prototype.toReversed)       |
| `Array.prototype.toSorted`      | [`array.prototype.tosorted`](https://github.com/es-shims/Array.prototype.toSorted)           |
| `Array.prototype.toSpliced`     | [`array.prototype.tospliced`](https://github.com/es-shims/Array.prototype.toSpliced)         |
| `Array.prototype.with`          | [`array.prototype.with`](https://github.com/es-shims/Array.prototype.with)                   |

### ES2022

| Builtin object or function | Package name                                                             | Owner |
| :------------------------- | :----------------------------------------------------------------------- | :---- |
| `Array.prototype.at`       | [`array.prototype.at`](https://github.com/es-shims/Array.prototype.at)   |
| `Error`'s `cause` property | [`error-cause`](https://github.com/es-shims/error-cause)                 |
| `Object.hasOwn`            | [`object.hasown`](https://github.com/es-shims/object.hasown)             |
| `String.prototype.at`      | [`string.prototype.at`](https://github.com/es-shims/String.prototype.at) |

### ES2021

| Builtin object or function           | Package name                                                                             | Owner |
| :----------------------------------- | :--------------------------------------------------------------------------------------- | :---- |
| `AggregateError` (for `Promise.any`) | [`es-aggregate-error`](https://github.com/es-shims/AggregateError)                       |
| `Promise.any`                        | [`promise.any`](https://github.com/es-shims/Promise.any)                                 |
| `String.prototype.replaceAll`        | [`string.prototype.replaceall`](https://github.com/es-shims/String.prototype.replaceAll) |

### ES2020

| Builtin object or function  | Package name                                                                       | Owner |
| :-------------------------- | :--------------------------------------------------------------------------------- | :---- |
| `globalThis`                | [`globalthis`](https://github.com/es-shims/globalThis)                             |
| `Promise.allSettled`        | [`promise.allsettled`](https://github.com/es-shims/Promise.allSettled)             |
| `String.prototype.matchAll` | [`string.prototype.matchall`](https://github.com/ljharb/String.prototype.matchAll) |

### ES2019

| Builtin object or function     | Package name                                                                               | Owner |
| :----------------------------- | :----------------------------------------------------------------------------------------- | :---- |
| `Array.prototype.flat`         | [`array.prototype.flat`](https://github.com/es-shims/Array.prototype.flat)                 |
| `Array.prototype.flatMap`      | [`array.prototype.flatmap`](https://github.com/es-shims/Array.prototype.flatMap)           |
| `Object.fromEntries`           | [`object.fromentries`](https://github.com/es-shims/Object.fromEntries)                     |
| `String.prototype.trimStart`   | [`string.prototype.trimstart`](https://github.com/es-shims/String.prototype.trimStart)     |
| `String.prototype.trimEnd`     | [`string.prototype.trimend`](https://github.com/es-shims/String.prototype.trimEnd)         |
| `String.prototype.trimLeft`    | [`string.prototype.trimleft`](https://github.com/es-shims/String.prototype.trimLeft)       |
| `String.prototype.trimRight`   | [`string.prototype.trimright`](https://github.com/es-shims/String.prototype.trimRight)     |
| `Symbol.prototype.description` | [`symbol.prototype.description`](https://github.com/es-shims/Symbol.prototype.description) |

### ES2018

| Builtin object or function  | Package name                                                                         | Owner |
| :-------------------------- | :----------------------------------------------------------------------------------- | :---- |
| `Promise.prototype.finally` | [`promise.prototype.finally`](https://github.com/es-shims/Promise.prototype.finally) |

### ES2017

| Builtin object or function         | Package name                                                                                       | Owner |
| :--------------------------------- | :------------------------------------------------------------------------------------------------- | :---- |
| `Object.values`                    | [`object.values`](https://github.com/es-shims/Object.values)                                       |
| `Object.entries`                   | [`object.entries`](https://github.com/es-shims/Object.entries)                                     |
| `Object.getOwnPropertyDescriptors` | [`object.getownpropertydescriptors`](https://github.com/es-shims/object.getownpropertydescriptors) |
| `String.prototype.padStart`        | [`string.prototype.padstart`](https://github.com/es-shims/String.prototype.padStart)               |
| `String.prototype.padEnd`          | [`string.prototype.padend`](https://github.com/es-shims/String.prototype.padEnd)                   |

### ES2016

| Builtin object or function | Package name                                                   | Owner |
| :------------------------- | :------------------------------------------------------------- | :---- |
| `Array.prototype.includes` | [`array-includes`](https://github.com/es-shims/array-includes) |

### ES2015 (ES6)

> ⚠️ This provider fully supports ES2016+ polyfills, but we are still working on ES5 and ES6 support. You can find the list of missing polyfills at [`missing-polyfills.md`](./missing-polyfills.md).

| Builtin object or function                  | Package name                                                                                    | Owner                                              |
| :------------------------------------------ | :---------------------------------------------------------------------------------------------- | :------------------------------------------------- |
| `Array.from`                                | [`array.from`](https://github.com/mathiasbynens/Array.from)                                     | [@mathiasbynens](https://github.com/mathiasbynens) |
| `Array.of`                                  | [`array.of`](https://github.com/mathiasbynens/Array.of)                                         | [@mathiasbynens](https://github.com/mathiasbynens) |
| `Array.prototype.concat` (updated from ES5) | [`array.prototype.concat`](https://github.com/es-shims/Array.prototype.concat)                  |
| `Array.prototype.copyWithin`                | [`array.prototype.copywithin`](https://github.com/es-shims/Array.prototype.copyWithin)          |
| `Array.prototype.entries`                   | [`array.prototype.entries`](https://github.com/es-shims/Array.prototype.entries)                |
| `Array.prototype.find`                      | [`array.prototype.find`](https://github.com/paulmillr/Array.prototype.find)                     | [@paulmillr](https://github.com/paulmillr)         |
| `Array.prototype.findIndex`                 | [`array.prototype.findindex`](https://github.com/paulmillr/Array.prototype.findIndex)           | [@paulmillr](https://github.com/paulmillr)         |
| `Array.prototype.keys`                      | [`array.prototype.keys`](https://github.com/es-shims/Array.prototype.keys)                      |
| `Array.prototype.splice` (updated from ES5) | [`array.prototype.splice`](https://github.com/es-shims/Array.prototype.splice)                  |
| `Array.prototype.values`                    | [`array.prototype.values`](https://github.com/es-shims/Array.prototype.values)                  |
| `Function.prototype.name`                   | [`function.prototype.name`](https://github.com/es-shims/Function.prototype.name)                |
| `Math.acosh`                                | [`math.acosh`](https://github.com/es-shims/Math.acosh)                                          |
| `Math.atanh`                                | [`math.atanh`](https://github.com/es-shims/Math.atanh)                                          |
| `Math.clz32`                                | [`math.clz32`](https://github.com/es-shims/Math.clz32)                                          |
| `Math.cbrt`                                 | [`math.cbrt`](https://github.com/es-shims/Math.cbrt)                                            |
| `Math.fround`                               | [`math.fround`](https://github.com/es-shims/Math.fround)                                        |
| `Math.imul`                                 | [`math.log1p`](https://github.com/es-shims/Math.imul)                                           |
| `Math.log10`                                | [`math.log1p`](https://github.com/es-shims/Math.log10)                                          |
| `Math.log1p`                                | [`math.log1p`](https://github.com/es-shims/Math.log1p)                                          |
| `Math.sign`                                 | [`math.sign`](https://github.com/es-shims/Math.sign)                                            |
| `Number.isNaN`                              | [`number.isnan`](https://github.com/es-shims/Number.isNaN)                                      |
| `Object.assign`                             | [`object.assign`](https://github.com/ljharb/object.assign)                                      | [@ljharb](https://github.com/ljharb)               |
| `Object.getPrototypeOf`                     | [`object.getprototypeof`](https://github.com/es-shims/Object.getPrototypeOf)                    |
| `Object.is`                                 | [`object-is`](https://github.com/es-shims/object-is)                                            |
| `Reflect.apply`                             | [`reflect.apply`](https://github.com/es-shims/Reflect.apply)                                    |
| `Reflect.getPrototypeOf`                    | [`reflect.getprototypeof`](https://github.com/es-shims/Reflect.getPrototypeOf)                  |
| `Reflect.ownKeys`                           | [`reflect.ownkeys`](https://github.com/es-shims/Reflect.ownKeys)                                |
| `RegExp.prototype.flags`                    | [`regexp.prototype.flags`](https://github.com/es-shims/RegExp.prototype.flags)                  |
| `String.fromCodePoint`                      | [`string.fromcodepoint`](https://github.com/mathiasbynens/String.fromCodePoint)                 | [@mathiasbynens](https://github.com/mathiasbynens) |
| `String.raw`                                | [`string.raw`](https://github.com/es-shims/String.raw)                                          |
| `String.prototype.codePointAt`              | [`string.prototype.codepointat`](https://github.com/mathiasbynens/String.prototype.codePointAt) | [@mathiasbynens](https://github.com/mathiasbynens) |
| `String.prototype.endsWith`                 | [`string.prototype.endswith`](https://github.com/mathiasbynens/String.prototype.endsWith)       | [@mathiasbynens](https://github.com/mathiasbynens) |
| `String.prototype.includes`                 | [`string.prototype.includes`](https://github.com/mathiasbynens/String.prototype.includes)       | [@mathiasbynens](https://github.com/mathiasbynens) |
| `String.prototype.repeat`                   | [`string.prototype.repeat`](https://github.com/mathiasbynens/String.prototype.repeat)           | [@mathiasbynens](https://github.com/mathiasbynens) |
| `String.prototype.startWith`                | [`string.prototype.startwith`](https://github.com/mathiasbynens/String.prototype.startsWith)    | [@mathiasbynens](https://github.com/mathiasbynens) |
| Annex B `String.prototype.*`                | [`es-string-html-methods`](https://github.com/es-shims/es-string-html-methods)                  |

### ES5

> ⚠️ This provider fully supports ES2016+ polyfills, but we are still working on ES5 and ES6 support. You can find the list of missing polyfills at [`missing-polyfills.md`](./missing-polyfills.md).

| Builtin object or function       | Package name                                                                                   | Owner |
| :------------------------------- | :--------------------------------------------------------------------------------------------- | :---- |
| `parseInt`                       | [`parseint`](https://github.com/es-shims/parseInt)                                             |
| `Array.prototype.every`          | [`array.prototype.every`](https://github.com/es-shims/Array.prototype.every)                   |
| `Array.prototype.indexOf`        | [`array.prototype.indexof`](https://github.com/es-shims/Array.prototype.indexOf)               |
| `Array.prototype.lastIndexOf`    | [`array.prototype.lastindexof`](https://github.com/es-shims/Array.prototype.lastIndexOf)       |
| `Array.prototype.map`            | [`array.prototype.map`](https://github.com/es-shims/Array.prototype.map)                       |
| `Array.prototype.reduce`         | [`array.prototype.reduce`](https://github.com/es-shims/Array.prototype.reduce)                 |
| `Array.prototype.reduceRight`    | [`array.prototype.reduceright`](https://github.com/es-shims/Array.prototype.reduceRight)       |
| `Array.prototype.some`           | [`array.prototype.some`](https://github.com/es-shims/Array.prototype.some)                     |
| `Number.prototype.toExponential` | [`number.prototype.toexponential`](https://github.com/es-shims/Number.prototype.toExponential) |
| `Object.defineProperties`        | [`object.defineproperties`](https://github.com/es-shims/Object.defineProperties)               |
| `String.prototype.split`         | [`string.prototype.split`](https://github.com/es-shims/String.prototype.split)                 |
| `String.prototype.substr`        | [`string.prototype.substr`](https://github.com/es-shims/String.prototype.substr)               |
| `String.prototype.trim`          | [`string.prototype.trim`](https://github.com/es-shims/String.prototype.trim)                   |
