You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
119 lines
6.6 KiB
119 lines
6.6 KiB
 |
|
|
|
[`core-js-compat` package](https://github.com/zloirock/core-js/tree/master/packages/core-js-compat) contains data about the necessity of [`core-js`](https://github.com/zloirock/core-js) modules and API for getting a list of required core-js modules by browserslist query. |
|
|
|
```js |
|
import compat from 'core-js-compat'; |
|
|
|
const { |
|
list, // array of required modules |
|
targets, // object with targets for each module |
|
} = compat({ |
|
targets: '> 1%', // browserslist query or object of minimum environment versions to support, see below |
|
modules: [ // optional list / filter of modules - regex, sting or an array of them: |
|
'core-js/actual', // - an entry point |
|
'esnext.array.unique-by', // - a module name (or just a start of a module name) |
|
/^web\./, // - regex that a module name must satisfy |
|
], |
|
exclude: [ // optional list / filter of modules to exclude, the signature is similar to `modules` option |
|
'web.atob', |
|
], |
|
version: '3.23', // used `core-js` version, by default - the latest |
|
}); |
|
|
|
console.log(targets); |
|
/* => |
|
{ |
|
'es.error.cause': { ios: '14.5-14.8' }, |
|
'es.aggregate-error.cause': { ios: '14.5-14.8' }, |
|
'es.array.at': { ios: '14.5-14.8' }, |
|
'es.array.find-last': { firefox: '100', ios: '14.5-14.8' }, |
|
'es.array.find-last-index': { firefox: '100', ios: '14.5-14.8' }, |
|
'es.array.includes': { firefox: '100' }, |
|
'es.array.push': { chrome: '100', edge: '101', ios: '14.5-14.8', safari: '15.4' }, |
|
'es.array.unshift': { ios: '14.5-14.8', safari: '15.4' }, |
|
'es.object.has-own': { ios: '14.5-14.8' }, |
|
'es.regexp.flags': { chrome: '100', edge: '101' }, |
|
'es.string.at-alternative': { ios: '14.5-14.8' }, |
|
'es.typed-array.at': { ios: '14.5-14.8' }, |
|
'es.typed-array.find-last': { firefox: '100', ios: '14.5-14.8' }, |
|
'es.typed-array.find-last-index': { firefox: '100', ios: '14.5-14.8' }, |
|
'esnext.array.group': { chrome: '100', edge: '101', firefox: '100', ios: '14.5-14.8', safari: '15.4' }, |
|
'esnext.array.group-by': { chrome: '100', edge: '101', firefox: '100', ios: '14.5-14.8', safari: '15.4' }, |
|
'esnext.array.group-by-to-map': { chrome: '100', edge: '101', firefox: '100', ios: '14.5-14.8', safari: '15.4' }, |
|
'esnext.array.group-to-map': { chrome: '100', edge: '101', firefox: '100', ios: '14.5-14.8', safari: '15.4' }, |
|
'esnext.array.to-reversed': { chrome: '100', edge: '101', firefox: '100', ios: '14.5-14.8', safari: '15.4' }, |
|
'esnext.array.to-sorted': { chrome: '100', edge: '101', firefox: '100', ios: '14.5-14.8', safari: '15.4' }, |
|
'esnext.array.to-spliced': { chrome: '100', edge: '101', firefox: '100', ios: '14.5-14.8', safari: '15.4' }, |
|
'esnext.array.unique-by': { chrome: '100', edge: '101', firefox: '100', ios: '14.5-14.8', safari: '15.4' }, |
|
'esnext.array.with': { chrome: '100', edge: '101', firefox: '100', ios: '14.5-14.8', safari: '15.4' }, |
|
'esnext.typed-array.to-reversed': { chrome: '100', edge: '101', firefox: '100', ios: '14.5-14.8', safari: '15.4' }, |
|
'esnext.typed-array.to-sorted': { chrome: '100', edge: '101', firefox: '100', ios: '14.5-14.8', safari: '15.4' }, |
|
'esnext.typed-array.to-spliced': { chrome: '100', edge: '101', firefox: '100', ios: '14.5-14.8', safari: '15.4' }, |
|
'esnext.typed-array.with': { chrome: '100', edge: '101', firefox: '100', ios: '14.5-14.8', safari: '15.4' }, |
|
'web.dom-exception.stack': { chrome: '100', edge: '101', ios: '14.5-14.8', safari: '15.4' }, |
|
'web.immediate': { chrome: '100', edge: '101', firefox: '100', ios: '14.5-14.8', safari: '15.4' }, |
|
'web.structured-clone': { chrome: '100', edge: '101', firefox: '100', ios: '14.5-14.8', safari: '15.4' } |
|
} |
|
*/ |
|
``` |
|
|
|
### `targets` option |
|
`targets` could be [a `browserslist` query](https://github.com/browserslist/browserslist) or a targets object that specifies minimum environment versions to support: |
|
```js |
|
// browserslist query: |
|
'defaults, not IE 11, maintained node versions' |
|
// object: |
|
{ |
|
android: '4.0', // Android WebView version |
|
chrome: '38', // Chrome version |
|
deno: '1.12', // Deno version |
|
edge: '13', // Edge version |
|
electron: '5.0', // Electron framework version |
|
firefox: '15', // Firefox version |
|
ie: '8', // Internet Explorer version |
|
ios: '13.0', // iOS Safari version |
|
node: 'current', // NodeJS version, you could use 'current' for set it to currently used |
|
opera: '12', // Opera version |
|
opera_mobile: '7', // Opera Mobile version |
|
phantom: '1.9', // PhantomJS headless browser version |
|
rhino: '1.7.13', // Rhino engine version |
|
safari: '14.0', // Safari version |
|
samsung: '14.0', // Samsung Internet version |
|
esmodules: true, // That option set target to minimum supporting ES Modules versions of all browsers |
|
browsers: '> 0.25%', // Browserslist query or object with target browsers |
|
} |
|
``` |
|
|
|
### Additional API: |
|
|
|
```js |
|
// equals of of the method from the example above |
|
require('core-js-compat/compat')({ targets, modules, version }); // => { list: Array<ModuleName>, targets: { [ModuleName]: { [EngineName]: EngineVersion } } } |
|
// or |
|
require('core-js-compat').compat({ targets, modules, version }); // => { list: Array<ModuleName>, targets: { [ModuleName]: { [EngineName]: EngineVersion } } } |
|
|
|
// full compat data: |
|
require('core-js-compat/data'); // => { [ModuleName]: { [EngineName]: EngineVersion } } |
|
// or |
|
require('core-js-compat').data; // => { [ModuleName]: { [EngineName]: EngineVersion } } |
|
|
|
// map of modules by `core-js` entry points: |
|
require('core-js-compat/entries'); // => { [EntryPoint]: Array<ModuleName> } |
|
// or |
|
require('core-js-compat').entries; // => { [EntryPoint]: Array<ModuleName> } |
|
|
|
// full list of modules: |
|
require('core-js-compat/modules'); // => Array<ModuleName> |
|
// or |
|
require('core-js-compat').modules; // => Array<ModuleName> |
|
|
|
// the subset of modules which available in the passed `core-js` version: |
|
require('core-js-compat/get-modules-list-for-target-version')('3.23'); // => Array<ModuleName> |
|
// or |
|
require('core-js-compat').getModulesListForTargetVersion('3.23'); // => Array<ModuleName> |
|
``` |
|
|
|
If you wanna help to improve this data, you could take a look at the related section of [`CONTRIBUTING.md`](https://github.com/zloirock/core-js/blob/master/CONTRIBUTING.md#how-to-update-core-js-compat-data). The visualization of compatibility data and the browser tests runner is available [here](http://es6.zloirock.ru/compat/), the example: |
|
|
|
|
|
|