diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c1d937810c5a..fac821d56ec4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,40 +66,40 @@ File names should be in the kebab-case. Name of polyfill modules should follow t ## Testing Before testing, you should install dependencies: -``` +```sh $ npm i ``` You can run all tests by -``` +```sh $ npm run test ``` You can run parts of the test case separately: - Linting: - ``` + ```sh $ npm run lint ``` - The global version unit tests: - ``` + ```sh $ npm run test-unit-global-standalone ``` - The pure version unit tests: - ``` + ```sh $ npm run test-unit-pure-standalone ``` - [Promises/A+](https://github.com/promises-aplus/promises-tests) and [ES6 `Promise`](https://github.com/promises-es6/promises-es6) test cases: - ``` + ```sh $ npm run test-promises-standalone ``` - [ECMAScript `Observable` test case](https://github.com/tc39/proposal-observable): - ``` + ```sh $ npm run test-observables-standalone ``` - CommonJS entry points tests: - ``` + ```sh $ npm run test-entries-standalone ``` - If you want to run tests in a certain browser, at first, you should build packages and test bundles: - ``` + ```sh $ npm run bundle-standalone ``` - For running the global version of the unit test case, use this file: diff --git a/README.md b/README.md index 82e1d3ba9aab..c2ee02275f9f 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ ![logo](https://user-images.githubusercontent.com/2213682/146607186-8e13ddef-26a4-4ebf-befd-5aac9d77c090.png) -
+
[![fundraising](https://opencollective.com/core-js/all/badge.svg?label=fundraising)](https://opencollective.com/core-js) [![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/zloirock/core-js/blob/master/CONTRIBUTING.md) [![version](https://img.shields.io/npm/v/core-js.svg)](https://www.npmjs.com/package/core-js) [![core-js downloads](https://img.shields.io/npm/dm/core-js.svg?label=npm%20i%20core-js)](https://npm-stat.com/charts.html?package=core-js&package=core-js-pure&package=core-js-compat&from=2014-11-18) [![core-js-pure downloads](https://img.shields.io/npm/dm/core-js-pure.svg?label=npm%20i%20core-js-pure)](https://npm-stat.com/charts.html?package=core-js&package=core-js-pure&package=core-js-compat&from=2014-11-18) [![jsDelivr](https://data.jsdelivr.com/v1/package/npm/core-js-bundle/badge?style=rounded)](https://www.jsdelivr.com/package/npm/core-js-bundle) [![tests](https://github.com/zloirock/core-js/workflows/tests/badge.svg)](https://github.com/zloirock/core-js/actions) [![eslint](https://github.com/zloirock/core-js/workflows/eslint/badge.svg)](https://github.com/zloirock/core-js/actions)
-> Modular standard library for JavaScript. Includes polyfills for [ECMAScript up to 2023](#ecmascript): [promises](#ecmascript-promise), [symbols](#ecmascript-symbol), [collections](#ecmascript-collections), iterators, [typed arrays](#ecmascript-typed-arrays), many other features, [ECMAScript proposals](#ecmascript-proposals), [some cross-platform WHATWG / W3C features and proposals](#web-standards) like [`URL`](#url-and-urlsearchparams). You can load only required features or use it without global namespace pollution. +> Modular standard library for JavaScript. Includes polyfills for [ECMAScript up to 2023](docs/features/ecmascript/README.md): [promises](docs/features/ecmascript/Promise.md), [symbols](docs/features/ecmascript/symbol.md), [collections](docs/features/ecmascript/collections.md), iterators, [typed arrays](docs/features/ecmascript/typed-array.md), many other features, [ECMAScript proposals](docs/features/proposals/README.md), [some cross-platform WHATWG / W3C features and proposals](docs/features/web-standards/README.md) like [`URL`](docs/features/web-standards/url.md). You can load only required features or use it without global namespace pollution. **If you are looking for documentation for obsolete `core-js@2`, please, check [this branch](https://github.com/zloirock/core-js/tree/v2).** ## As advertising: the author is looking for a good job -) -## [core-js@3, babel and a look into the future](https://github.com/zloirock/core-js/tree/master/docs/2019-03-19-core-js-3-babel-and-a-look-into-the-future.md) +## [core-js@3, babel and a look into the future](docs/2019-03-19-core-js-3-babel-and-a-look-into-the-future.md) ## Raising funds @@ -28,6 +28,7 @@ --- +# Example [*Example of usage*](https://tinyurl.com/2aj9lkwf): ```js import 'core-js/actual'; // <- at the top of your entry point @@ -71,3282 +72,233 @@ structuredClone(new Set([1, 2, 3])); // => new Set([1, 2, 3]) queueMicrotask(() => console.log('called as microtask')); ``` -### Index -- [Usage](#usage) - - [Installation](#installation) - - [`postinstall` message](#postinstall-message) - - [CommonJS API](#commonjs-api) - - [Babel](#babel) - - [`@babel/polyfill`](#babelpolyfill) - - [`@babel/preset-env`](#babelpreset-env) - - [`@babel/runtime`](#babelruntime) - - [swc](#swc) - - [Configurable level of aggressiveness](#configurable-level-of-aggressiveness) - - [Custom build](#custom-build) -- [Compatibility data](#compatibility-data) -- [Supported engines](#supported-engines) -- [Features](#features) - - [ECMAScript](#ecmascript) - - [ECMAScript: Object](#ecmascript-object) - - [ECMAScript: Function](#ecmascript-function) - - [ECMAScript: Error](#ecmascript-error) - - [ECMAScript: Array](#ecmascript-array) - - [ECMAScript: String and RegExp](#ecmascript-string-and-regexp) - - [ECMAScript: Number](#ecmascript-number) - - [ECMAScript: Math](#ecmascript-math) - - [ECMAScript: Date](#ecmascript-date) - - [ECMAScript: Promise](#ecmascript-promise) - - [ECMAScript: Symbol](#ecmascript-symbol) - - [ECMAScript: Collections](#ecmascript-collections) - - [ECMAScript: Typed Arrays](#ecmascript-typed-arrays) - - [ECMAScript: Reflect](#ecmascript-reflect) - - [ECMAScript: JSON](#ecmascript-json) - - [ECMAScript: globalThis](#ecmascript-globalthis) - - [ECMAScript proposals](#ecmascript-proposals) - - [Finished proposals](#finished-proposals) - - [`globalThis`](#globalthis) - - [Relative indexing method](#relative-indexing-method) - - [`Array.prototype.includes`](#arrayprototypeincludes) - - [`Array.prototype.flat` / `Array.prototype.flatMap`](#arrayprototypeflat--arrayprototypeflatmap) - - [`Array` find from last](#array-find-from-last) - - [`Object.values` / `Object.entries`](#objectvalues--objectentries) - - [`Object.fromEntries`](#objectfromentries) - - [`Object.getOwnPropertyDescriptors`](#objectgetownpropertydescriptors) - - [Accessible `Object.prototype.hasOwnProperty`](#accessible-objectprototypehasownproperty) - - [`String` padding](#string-padding) - - [`String.prototype.matchAll`](#stringmatchall) - - [`String.prototype.replaceAll`](#stringreplaceall) - - [`String.prototype.trimStart` / `String.prototype.trimEnd`](#stringprototypetrimstart-stringprototypetrimend) - - [`RegExp` `s` (`dotAll`) flag](#regexp-s-dotall-flag) - - [`RegExp` named capture groups](#regexp-named-capture-groups) - - [`Promise.allSettled`](#promiseallsettled) - - [`Promise.any`](#promiseany) - - [`Promise.prototype.finally`](#promiseprototypefinally) - - [`Symbol.asyncIterator` for asynchronous iteration](#symbolasynciterator-for-asynchronous-iteration) - - [`Symbol.prototype.description`](#symbolprototypedescription) - - [Well-formed `JSON.stringify`](#well-formed-jsonstringify) - - [Stage 3 proposals](#stage-3-proposals) - - [`Array` grouping](#array-grouping) - - [Change `Array` by copy](#change-array-by-copy) - - [Stage 2 proposals](#stage-2-proposals) - - [`Iterator` helpers](#iterator-helpers) - - [New `Set` methods](#new-set-methods) - - [`Map.prototype.emplace`](#mapprototypeemplace) - - [`Array.fromAsync`](#arrayfromasync) - - [`Array.isTemplateObject`](#arrayistemplateobject) - - [`Symbol.{ asyncDispose, dispose }` for `using` statement](#symbol-asyncdispose-dispose--for-using-statement) - - [`Symbol.metadataKey` for decorators metadata proposal](#symbolmetadatakey-for-decorators-metadata-proposal) - - [Stage 1 proposals](#stage-1-proposals) - - [`Observable`](#observable) - - [New collections methods](#new-collections-methods) - - [`.of` and `.from` methods on collection constructors](#of-and-from-methods-on-collection-constructors) - - [`compositeKey` and `compositeSymbol`](#compositekey-and-compositesymbol) - - [`Array` filtering](#array-filtering) - - [`Array` deduplication](#array-deduplication) - - [Getting last item from `Array`](#getting-last-item-from-array) - - [`Number.range`](#numberrange) - - [`Number.fromString`](#numberfromstring) - - [`Math` extensions](#math-extensions) - - [`Math.signbit`](#mathsignbit) - - [`String.cooked`](#stringcooked) - - [`String.prototype.codePoints`](#stringprototypecodepoints) - - [`Symbol.matcher` for pattern matching](#symbolmatcher-for-pattern-matching) - - [Stage 0 proposals](#stage-0-proposals) - - [`Function.prototype.unThis`](#functionprototypeunthis) - - [`Function.{ isCallable, isConstructor }`](#function-iscallable-isconstructor-) - - [`URL`](#url) - - [Pre-stage 0 proposals](#pre-stage-0-proposals) - - [`Reflect` metadata](#reflect-metadata) - - [Web standards](#web-standards) - - [`structuredClone`](#structuredclone) - - [Base64 utility methods](#base64-utility-methods) - - [`setTimeout` and `setInterval`](#settimeout-and-setinterval) - - [`setImmediate`](#setimmediate) - - [`queueMicrotask`](#queuemicrotask) - - [`URL` and `URLSearchParams`](#url-and-urlsearchparams) - - [`DOMException`](#domexception) - - [iterable DOM collections](#iterable-dom-collections) - - [Iteration helpers](#iteration-helpers) -- [Missing polyfills](#missing-polyfills) -- [Contributing](./CONTRIBUTING.md) -- [Security policy](https://github.com/zloirock/core-js/blob/master/SECURITY.md) -- [Changelog](./CHANGELOG.md) - -## Usage[⬆](#index) -### Installation:[⬆](#index) -``` -// global version -npm install --save core-js@3.25.1 -// version without global namespace pollution -npm install --save core-js-pure@3.25.1 -// bundled global version -npm install --save core-js-bundle@3.25.1 -``` - -Or you can use `core-js` [from CDN](https://www.jsdelivr.com/package/npm/core-js-bundle). - -### `postinstall` message[⬆](#index) -The `core-js` project needs your help, so the package shows a message about it after installation. If it causes problems for you, you can disable it: -``` -ADBLOCK=true npm install -// or -DISABLE_OPENCOLLECTIVE=true npm install -// or -npm install --loglevel silent -``` - -### CommonJS API[⬆](#index) -You can import only-required-for-you polyfills, like in examples at the top of `README.md`. Available CommonJS entry points for all polyfilled methods / constructors and namespaces. Just some examples: - -```js -// polyfill all `core-js` features, including early-stage proposals: -import "core-js"; -// or: -import "core-js/full"; -// polyfill all actual features - stable ES, web standards and stage 3 ES proposals: -import "core-js/actual"; -// polyfill only stable features - ES and web standards: -import "core-js/stable"; -// polyfill only stable ES features: -import "core-js/es"; - -// if you want to polyfill `Set`: -// all `Set`-related features, with early-stage ES proposals: -import "core-js/full/set"; -// stable required for `Set` ES features, features from web standards and stage 3 ES proposals: -import "core-js/actual/set"; -// stable required for `Set` ES features and features from web standards -// (DOM collections iterator in this case): -import "core-js/stable/set"; -// only stable ES features required for `Set`: -import "core-js/es/set"; -// the same without global namespace pollution: -import Set from "core-js-pure/full/set"; -import Set from "core-js-pure/actual/set"; -import Set from "core-js-pure/stable/set"; -import Set from "core-js-pure/es/set"; - -// if you want to polyfill just required methods: -import "core-js/full/set/intersection"; -import "core-js/actual/array/find-last"; -import "core-js/stable/queue-microtask"; -import "core-js/es/array/from"; - -// polyfill iterator helpers proposal: -import "core-js/proposals/iterator-helpers"; -// polyfill all stage 2+ proposals: -import "core-js/stage/2"; -``` - -**Note: The usage of the `/actual/` namespace is recommended since it includes all actual JavaScript features and does not include unstable early-stage proposals that are available mainly for experiments.** - -##### Caveats when using CommonJS API:[⬆](#index) - -* `modules` path is an internal API, does not inject all required dependencies and can be changed in minor or patch releases. Use it only for a custom build and/or if you know what are you doing. -* If you use `core-js` with the extension of native objects, recommended load all `core-js` modules at the top of the entry point of your application, otherwise, you can have conflicts. - * For example, Google Maps use their own `Symbol.iterator`, conflicting with `Array.from`, `URLSearchParams` and/or something else from `core-js`, see [related issues](https://github.com/zloirock/core-js/search?q=Google+Maps&type=Issues). - * Such conflicts also resolvable by discovering and manual adding each conflicting entry from `core-js`. -* `core-js` is extremely modular and uses a lot of very tiny modules, because of that for usage in browsers bundle up `core-js` instead of usage loader for each file, otherwise, you will have hundreds of requests. - -#### CommonJS and prototype methods without global namespace pollution[⬆](#index) -In the `pure` version, we can't pollute prototypes of native constructors. Because of that, prototype methods transformed into static methods like in examples above. But with transpilers, we can use one more trick - [bind operator and virtual methods](https://github.com/tc39/proposal-bind-operator). Special for that, available `/virtual/` entry points. Example: -```js -import fill from 'core-js-pure/actual/array/virtual/fill'; -import findIndex from 'core-js-pure/actual/array/virtual/find-index'; - -Array(10)::fill(0).map((a, b) => b * b)::findIndex(it => it && !(it % 8)); // => 4 -``` - -> **Warning!** The bind operator is an early-stage ECMAScript proposal and usage of this syntax can be dangerous. - -### Babel[⬆](#index) - -`core-js` is integrated with `babel` and is the base for polyfilling-related `babel` features: - -#### `@babel/polyfill`[⬆](#index) - -[`@babel/polyfill`](https://babeljs.io/docs/usage/polyfill) [**IS** just the import of stable `core-js` features and `regenerator-runtime`](https://github.com/babel/babel/blob/c8bb4500326700e7dc68ce8c4b90b6482c48d82f/packages/babel-polyfill/src/index.js) for generators and async functions, so if you load `@babel/polyfill` - you load the global version of `core-js` without ES proposals. - -Now it's deprecated in favour of separate inclusion of required parts of `core-js` and `regenerator-runtime` and, for preventing breaking changes, left on `core-js@2`. - -As a full equal of `@babel/polyfill`, you can use this: -```js -import 'core-js/stable'; -import 'regenerator-runtime/runtime'; -``` - -#### `@babel/preset-env`[⬆](#index) - -[`@babel/preset-env`](https://github.com/babel/babel/tree/master/packages/babel-preset-env) has `useBuiltIns` option, which optimizes working with global version of `core-js`. With `useBuiltIns` option, you should also set `corejs` option to used version of `core-js`, like `corejs: '3.25'`. - -> **Warning!** Recommended to specify used minor `core-js` version, like `corejs: '3.25'`, instead of `corejs: 3`, since with `corejs: 3` will not be injected modules which were added in minor `core-js` releases. - -- `useBuiltIns: 'entry'` replaces imports of `core-js` to import only required for a target environment modules. So, for example, -```js -import 'core-js/stable'; -``` -with `chrome 71` target will be replaced just to: -```js -import "core-js/modules/es.array.unscopables.flat"; -import "core-js/modules/es.array.unscopables.flat-map"; -import "core-js/modules/es.object.from-entries"; -import "core-js/modules/web.immediate"; -``` -It works for all entry points of global version of `core-js` and their combinations, for example for -```js -import 'core-js/es'; -import 'core-js/proposals/set-methods'; -import 'core-js/full/set/map'; -``` -with `chrome 71` target you will have as a result: -```js -import "core-js/modules/es.array.unscopables.flat"; -import "core-js/modules/es.array.unscopables.flat-map"; -import "core-js/modules/es.object.from-entries"; -import "core-js/modules/esnext.set.difference"; -import "core-js/modules/esnext.set.intersection"; -import "core-js/modules/esnext.set.is-disjoint-from"; -import "core-js/modules/esnext.set.is-subset-of"; -import "core-js/modules/esnext.set.is-superset-of"; -import "core-js/modules/esnext.set.map"; -import "core-js/modules/esnext.set.symmetric-difference"; -import "core-js/modules/esnext.set.union"; -``` - -- `useBuiltIns: 'usage'` adds to the top of each file import of polyfills for features used in this file and not supported by target environments, so for: -```js -// first file: -var set = new Set([1, 2, 3]); - -// second file: -var array = Array.of(1, 2, 3); -``` -if target contains an old environment like `IE 11` we will have something like: -```js -// first file: -import 'core-js/modules/es.array.iterator'; -import 'core-js/modules/es.object.to-string'; -import 'core-js/modules/es.set'; -var set = new Set([1, 2, 3]); - -// second file: -import 'core-js/modules/es.array.of'; -var array = Array.of(1, 2, 3); -``` - -By default, `@babel/preset-env` with `useBuiltIns: 'usage'` option only polyfills stable features, but you can enable polyfilling of proposals by `proposals` option, as `corejs: { version: '3.25', proposals: true }`. - -> **Warning!** In the case of `useBuiltIns: 'usage'`, you should not add `core-js` imports by yourself, they will be added automatically. - -#### `@babel/runtime`[⬆](#index) - -[`@babel/runtime`](https://babeljs.io/docs/plugins/transform-runtime/) with `corejs: 3` option simplifies work with `core-js-pure`. It automatically replaces usage of modern features from JS standard library to imports from the version of `core-js` without global namespace pollution, so instead of: -```js -import from from 'core-js-pure/stable/array/from'; -import flat from 'core-js-pure/stable/array/flat'; -import Set from 'core-js-pure/stable/set'; -import Promise from 'core-js-pure/stable/promise'; - -from(new Set([1, 2, 3, 2, 1])); -flat([1, [2, 3], [4, [5]]], 2); -Promise.resolve(32).then(x => console.log(x)); -``` -you can write just: -```js -Array.from(new Set([1, 2, 3, 2, 1])); -[1, [2, 3], [4, [5]]].flat(2); -Promise.resolve(32).then(x => console.log(x)); -``` - -By default, `@babel/runtime` only polyfills stable features, but like in `@babel/preset-env`, you can enable polyfilling of proposals by `proposals` option, as `corejs: { version: 3, proposals: true }`. - -> **Warning!** If you use `@babel/preset-env` and `@babel/runtime` together, use `corejs` option only in one place since it's duplicate functionality and will cause conflicts. - -### swc[⬆](#index) - -Fast JavaScript transpiler `swc` [contains integration with `core-js`](https://swc.rs/docs/configuration/supported-browsers), that optimizes work with the global version of `core-js`. [Like `@babel/preset-env`](#babelpreset-env), it has 2 modes: `usage` and `entry`, but `usage` mode still works not so good like in `babel`. Example of configuration in `.swcrc`: -```json -{ - "env": { - "targets": "> 0.25%, not dead", - "mode": "entry", - "coreJs": "3.25" - } -} -``` - -### Configurable level of aggressiveness[⬆](#index) - -By default, `core-js` sets polyfills only when they are required. That means that `core-js` checks if a feature is available and works correctly or not and if it has no problems, `core-js` use native implementation. - -But sometimes `core-js` feature detection could be too strict for your case. For example, `Promise` constructor requires the support of unhandled rejection tracking and `@@species`. - -Sometimes we could have inverse problem - knowingly broken environment with problems not covered by `core-js` feature detection. - -For those cases, we could redefine this behaviour for certain polyfills: - -```js -const configurator = require('core-js/configurator'); - -configurator({ - useNative: ['Promise'], // polyfills will be used only if natives completely unavailable - usePolyfill: ['Array.from', 'String.prototype.padEnd'], // polyfills will be used anyway - useFeatureDetection: ['Map', 'Set'], // default behaviour -}); - -require('core-js/actual'); -``` - -It does not work with some features. Also, if you change the default behaviour, even `core-js` internals may not work correctly. - -### Custom build[⬆](#index) - -For some cases could be useful to exclude some `core-js` features or generate a polyfill for target engines. You could use [`core-js-builder`](/packages/core-js-builder) package for that. - -## Compatibility data[⬆](#index) - -`core-js` project provides (as [`core-js-compat`](/packages/core-js-compat) package) all required data about the necessity of `core-js` modules, entry points, and tools for work with it - it's useful for integration with tools like `babel` or `swc`. If you wanna help, you could take a look at the related section of [`CONTRIBUTING.md`](/CONTRIBUTING.md#how-to-update-core-js-compat-data). The visualization of compatibility data and the browser tests runner is available [here](http://zloirock.github.io/core-js/compat/), the example: - -![compat-table](https://user-images.githubusercontent.com/2213682/180694428-856bcd0f-cab3-446f-be1a-2f669614dcc0.png) - -## Supported engines[⬆](#index) -**Tested in:** -- Chrome 26+ -- Firefox 4+ -- Safari 5+ -- Opera 12+ -- Internet Explorer 8+ (sure, IE8 with ES3 limitations; IE7- also should work, but no longer tested) -- Edge -- Android Browser 2.3+ -- iOS Safari 5.1+ -- PhantomJS 1.9+ -- NodeJS 0.8+ -- Deno 1.0+ -- Rhino 1.7.14+ - -...and it doesn't mean `core-js` will not work in other engines, they just have not been tested. - -## Features:[⬆](#index) -[*CommonJS entry points:*](#commonjs-api) -``` -core-js(-pure) -``` - -### ECMAScript[⬆](#index) -[*CommonJS entry points:*](#commonjs-api) -``` -core-js(-pure)/es -``` -#### ECMAScript: Object[⬆](#index) -Modules [`es.object.assign`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.assign.js), [`es.object.create`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.create.js), [`es.object.define-getter`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.define-getter.js), [`es.object.define-property`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.define-property.js), [`es.object.define-properties`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.es.object.define-properties.js), [`es.object.define-setter`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.define-setter.js), [`es.object.entries`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.entries.js), [`es.object.freeze`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.freeze.js), [`es.object.from-entries`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.from-entries.js), [`es.object.get-own-property-descriptor`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.get-own-property-descriptor.js), [`es.object.get-own-property-descriptors`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.get-own-property-descriptors.js), [`es.object.get-own-property-names`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.get-own-property-names.js), [`es.object.get-prototype-of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.get-prototype-of.js), [`es.object.has-own`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.has-own.js), [`es.object.is`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.is.js), [`es.object.is-extensible`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.is-extensible.js), [`es.object.is-frozen`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.is-frozen.js), [`es.object.is-sealed`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.is-sealed.js), [`es.object.keys`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.keys.js), [`es.object.lookup-setter`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.lookup-setter.js), [`es.object.lookup-getter`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.lookup-getter.js), [`es.object.prevent-extensions`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.prevent-extensions.js), [`es.object.proto`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.proto.js), [`es.object.to-string`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.to-string.js), [`es.object.seal`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.seal.js), [`es.object.set-prototype-of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.set-prototype-of.js), [`es.object.values`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.values.js). - -```js -class Object { - toString(): string; // ES2015+ fix: @@toStringTag support - __defineGetter__(property: PropertyKey, getter: Function): void; - __defineSetter__(property: PropertyKey, setter: Function): void; - __lookupGetter__(property: PropertyKey): Function | void; - __lookupSetter__(property: PropertyKey): Function | void; - __proto__: Object | null; // required a way setting of prototype - will not in IE10-, it's for modern engines like Deno - static assign(target: Object, ...sources: Array): Object; - static create(prototype: Object | null, properties?: { [property: PropertyKey]: PropertyDescriptor }): Object; - static defineProperties(object: Object, properties: { [property: PropertyKey]: PropertyDescriptor })): Object; - static defineProperty(object: Object, property: PropertyKey, attributes: PropertyDescriptor): Object; - static entries(object: Object): Array<[string, mixed]>; - static freeze(object: any): any; - static fromEntries(iterable: Iterable<[key, value]>): Object; - static getOwnPropertyDescriptor(object: any, property: PropertyKey): PropertyDescriptor | void; - static getOwnPropertyDescriptors(object: any): { [property: PropertyKey]: PropertyDescriptor }; - static getOwnPropertyNames(object: any): Array; - static getPrototypeOf(object: any): Object | null; - static hasOwn(object: object, key: PropertyKey): boolean; - static is(value1: any, value2: any): boolean; - static isExtensible(object: any): boolean; - static isFrozen(object: any): boolean; - static isSealed(object: any): boolean; - static keys(object: any): Array; - static preventExtensions(object: any): any; - static seal(object: any): any; - static setPrototypeOf(target: any, prototype: Object | null): any; // required __proto__ - IE11+ - static values(object: any): Array; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js(-pure)/es|stable|actual|full/object -core-js(-pure)/es|stable|actual|full/object/assign -core-js(-pure)/es|stable|actual|full/object/is -core-js(-pure)/es|stable|actual|full/object/set-prototype-of -core-js(-pure)/es|stable|actual|full/object/get-prototype-of -core-js(-pure)/es|stable|actual|full/object/create -core-js(-pure)/es|stable|actual|full/object/define-property -core-js(-pure)/es|stable|actual|full/object/define-properties -core-js(-pure)/es|stable|actual|full/object/get-own-property-descriptor -core-js(-pure)/es|stable|actual|full/object/get-own-property-descriptors -core-js(-pure)/es|stable|actual|full/object/has-own -core-js(-pure)/es|stable|actual|full/object/keys -core-js(-pure)/es|stable|actual|full/object/values -core-js(-pure)/es|stable|actual|full/object/entries -core-js(-pure)/es|stable|actual|full/object/get-own-property-names -core-js(-pure)/es|stable|actual|full/object/freeze -core-js(-pure)/es|stable|actual|full/object/from-entries -core-js(-pure)/es|stable|actual|full/object/seal -core-js(-pure)/es|stable|actual|full/object/prevent-extensions -core-js/es|stable|actual|full/object/proto -core-js(-pure)/es|stable|actual|full/object/is-frozen -core-js(-pure)/es|stable|actual|full/object/is-sealed -core-js(-pure)/es|stable|actual|full/object/is-extensible -core-js/es|stable|actual|full/object/to-string -core-js(-pure)/es|stable|actual|full/object/define-getter -core-js(-pure)/es|stable|actual|full/object/define-setter -core-js(-pure)/es|stable|actual|full/object/lookup-getter -core-js(-pure)/es|stable|actual|full/object/lookup-setter -``` -[*Examples*](https://is.gd/udzZq0): -```js -let foo = { q: 1, w: 2 }; -let bar = { e: 3, r: 4 }; -let baz = { t: 5, y: 6 }; -Object.assign(foo, bar, baz); // => foo = { q: 1, w: 2, e: 3, r: 4, t: 5, y: 6 } - -Object.is(NaN, NaN); // => true -Object.is(0, -0); // => false -Object.is(42, 42); // => true -Object.is(42, '42'); // => false - -function Parent() {} -function Child() {} -Object.setPrototypeOf(Child.prototype, Parent.prototype); -new Child() instanceof Child; // => true -new Child() instanceof Parent; // => true - -let object = { - [Symbol.toStringTag]: 'Foo' -}; - -'' + object; // => '[object Foo]' - -Object.keys('qwe'); // => ['0', '1', '2'] -Object.getPrototypeOf('qwe') === String.prototype; // => true - -Object.values({ a: 1, b: 2, c: 3 }); // => [1, 2, 3] -Object.entries({ a: 1, b: 2, c: 3 }); // => [['a', 1], ['b', 2], ['c', 3]] - -for (let [key, value] of Object.entries({ a: 1, b: 2, c: 3 })) { - console.log(key); // => 'a', 'b', 'c' - console.log(value); // => 1, 2, 3 -} - -// Shallow object cloning with prototype and descriptors: -let copy = Object.create(Object.getPrototypeOf(object), Object.getOwnPropertyDescriptors(object)); -// Mixin: -Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); - -const map = new Map([['a', 1], ['b', 2]]); -Object.fromEntries(map); // => { a: 1, b: 2 } - -class Unit { - constructor(id) { - this.id = id; - } - toString() { - return `unit${ this.id }`; - } -} - -const units = new Set([new Unit(101), new Unit(102)]); - -Object.fromEntries(units.entries()); // => { unit101: Unit { id: 101 }, unit102: Unit { id: 102 } } - -Object.hasOwn({ foo: 42 }, 'foo'); // => true -Object.hasOwn({ foo: 42 }, 'bar'); // => false -Object.hasOwn({}, 'toString'); // => false -``` - -#### ECMAScript: Function[⬆](#index) -Modules [`es.function.name`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.function.name.js), [`es.function.has-instance`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.function.has-instance.js). Just ES5: [`es.function.bind`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.function.bind.js). -```js -class Function { - name: string; - bind(thisArg: any, ...args: Array): Function; - @@hasInstance(value: any): boolean; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js/es|stable|actual|full/function -core-js/es|stable|actual|full/function/name -core-js/es|stable|actual|full/function/has-instance -core-js(-pure)/es|stable|actual|full/function/bind -core-js(-pure)/es|stable|actual|full/function/virtual/bind -``` -[*Example*](https://goo.gl/zqu3Wp): -```js -(function foo() {}).name // => 'foo' - -console.log.bind(console, 42)(43); // => 42 43 -``` - -#### ECMAScript: Error[⬆](#index) -Modules [`es.aggregate-error`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.aggregate-error.js), [`es.aggregate-error.cause`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.aggregate-error.cause.js), [`es.error.cause`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.error.cause.js). -```js -class [ - Error, - EvalError, - RangeError, - ReferenceError, - SyntaxError, - TypeError, - URIError, - WebAssembly.CompileError, - WebAssembly.LinkError, - WebAssembly.RuntimeError, -] { - constructor(message: string, { cause: any }): %Error%; -} - -class AggregateError { - constructor(errors: Iterable, message: string, { cause: any }): AggregateError; - errors: Array; - message: string; -} - -class Error { - toString(): string; // different fixes -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js(-pure)/es|stable|actual|full/aggregate-error -core-js/es|stable|actual|full/error -core-js/es|stable|actual|full/error/constructor -core-js/es|stable|actual|full/error/to-string -``` -[*Example*](https://is.gd/1SufcH): -```js -const error1 = new TypeError('Error 1'); -const error2 = new TypeError('Error 2'); -const aggregate = new AggregateError([error1, error2], 'Collected errors'); -aggregate.errors[0] === error1; // => true -aggregate.errors[1] === error2; // => true - -const cause = new TypeError('Something wrong'); -const error = new TypeError('Here explained what`s wrong', { cause }); -error.cause === cause; // => true - -Error.prototype.toString.call({ message: 1, name: 2 }) === '2: 1'; // => true -``` - -#### ECMAScript: Array[⬆](#index) -Modules [`es.array.from`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.from.js), [`es.array.is-array`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.is-array.js), [`es.array.of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.of.js), [`es.array.copy-within`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.copy-within.js), [`es.array.fill`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.fill.js), [`es.array.find`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.find.js), [`es.array.find-index`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.find-index.js), [`es.array.find-last`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.find-last.js), [`es.array.find-last-index`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.find-last-index.js), [`es.array.iterator`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.iterator.js), [`es.array.includes`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.includes.js), [`es.array.push`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.push.js), [`es.array.slice`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.slice.js), [`es.array.join`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.join.js), [`es.array.unshift`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.unshift.js), [`es.array.index-of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.index-of.js), [`es.array.last-index-of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.last-index-of.js), [`es.array.every`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.every.js), [`es.array.some`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.some.js), [`es.array.for-each`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.for-each.js), [`es.array.map`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.map.js), [`es.array.filter`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.filter.js), [`es.array.reduce`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.reduce.js), [`es.array.reduce-right`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.reduce-right.js), [`es.array.reverse`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.reverse.js), [`es.array.sort`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.sort.js), [`es.array.flat`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.flat.js), [`es.array.flat-map`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.flat-map.js), [`es.array.unscopables.flat`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.unscopables.flat.js), [`es.array.unscopables.flat-map`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.unscopables.flat-map.js), [`es.array.at`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array.at.js). -```js -class Array { - at(index: int): any; - concat(...args: Array): Array; // with adding support of @@isConcatSpreadable and @@species - copyWithin(target: number, start: number, end?: number): this; - entries(): Iterator<[index, value]>; - every(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): boolean; - fill(value: any, start?: number, end?: number): this; - filter(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): Array; // with adding support of @@species - find(callbackfn: (value: any, index: number, target: any) => boolean), thisArg?: any): any; - findIndex(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): uint; - findLast(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): any; - findLastIndex(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): uint; - flat(depthArg?: number = 1): Array; - flatMap(mapFn: (value: any, index: number, target: any) => any, thisArg: any): Array; - forEach(callbackfn: (value: any, index: number, target: any) => void, thisArg?: any): void; - includes(searchElement: any, from?: number): boolean; - indexOf(searchElement: any, from?: number): number; - join(separator: string = ','): string; - keys(): Iterator; - lastIndexOf(searchElement: any, from?: number): number; - map(mapFn: (value: any, index: number, target: any) => any, thisArg?: any): Array; // with adding support of @@species - push(...args: Array): uint; - reduce(callbackfn: (memo: any, value: any, index: number, target: any) => any, initialValue?: any): any; - reduceRight(callbackfn: (memo: any, value: any, index: number, target: any) => any, initialValue?: any): any; - reverse(): this; // Safari 12.0 bug fix - slice(start?: number, end?: number): Array; // with adding support of @@species - splice(start?: number, deleteCount?: number, ...items: Array): Array; // with adding support of @@species - some(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): boolean; - sort(comparefn?: (a: any, b: any) => number): this; // with modern behavior like stable sort - unshift(...args: Array): uint; - values(): Iterator; - @@iterator(): Iterator; - @@unscopables: { [newMethodNames: string]: true }; - static from(items: Iterable | ArrayLike, mapFn?: (value: any, index: number) => any, thisArg?: any): Array; - static isArray(value: any): boolean; - static of(...args: Array): Array; -} - -class Arguments { - @@iterator(): Iterator; // available only in core-js methods -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js(-pure)/es|stable|actual|full/array -core-js(-pure)/es|stable|actual|full/array/from -core-js(-pure)/es|stable|actual|full/array/of -core-js(-pure)/es|stable|actual|full/array/is-array -core-js(-pure)/es|stable|actual|full/array/at -core-js(-pure)/es|stable|actual|full/array/concat -core-js(-pure)/es|stable|actual|full/array/entries -core-js(-pure)/es|stable|actual|full/array/every -core-js(-pure)/es|stable|actual|full/array/copy-within -core-js(-pure)/es|stable|actual|full/array/fill -core-js(-pure)/es|stable|actual|full/array/filter -core-js(-pure)/es|stable|actual|full/array/find -core-js(-pure)/es|stable|actual|full/array/find-index -core-js(-pure)/es|stable|actual|full/array/find-last -core-js(-pure)/es|stable|actual|full/array/find-last-index -core-js(-pure)/es|stable|actual|full/array/flat -core-js(-pure)/es|stable|actual|full/array/flat-map -core-js(-pure)/es|stable|actual|full/array/for-each -core-js(-pure)/es|stable|actual|full/array/includes -core-js(-pure)/es|stable|actual|full/array/index-of -core-js(-pure)/es|stable|actual|full/array/iterator -core-js(-pure)/es|stable|actual|full/array/join -core-js(-pure)/es|stable|actual|full/array/keys -core-js(-pure)/es|stable|actual|full/array/last-index-of -core-js(-pure)/es|stable|actual|full/array/map -core-js(-pure)/es|stable|actual|full/array/push -core-js(-pure)/es|stable|actual|full/array/reduce -core-js(-pure)/es|stable|actual|full/array/reduce-right -core-js(-pure)/es|stable|actual|full/array/reverse -core-js(-pure)/es|stable|actual|full/array/slice -core-js(-pure)/es|stable|actual|full/array/splice -core-js(-pure)/es|stable|actual|full/array/some -core-js(-pure)/es|stable|actual|full/array/sort -core-js(-pure)/es|stable|actual|full/array/unshift -core-js(-pure)/es|stable|actual|full/array/values -core-js(-pure)/es|stable|actual|full/array/virtual/at -core-js(-pure)/es|stable|actual|full/array/virtual/concat -core-js(-pure)/es|stable|actual|full/array/virtual/copy-within -core-js(-pure)/es|stable|actual|full/array/virtual/entries -core-js(-pure)/es|stable|actual|full/array/virtual/every -core-js(-pure)/es|stable|actual|full/array/virtual/fill -core-js(-pure)/es|stable|actual|full/array/virtual/filter -core-js(-pure)/es|stable|actual|full/array/virtual/find -core-js(-pure)/es|stable|actual|full/array/virtual/find-index -core-js(-pure)/es|stable|actual|full/array/virtual/find-last -core-js(-pure)/es|stable|actual|full/array/virtual/find-last-index -core-js(-pure)/es|stable|actual|full/array/virtual/flat -core-js(-pure)/es|stable|actual|full/array/virtual/flat-map -core-js(-pure)/es|stable|actual|full/array/virtual/for-each -core-js(-pure)/es|stable|actual|full/array/virtual/includes -core-js(-pure)/es|stable|actual|full/array/virtual/index-of -core-js(-pure)/es|stable|actual|full/array/virtual/iterator -core-js(-pure)/es|stable|actual|full/array/virtual/join -core-js(-pure)/es|stable|actual|full/array/virtual/keys -core-js(-pure)/es|stable|actual|full/array/virtual/last-index-of -core-js(-pure)/es|stable|actual|full/array/virtual/map -core-js(-pure)/es|stable|actual|full/array/virtual/push -core-js(-pure)/es|stable|actual|full/array/virtual/reduce -core-js(-pure)/es|stable|actual|full/array/virtual/reduce-right -core-js(-pure)/es|stable|actual|full/array/virtual/reverse -core-js(-pure)/es|stable|actual|full/array/virtual/slice -core-js(-pure)/es|stable|actual|full/array/virtual/some -core-js(-pure)/es|stable|actual|full/array/virtual/sort -core-js(-pure)/es|stable|actual|full/array/virtual/splice -core-js(-pure)/es|stable|actual|full/array/virtual/unshift -core-js(-pure)/es|stable|actual|full/array/virtual/values -``` -[*Examples*](https://tinyurl.com/2br28bgj): -```js -Array.from(new Set([1, 2, 3, 2, 1])); // => [1, 2, 3] -Array.from({ 0: 1, 1: 2, 2: 3, length: 3 }); // => [1, 2, 3] -Array.from('123', Number); // => [1, 2, 3] -Array.from('123', it => it * it); // => [1, 4, 9] - -Array.of(1); // => [1] -Array.of(1, 2, 3); // => [1, 2, 3] - -let array = ['a', 'b', 'c']; - -for (let value of array) console.log(value); // => 'a', 'b', 'c' -for (let value of array.values()) console.log(value); // => 'a', 'b', 'c' -for (let key of array.keys()) console.log(key); // => 0, 1, 2 -for (let [key, value] of array.entries()) { - console.log(key); // => 0, 1, 2 - console.log(value); // => 'a', 'b', 'c' -} - -function isOdd(value) { - return value % 2; -} -[4, 8, 15, 16, 23, 42].find(isOdd); // => 15 -[4, 8, 15, 16, 23, 42].findIndex(isOdd); // => 2 -[1, 2, 3, 4].findLast(isOdd); // => 3 -[1, 2, 3, 4].findLastIndex(isOdd); // => 2 - -Array(5).fill(42); // => [42, 42, 42, 42, 42] - -[1, 2, 3, 4, 5].copyWithin(0, 3); // => [4, 5, 3, 4, 5] - - -[1, 2, 3].includes(2); // => true -[1, 2, 3].includes(4); // => false -[1, 2, 3].includes(2, 2); // => false - -[NaN].indexOf(NaN); // => -1 -[NaN].includes(NaN); // => true -Array(1).indexOf(undefined); // => -1 -Array(1).includes(undefined); // => true - -[1, [2, 3], [4, 5]].flat(); // => [1, 2, 3, 4, 5] -[1, [2, [3, [4]]], 5].flat(); // => [1, 2, [3, [4]], 5] -[1, [2, [3, [4]]], 5].flat(3); // => [1, 2, 3, 4, 5] - -[{ a: 1, b: 2 }, { a: 3, b: 4 }, { a: 5, b: 6 }].flatMap(it => [it.a, it.b]); // => [1, 2, 3, 4, 5, 6] - -[1, 2, 3].at(1); // => 2 -[1, 2, 3].at(-1); // => 3 -``` - -#### ECMAScript: String and RegExp[⬆](#index) -The main part of `String` features: modules [`es.string.from-code-point`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.from-code-point.js), [`es.string.raw`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.raw.js), [`es.string.iterator`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.iterator.js), [`es.string.split`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.split.js), [`es.string.code-point-at`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.code-point-at.js), [`es.string.ends-with`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.ends-with.js), [`es.string.includes`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.includes.js), [`es.string.repeat`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.repeat.js), [`es.string.pad-start`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.pad-start.js), [`es.string.pad-end`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.pad-end.js), [`es.string.starts-with`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.starts-with.js), [`es.string.trim`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.trim.js), [`es.string.trim-start`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.trim-start.js), [`es.string.trim-end`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.trim-end.js), [`es.string.match-all`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.match-all.js), [`es.string.replace-all`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.replace-all.js), [`es.string.at-alternative`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.at-alternative.js). - -Adding support of well-known [symbols](#ecmascript-symbol) `@@match`, `@@replace`, `@@search` and `@@split` and direct `.exec` calls to related `String` methods, modules [`es.string.match`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.match.js), [`es.string.replace`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.replace.js), [`es.string.search`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.search.js) and [`es.string.split`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.split.js). - -Annex B methods. Modules [`es.string.anchor`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.anchor.js), [`es.string.big`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.big.js), [`es.string.blink`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.blink.js), [`es.string.bold`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.bold.js), [`es.string.fixed`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.fixed.js), [`es.string.fontcolor`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.fontcolor.js), [`es.string.fontsize`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.fontsize.js), [`es.string.italics`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.italics.js), [`es.string.link`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.link.js), [`es.string.small`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.small.js), [`es.string.strike`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.strike.js), [`es.string.sub`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.sub.js), [`es.string.sup`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.sup.js), [`es.string.substr`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.string.substr.js), [`es.escape`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.escape.js) and [`es.unescape`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.unescape.js). - -`RegExp` features: modules [`es.regexp.constructor`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.regexp.constructor.js), [`es.regexp.dot-all`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.regexp.dot-all.js), [`es.regexp.flags`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.regexp.flags.js), [`es.regexp.sticky`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.regexp.sticky.js) and [`es.regexp.test`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.regexp.test.js). -```js -class String { - static fromCodePoint(...codePoints: Array): string; - static raw({ raw: Array }, ...substitutions: Array): string; - at(index: int): string; - includes(searchString: string, position?: number): boolean; - startsWith(searchString: string, position?: number): boolean; - endsWith(searchString: string, position?: number): boolean; - repeat(count: number): string; - padStart(length: number, fillStr?: string = ' '): string; - padEnd(length: number, fillStr?: string = ' '): string; - codePointAt(pos: number): number | void; - match(template: any): any; // ES2015+ fix for support @@match - matchAll(regexp: RegExp): Iterator; - replace(template: any, replacer: any): any; // ES2015+ fix for support @@replace - replaceAll(searchValue: string | RegExp, replaceString: string | (searchValue, index, this) => string): string; - search(template: any): any; // ES2015+ fix for support @@search - split(template: any, limit?: int): Array;; // ES2015+ fix for support @@split, some fixes for old engines - trim(): string; - trimLeft(): string; - trimRight(): string; - trimStart(): string; - trimEnd(): string; - anchor(name: string): string; - big(): string; - blink(): string; - bold(): string; - fixed(): string; - fontcolor(color: string): string; - fontsize(size: any): string; - italics(): string; - link(url: string): string; - small(): string; - strike(): string; - sub(): string; - substr(start: int, length?: int): string; - sup(): string; - @@iterator(): Iterator; -} - -class RegExp { - // support of sticky (`y`) flag, dotAll (`s`) flag, named capture groups, can alter flags - constructor(pattern: RegExp | string, flags?: string): RegExp; - exec(): Array | null; // IE8 fixes - test(string: string): boolean; // delegation to `.exec` - toString(): string; // ES2015+ fix - generic - @@match(string: string): Array | null; - @@matchAll(string: string): Iterator; - @@replace(string: string, replaceValue: Function | string): string; - @@search(string: string): number; - @@split(string: string, limit: number): Array; - readonly attribute dotAll: boolean; // IE9+ - readonly attribute flags: string; // IE9+ - readonly attribute sticky: boolean; // IE9+ -} - -function escape(string: string): string; -function unescape(string: string): string; -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js(-pure)/es|stable|actual|full/string -core-js(-pure)/es|stable|actual|full/string/from-code-point -core-js(-pure)/es|stable|actual|full/string/raw -core-js/es|stable|actual|full/string/match -core-js/es|stable|actual|full/string/replace -core-js/es|stable|actual|full/string/search -core-js/es|stable|actual|full/string/split -core-js(-pure)/es|stable|actual/string(/virtual)/at -core-js(-pure)/es|stable|actual|full/string(/virtual)/code-point-at -core-js(-pure)/es|stable|actual|full/string(/virtual)/ends-with -core-js(-pure)/es|stable|actual|full/string(/virtual)/includes -core-js(-pure)/es|stable|actual|full/string(/virtual)/starts-with -core-js(-pure)/es|stable|actual|full/string(/virtual)/match-all -core-js(-pure)/es|stable|actual|full/string(/virtual)/pad-start -core-js(-pure)/es|stable|actual|full/string(/virtual)/pad-end -core-js(-pure)/es|stable|actual|full/string(/virtual)/repeat -core-js(-pure)/es|stable|actual|full/string(/virtual)/replace-all -core-js(-pure)/es|stable|actual|full/string(/virtual)/trim -core-js(-pure)/es|stable|actual|full/string(/virtual)/trim-start -core-js(-pure)/es|stable|actual|full/string(/virtual)/trim-end -core-js(-pure)/es|stable|actual|full/string(/virtual)/trim-left -core-js(-pure)/es|stable|actual|full/string(/virtual)/trim-right -core-js(-pure)/es|stable|actual|full/string(/virtual)/anchor -core-js(-pure)/es|stable|actual|full/string(/virtual)/big -core-js(-pure)/es|stable|actual|full/string(/virtual)/blink -core-js(-pure)/es|stable|actual|full/string(/virtual)/bold -core-js(-pure)/es|stable|actual|full/string(/virtual)/fixed -core-js(-pure)/es|stable|actual|full/string(/virtual)/fontcolor -core-js(-pure)/es|stable|actual|full/string(/virtual)/fontsize -core-js(-pure)/es|stable|actual|full/string(/virtual)/italics -core-js(-pure)/es|stable|actual|full/string(/virtual)/link -core-js(-pure)/es|stable|actual|full/string(/virtual)/small -core-js(-pure)/es|stable|actual|full/string(/virtual)/strike -core-js(-pure)/es|stable|actual|full/string(/virtual)/sub -core-js(-pure)/es|stable|actual|full/string(/virtual)/substr -core-js(-pure)/es|stable|actual|full/string(/virtual)/sup -core-js(-pure)/es|stable|actual|full/string(/virtual)/iterator -core-js/es|stable|actual|full/regexp -core-js/es|stable|actual|full/regexp/constructor -core-js/es|stable|actual|full/regexp/dot-all -core-js(-pure)/es|stable|actual|full/regexp/flags -core-js/es|stable|actual|full/regexp/sticky -core-js/es|stable|actual|full/regexp/test -core-js/es|stable|actual|full/regexp/to-string -core-js/es|stable|actual|full/escape -core-js/es|stable|actual|full/unescape -``` -[*Examples*](https://is.gd/Q8eRhG): -```js -for (let value of 'a𠮷b') { - console.log(value); // => 'a', '𠮷', 'b' -} - -'foobarbaz'.includes('bar'); // => true -'foobarbaz'.includes('bar', 4); // => false -'foobarbaz'.startsWith('foo'); // => true -'foobarbaz'.startsWith('bar', 3); // => true -'foobarbaz'.endsWith('baz'); // => true -'foobarbaz'.endsWith('bar', 6); // => true - -'string'.repeat(3); // => 'stringstringstring' - -'hello'.padStart(10); // => ' hello' -'hello'.padStart(10, '1234'); // => '12341hello' -'hello'.padEnd(10); // => 'hello ' -'hello'.padEnd(10, '1234'); // => 'hello12341' - -'𠮷'.codePointAt(0); // => 134071 -String.fromCodePoint(97, 134071, 98); // => 'a𠮷b' - -let name = 'Bob'; -String.raw`Hi\n${name}!`; // => 'Hi\\nBob!' (ES2015 template string syntax) -String.raw({ raw: 'test' }, 0, 1, 2); // => 't0e1s2t' - -'foo'.bold(); // => 'foo' -'bar'.anchor('a"b'); // => 'bar' -'baz'.link('https://example.com'); // => 'baz' - -RegExp('.', 's').test('\n'); // => true -RegExp('.', 's').dotAll; // => true - -RegExp('foo:(?\\w+),bar:(?\\w+)').exec('foo:abc,bar:def').groups.bar; // => 'def' - -'foo:abc,bar:def'.replace(RegExp('foo:(?\\w+),bar:(?\\w+)'), '$,$'); // => 'def,abc' - -RegExp(/./g, 'm'); // => /./m - -/foo/.flags; // => '' -/foo/gim.flags; // => 'gim' - -RegExp('foo', 'y').sticky; // => true - -const text = 'First line\nSecond line'; -const regex = RegExp('(\\S+) line\\n?', 'y'); - -regex.exec(text)[1]; // => 'First' -regex.exec(text)[1]; // => 'Second' -regex.exec(text); // => null - -'foo'.match({ [Symbol.match]: () => 1 }); // => 1 -'foo'.replace({ [Symbol.replace]: () => 2 }); // => 2 -'foo'.search({ [Symbol.search]: () => 3 }); // => 3 -'foo'.split({ [Symbol.split]: () => 4 }); // => 4 - -RegExp.prototype.toString.call({ source: 'foo', flags: 'bar' }); // => '/foo/bar' - -' hello '.trimLeft(); // => 'hello ' -' hello '.trimRight(); // => ' hello' -' hello '.trimStart(); // => 'hello ' -' hello '.trimEnd(); // => ' hello' - -for (let [_, d, D] of '1111a2b3cccc'.matchAll(/(\d)(\D)/g)) { - console.log(d, D); // => 1 a, 2 b, 3 c -} - -'Test abc test test abc test.'.replaceAll('abc', 'foo'); // -> 'Test foo test test foo test.' - -'abc'.at(1); // => 'b' -'abc'.at(-1); // => 'c' -``` -#### ECMAScript: Number[⬆](#index) -Module [`es.number.constructor`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.number.constructor.js). `Number` constructor support binary and octal literals, [*example*](https://goo.gl/jRd6b3): -```js -Number('0b1010101'); // => 85 -Number('0o7654321'); // => 2054353 -``` -Modules [`es.number.epsilon`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.number.epsilon.js), [`es.number.is-finite`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.number.is-finite.js), [`es.number.is-integer`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.number.is-integer.js), [`es.number.is-nan`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.number.is-nan.js), [`es.number.is-safe-integer`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.number.is-safe-integer.js), [`es.number.max-safe-integer`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.number.max-safe-integer.js), [`es.number.min-safe-integer`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.number.min-safe-integer.js), [`es.number.parse-float`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.number.parse-float.js), [`es.number.parse-int`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.number.parse-int.js), [`es.number.to-exponential`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.number.to-exponential.js), [`es.number.to-fixed`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.number.to-fixed.js), [`es.number.to-precision`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.number.to-precision.js), [`es.parse-int`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.parse-int.js), [`es.parse-float`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.parse-float.js). -```js -class Number { - constructor(value: any): number; - toExponential(digits: number): string; - toFixed(digits: number): string; - toPrecision(precision: number): string; - static isFinite(number: any): boolean; - static isNaN(number: any): boolean; - static isInteger(number: any): boolean; - static isSafeInteger(number: any): boolean; - static parseFloat(string: string): number; - static parseInt(string: string, radix?: number = 10): number; - static EPSILON: number; - static MAX_SAFE_INTEGER: number; - static MIN_SAFE_INTEGER: number; -} - -function parseFloat(string: string): number; -function parseInt(string: string, radix?: number = 10): number; -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js(-pure)/es|stable|actual|full/number -core-js/es|stable|actual|full/number/constructor -core-js(-pure)/es|stable|actual|full/number/is-finite -core-js(-pure)/es|stable|actual|full/number/is-nan -core-js(-pure)/es|stable|actual|full/number/is-integer -core-js(-pure)/es|stable|actual|full/number/is-safe-integer -core-js(-pure)/es|stable|actual|full/number/parse-float -core-js(-pure)/es|stable|actual|full/number/parse-int -core-js(-pure)/es|stable|actual|full/number/epsilon -core-js(-pure)/es|stable|actual|full/number/max-safe-integer -core-js(-pure)/es|stable|actual|full/number/min-safe-integer -core-js(-pure)/es|stable|actual|full/number(/virtual)/to-exponential -core-js(-pure)/es|stable|actual|full/number(/virtual)/to-fixed -core-js(-pure)/es|stable|actual|full/number(/virtual)/to-precision -core-js(-pure)/es|stable|actual|full/parse-float -core-js(-pure)/es|stable|actual|full/parse-int -``` -#### ECMAScript: Math[⬆](#index) -Modules [`es.math.acosh`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.math.acosh.js), [`es.math.asinh`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.math.asinh.js), [`es.math.atanh`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.math.atanh.js), [`es.math.cbrt`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.math.cbrt.js), [`es.math.clz32`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.math.clz32.js), [`es.math.cosh`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.math.cosh.js), [`es.math.expm1`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.math.expm1.js), [`es.math.fround`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.math.fround.js), [`es.math.hypot`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.math.hypot.js), [`es.math.imul`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.math.imul.js), [`es.math.log10`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.math.log10.js), [`es.math.log1p`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.math.log1p.js), [`es.math.log2`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.math.log2.js), [`es.math.sign`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.math.sign.js), [`es.math.sinh`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.math.sinh.js), [`es.math.tanh`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.math.tanh.js), [`es.math.trunc`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.math.trunc.js). -```js -namespace Math { - acosh(number: number): number; - asinh(number: number): number; - atanh(number: number): number; - cbrt(number: number): number; - clz32(number: number): number; - cosh(number: number): number; - expm1(number: number): number; - fround(number: number): number; - hypot(...args: Array): number; - imul(number1: number, number2: number): number; - log1p(number: number): number; - log10(number: number): number; - log2(number: number): number; - sign(number: number): 1 | -1 | 0 | -0 | NaN; - sinh(number: number): number; - tanh(number: number): number; - trunc(number: number): number; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js(-pure)/es|stable|actual|full/math -core-js(-pure)/es|stable|actual|full/math/acosh -core-js(-pure)/es|stable|actual|full/math/asinh -core-js(-pure)/es|stable|actual|full/math/atanh -core-js(-pure)/es|stable|actual|full/math/cbrt -core-js(-pure)/es|stable|actual|full/math/clz32 -core-js(-pure)/es|stable|actual|full/math/cosh -core-js(-pure)/es|stable|actual|full/math/expm1 -core-js(-pure)/es|stable|actual|full/math/fround -core-js(-pure)/es|stable|actual|full/math/hypot -core-js(-pure)/es|stable|actual|full/math/imul -core-js(-pure)/es|stable|actual|full/math/log1p -core-js(-pure)/es|stable|actual|full/math/log10 -core-js(-pure)/es|stable|actual|full/math/log2 -core-js(-pure)/es|stable|actual|full/math/sign -core-js(-pure)/es|stable|actual|full/math/sinh -core-js(-pure)/es|stable|actual|full/math/tanh -core-js(-pure)/es|stable|actual|full/math/trunc -``` -#### ECMAScript: Date[⬆](#index) -Modules [`es.date.to-string`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.date.to-string.js), ES5 features with fixes: [`es.date.now`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.date.now.js), [`es.date.to-iso-string`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.date.to-iso-string.js), [`es.date.to-json`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.date.to-json.js) and [`es.date.to-primitive`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.date.to-primitive.js). - -Annex B methods. Modules [`es.date.get-year`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.date.get-year.js), [`es.date.set-year`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.date.set-year.js) and [`es.date.to-gmt-string`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.date.to-gmt-string.js). -```js -class Date { - getYear(): int; - setYear(year: int): number; - toGMTString(): string; - toISOString(): string; - toJSON(): string; - toString(): string; - @@toPrimitive(hint: 'default' | 'number' | 'string'): string | number; - static now(): number; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js/es|stable|actual|full/date -core-js/es|stable|actual|full/date/to-string -core-js(-pure)/es|stable|actual|full/date/now -core-js(-pure)/es|stable|actual|full/date/get-year -core-js(-pure)/es|stable|actual|full/date/set-year -core-js(-pure)/es|stable|actual|full/date/to-gmt-string -core-js(-pure)/es|stable|actual|full/date/to-iso-string -core-js(-pure)/es|stable|actual|full/date/to-json -core-js(-pure)/es|stable|actual|full/date/to-primitive -``` -[*Example*](https://goo.gl/haeHLR): -```js -new Date(NaN).toString(); // => 'Invalid Date' -``` -#### ECMAScript: Promise[⬆](#index) -Modules [`es.promise`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.promise.js), [`es.promise.all-settled`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.promise.all-settled.js), [`es.promise.any`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.promise.any.js) and [`es.promise.finally`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.promise.finally.js). -```js -class Promise { - constructor(executor: (resolve: Function, reject: Function) => void): Promise; - then(onFulfilled: Function, onRejected: Function): Promise; - catch(onRejected: Function): Promise; - finally(onFinally: Function): Promise; - static resolve(x: any): Promise; - static reject(r: any): Promise; - static all(iterable: Iterable): Promise; - static allSettled(iterable: Iterable): Promise; - static any(promises: Iterable): Promise; - static race(iterable: Iterable): Promise; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js(-pure)/es|stable|actual|full/promise -core-js(-pure)/es|stable|actual|full/promise/all-settled -core-js(-pure)/es|stable|actual|full/promise/any -core-js(-pure)/es|stable|actual|full/promise/finally -``` -Basic [*example*](https://goo.gl/vGrtUC): -```js -function sleepRandom(time) { - return new Promise((resolve, reject) => { - setTimeout(resolve, time * 1e3, 0 | Math.random() * 1e3); - }); -} - -console.log('Run'); // => Run -sleepRandom(5).then(result => { - console.log(result); // => 869, after 5 sec. - return sleepRandom(10); -}).then(result => { - console.log(result); // => 202, after 10 sec. -}).then(() => { - console.log('immediately after'); // => immediately after - throw Error('Irror!'); -}).then(() => { - console.log('will not be displayed'); -}).catch(x => console.log(x)); // => => Error: Irror! -``` -`Promise.resolve` and `Promise.reject` [*example*](https://goo.gl/vr8TN3): -```js -Promise.resolve(42).then(x => console.log(x)); // => 42 -Promise.reject(42).catch(x => console.log(x)); // => 42 - -Promise.resolve($.getJSON('/data.json')); // => ES promise -``` -`Promise#finally` [*example*](https://goo.gl/AhyBbJ): -```js -Promise.resolve(42).finally(() => console.log('You will see it anyway')); - -Promise.reject(42).finally(() => console.log('You will see it anyway')); -``` -`Promise.all` [*example*](https://goo.gl/RdoDBZ): -```js -Promise.all([ - 'foo', - sleepRandom(5), - sleepRandom(15), - sleepRandom(10) // after 15 sec: -]).then(x => console.log(x)); // => ['foo', 956, 85, 382] -``` -`Promise.race` [*example*](https://goo.gl/L8ovkJ): -```js -function timeLimit(promise, time) { - return Promise.race([promise, new Promise((resolve, reject) => { - setTimeout(reject, time * 1e3, Error('Await > ' + time + ' sec')); - })]); -} - -timeLimit(sleepRandom(5), 10).then(x => console.log(x)); // => 853, after 5 sec. -timeLimit(sleepRandom(15), 10).catch(x => console.log(x)); // Error: Await > 10 sec -``` -`Promise.allSettled` [*example*](https://goo.gl/PXXLNJ): -```js -Promise.allSettled([ - Promise.resolve(1), - Promise.reject(2), - Promise.resolve(3), -]).then(console.log); // => [{ value: 1, status: 'fulfilled' }, { reason: 2, status: 'rejected' }, { value: 3, status: 'fulfilled' }] -``` -`Promise.any` [*example*](https://goo.gl/iErvmp): -```js -Promise.any([ - Promise.resolve(1), - Promise.reject(2), - Promise.resolve(3), -]).then(console.log); // => 1 - -Promise.any([ - Promise.reject(1), - Promise.reject(2), - Promise.reject(3), -]).catch(({ errors }) => console.log(errors)); // => [1, 2, 3] -``` -[Example](https://goo.gl/wnQS4j) with async functions: -```js -let delay = time => new Promise(resolve => setTimeout(resolve, time)) - -async function sleepRandom(time) { - await delay(time * 1e3); - return 0 | Math.random() * 1e3; -} - -async function sleepError(time, msg) { - await delay(time * 1e3); - throw Error(msg); -} - -(async () => { - try { - console.log('Run'); // => Run - console.log(await sleepRandom(5)); // => 936, after 5 sec. - let [a, b, c] = await Promise.all([ - sleepRandom(5), - sleepRandom(15), - sleepRandom(10) - ]); - console.log(a, b, c); // => 210 445 71, after 15 sec. - await sleepError(5, 'Error!'); - console.log('Will not be displayed'); - } catch (e) { - console.log(e); // => Error: 'Error!', after 5 sec. - } -})(); -``` - -##### Unhandled rejection tracking[⬆](#index) - -In Node.js, like in native implementation, available events [`unhandledRejection`](https://nodejs.org/api/process.html#process_event_unhandledrejection) and [`rejectionHandled`](https://nodejs.org/api/process.html#process_event_rejectionhandled): -```js -process.on('unhandledRejection', (reason, promise) => console.log('unhandled', reason, promise)); -process.on('rejectionHandled', (promise) => console.log('handled', promise)); - -let promise = Promise.reject(42); -// unhandled 42 [object Promise] - -setTimeout(() => promise.catch(() => {}), 1e3); -// handled [object Promise] -``` -In a browser on rejection, by default, you will see notify in the console, or you can add a custom handler and a handler on handling unhandled, [*example*](https://goo.gl/Wozskl): -```js -window.addEventListener('unhandledrejection', e => console.log('unhandled', e.reason, e.promise)); -window.addEventListener('rejectionhandled', e => console.log('handled', e.reason, e.promise)); -// or -window.onunhandledrejection = e => console.log('unhandled', e.reason, e.promise); -window.onrejectionhandled = e => console.log('handled', e.reason, e.promise); - -let promise = Promise.reject(42); -// => unhandled 42 [object Promise] - -setTimeout(() => promise.catch(() => {}), 1e3); -// => handled 42 [object Promise] -``` - -#### ECMAScript: Symbol[⬆](#index) -Modules [`es.symbol`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.symbol.js), [`es.symbol.async-iterator`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.symbol.async-iterator.js), [`es.symbol.description`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.symbol.description.js), [`es.symbol.has-instance`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.symbol.has-instance.js), [`es.symbol.is-concat-spreadable`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.symbol.is-concat-spreadable.js), [`es.symbol.iterator`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.symbol.iterator.js), [`es.symbol.match`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.symbol.match.js), [`es.symbol.replace`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.symbol.replace.js), [`es.symbol.search`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.symbol.search.js), [`es.symbol.species`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.symbol.species.js), [`es.symbol.split`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.symbol.split.js), [`es.symbol.to-primitive`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.symbol.to-primitive.js), [`es.symbol.to-string-tag`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.symbol.to-string-tag.js), [`es.symbol.unscopables`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.symbol.unscopables.js), [`es.math.to-string-tag`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.math.to-string-tag.js). -```js -class Symbol { - constructor(description?): symbol; - readonly attribute description: string | void; - static asyncIterator: @@asyncIterator; - static hasInstance: @@hasInstance; - static isConcatSpreadable: @@isConcatSpreadable; - static iterator: @@iterator; - static match: @@match; - static replace: @@replace; - static search: @@search; - static species: @@species; - static split: @@split; - static toPrimitive: @@toPrimitive; - static toStringTag: @@toStringTag; - static unscopables: @@unscopables; - static for(key: string): symbol; - static keyFor(sym: symbol): string; - static useSimple(): void; - static useSetter(): void; -} - -class Object { - static getOwnPropertySymbols(object: any): Array; -} -``` -Also wrapped some methods for correct work with `Symbol` polyfill. -```js -class Object { - static create(prototype: Object | null, properties?: { [property: PropertyKey]: PropertyDescriptor }): Object; - static defineProperties(object: Object, properties: { [property: PropertyKey]: PropertyDescriptor })): Object; - static defineProperty(object: Object, property: PropertyKey, attributes: PropertyDescriptor): Object; - static getOwnPropertyDescriptor(object: any, property: PropertyKey): PropertyDescriptor | void; - static getOwnPropertyNames(object: any): Array; - propertyIsEnumerable(key: PropertyKey): boolean; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js(-pure)/es|stable|actual|full/symbol -core-js(-pure)/es|stable|actual|full/symbol/async-iterator -core-js/es|stable|actual|full/symbol/description -core-js(-pure)/es|stable|actual|full/symbol/has-instance -core-js(-pure)/es|stable|actual|full/symbol/is-concat-spreadable -core-js(-pure)/es|stable|actual|full/symbol/iterator -core-js(-pure)/es|stable|actual|full/symbol/match -core-js(-pure)/es|stable|actual|full/symbol/replace -core-js(-pure)/es|stable|actual|full/symbol/search -core-js(-pure)/es|stable|actual|full/symbol/species -core-js(-pure)/es|stable|actual|full/symbol/split -core-js(-pure)/es|stable|actual|full/symbol/to-primitive -core-js(-pure)/es|stable|actual|full/symbol/to-string-tag -core-js(-pure)/es|stable|actual|full/symbol/unscopables -core-js(-pure)/es|stable|actual|full/symbol/for -core-js(-pure)/es|stable|actual|full/symbol/key-for -core-js(-pure)/es|stable|actual|full/object/get-own-property-symbols -core-js(-pure)/es|stable|actual|full/math/to-string-tag -``` -[*Basic example*](https://goo.gl/BbvWFc): -```js -let Person = (() => { - let NAME = Symbol('name'); - return class { - constructor(name) { - this[NAME] = name; - } - getName() { - return this[NAME]; - } - } -})(); - -let person = new Person('Vasya'); -console.log(person.getName()); // => 'Vasya' -console.log(person['name']); // => undefined -console.log(person[Symbol('name')]); // => undefined, symbols are uniq -for (let key in person) console.log(key); // => nothing, symbols are not enumerable -``` -`Symbol.for` & `Symbol.keyFor` [*example*](https://goo.gl/0pdJjX): -```js -let symbol = Symbol.for('key'); -symbol === Symbol.for('key'); // true -Symbol.keyFor(symbol); // 'key' -``` -[*Example*](https://goo.gl/mKVOQJ) with methods for getting own object keys: -```js -let object = { a: 1 }; -Object.defineProperty(object, 'b', { value: 2 }); -object[Symbol('c')] = 3; -Object.keys(object); // => ['a'] -Object.getOwnPropertyNames(object); // => ['a', 'b'] -Object.getOwnPropertySymbols(object); // => [Symbol(c)] -Reflect.ownKeys(object); // => ['a', 'b', Symbol(c)] -``` - -[*Symbol#description getter*](https://goo.gl/MWizfc): -```js -Symbol('foo').description; // => 'foo' -Symbol().description; // => undefined -``` -##### Caveats when using `Symbol` polyfill:[⬆](#index) - -* We can't add new primitive type, `Symbol` returns object. -* `Symbol.for` and `Symbol.keyFor` can't be polyfilled cross-realm. -* By default, to hide the keys, `Symbol` polyfill defines setter in `Object.prototype`. For this reason, uncontrolled creation of symbols can cause memory leak and the `in` operator is not working correctly with `Symbol` polyfill: `Symbol() in {} // => true`. - -You can disable defining setters in `Object.prototype`. [Example](https://goo.gl/N5UD7J): -```js -Symbol.useSimple(); -let symbol1 = Symbol('symbol1'); -let object1 = {}; -object1[symbol1] = true; -for (let key in object1) console.log(key); // => 'Symbol(symbol1)_t.qamkg9f3q', w/o native Symbol - -Symbol.useSetter(); -let symbol2 = Symbol('symbol2'); -let object2 = {}; -object2[symbol2] = true; -for (let key in object2) console.log(key); // nothing -``` -* Currently, `core-js` not adds setters to `Object.prototype` for well-known symbols for correct work something like `Symbol.iterator in foo`. It can cause problems with their enumerability. -* Some problems possible with environment exotic objects (for example, IE `localStorage`). - -#### ECMAScript: Collections[⬆](#index) -`core-js` uses native collections in most case, just fixes methods / constructor, if it's required, and in old environment uses fast polyfill (O(1) lookup). -#### Map[⬆](#index) -Module [`es.map`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.map.js). -```js -class Map { - constructor(iterable?: Iterable<[key, value]>): Map; - clear(): void; - delete(key: any): boolean; - forEach(callbackfn: (value: any, key: any, target: any) => void, thisArg: any): void; - get(key: any): any; - has(key: any): boolean; - set(key: any, val: any): this; - values(): Iterator; - keys(): Iterator; - entries(): Iterator<[key, value]>; - @@iterator(): Iterator<[key, value]>; - readonly attribute size: number; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js(-pure)/es|stable|actual|full/map -``` -[*Examples*](https://goo.gl/GWR7NI): -```js -let array = [1]; - -let map = new Map([['a', 1], [42, 2]]); -map.set(array, 3).set(true, 4); - -console.log(map.size); // => 4 -console.log(map.has(array)); // => true -console.log(map.has([1])); // => false -console.log(map.get(array)); // => 3 -map.forEach((val, key) => { - console.log(val); // => 1, 2, 3, 4 - console.log(key); // => 'a', 42, [1], true -}); -map.delete(array); -console.log(map.size); // => 3 -console.log(map.get(array)); // => undefined -console.log(Array.from(map)); // => [['a', 1], [42, 2], [true, 4]] - -let map = new Map([['a', 1], ['b', 2], ['c', 3]]); - -for (let [key, value] of map) { - console.log(key); // => 'a', 'b', 'c' - console.log(value); // => 1, 2, 3 -} -for (let value of map.values()) console.log(value); // => 1, 2, 3 -for (let key of map.keys()) console.log(key); // => 'a', 'b', 'c' -for (let [key, value] of map.entries()) { - console.log(key); // => 'a', 'b', 'c' - console.log(value); // => 1, 2, 3 -} -``` -#### Set[⬆](#index) -Module [`es.set`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.set.js). -```js -class Set { - constructor(iterable?: Iterable): Set; - add(key: any): this; - clear(): void; - delete(key: any): boolean; - forEach((value: any, key: any, target: any) => void, thisArg: any): void; - has(key: any): boolean; - values(): Iterator; - keys(): Iterator; - entries(): Iterator<[value, value]>; - @@iterator(): Iterator; - readonly attribute size: number; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js(-pure)/es|stable|actual|full/set -``` -[*Examples*](https://goo.gl/bmhLwg): -```js -let set = new Set(['a', 'b', 'a', 'c']); -set.add('d').add('b').add('e'); -console.log(set.size); // => 5 -console.log(set.has('b')); // => true -set.forEach(it => { - console.log(it); // => 'a', 'b', 'c', 'd', 'e' -}); -set.delete('b'); -console.log(set.size); // => 4 -console.log(set.has('b')); // => false -console.log(Array.from(set)); // => ['a', 'c', 'd', 'e'] - -let set = new Set([1, 2, 3, 2, 1]); - -for (let value of set) console.log(value); // => 1, 2, 3 -for (let value of set.values()) console.log(value); // => 1, 2, 3 -for (let key of set.keys()) console.log(key); // => 1, 2, 3 -for (let [key, value] of set.entries()) { - console.log(key); // => 1, 2, 3 - console.log(value); // => 1, 2, 3 -} -``` -#### WeakMap[⬆](#index) -Module [`es.weak-map`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.weak-map.js). -```js -class WeakMap { - constructor(iterable?: Iterable<[key, value]>): WeakMap; - delete(key: Object): boolean; - get(key: Object): any; - has(key: Object): boolean; - set(key: Object, val: any): this; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js(-pure)/es|stable|actual|full/weak-map -``` -[*Examples*](https://goo.gl/SILXyw): -```js -let a = [1]; -let b = [2]; -let c = [3]; - -let weakmap = new WeakMap([[a, 1], [b, 2]]); -weakmap.set(c, 3).set(b, 4); -console.log(weakmap.has(a)); // => true -console.log(weakmap.has([1])); // => false -console.log(weakmap.get(a)); // => 1 -weakmap.delete(a); -console.log(weakmap.get(a)); // => undefined - -// Private properties store: -let Person = (() => { - let names = new WeakMap; - return class { - constructor(name) { - names.set(this, name); - } - getName() { - return names.get(this); - } - } -})(); - -let person = new Person('Vasya'); -console.log(person.getName()); // => 'Vasya' -for (let key in person) console.log(key); // => only 'getName' -``` -#### WeakSet[⬆](#index) -Module [`es.weak-set`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.weak-set.js). -```js -class WeakSet { - constructor(iterable?: Iterable): WeakSet; - add(key: Object): this; - delete(key: Object): boolean; - has(key: Object): boolean; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js(-pure)/es|stable|actual|full/weak-set -``` -[*Examples*](https://goo.gl/TdFbEx): -```js -let a = [1]; -let b = [2]; -let c = [3]; - -let weakset = new WeakSet([a, b, a]); -weakset.add(c).add(b).add(c); -console.log(weakset.has(b)); // => true -console.log(weakset.has([2])); // => false -weakset.delete(b); -console.log(weakset.has(b)); // => false -``` -##### Caveats when using collections polyfill:[⬆](#index) - -* Weak-collections polyfill stores values as hidden properties of keys. It works correct and not leak in most cases. However, it is desirable to store a collection longer than its keys. - -#### ECMAScript: Typed Arrays[⬆](#index) -Implementations and fixes for `ArrayBuffer`, `DataView`, Typed Arrays constructors, static and prototype methods. Typed arrays work only in environments with support descriptors (IE9+), `ArrayBuffer` and `DataView` should work anywhere. - -Modules [`es.array-buffer.constructor`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array-buffer.constructor.js), [`es.array-buffer.is-view`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array-buffer.is-view.js), [`es.array-buffer.slice`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.array-buffer.slice.js), [`es.data-view`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.data-view.js), [`es.typed-array.int8-array`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.int8-array.js), [`es.typed-array.uint8-array`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.uint8-array.js), [`es.typed-array.uint8-clamped-array`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.uint8-clamped-array.js), [`es.typed-array.int16-array`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.int16-array.js), [`es.typed-array.uint16-array`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.uint16-array.js), [`es.typed-array.int32-array`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed.int32-array.js), [`es.typed-array.uint32-array`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.uint32-array.js), [`es.typed-array.float32-array`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.float32-array.js), [`es.typed-array.float64-array`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.float64-array.js), [`es.typed-array.copy-within`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.copy-within.js), [`es.typed-array.every`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.every.js), [`es.typed-array.fill`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.fill.js), [`es.typed-array.filter`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.filter.js), [`es.typed-array.find`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.find.js), [`es.typed-array.find-index`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.find-index.js), [`es.typed-array.find-last`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.find-last.js), [`es.typed-array.find-last-index`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.find-last-index.js), [`es.typed-array.for-each`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.for-each.js), [`es.typed-array.from`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.from.js), [`es.typed-array.includes`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.includes.js), [`es.typed-array.index-of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.index-of.js), [`es.typed-array.iterator`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.iterator.js), [`es.typed-array.last-index-of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.last-index-of.js), [`es.typed-array.map`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.map.js), [`es.typed-array.of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.of.js), [`es.typed-array.reduce`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.reduce.js), [`es.typed-array.reduce-right`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.reduce-right.js), [`es.typed-array.reverse`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.reverse.js), [`es.typed-array.set`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.set.js), [`es.typed-array.slice`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.slice.js), [`es.typed-array.some`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.some.js), [`es.typed-array.sort`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.sort.js), [`es.typed-array.subarray`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.subarray.js), [`es.typed-array.to-locale-string`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.to-locale-string.js), [`es.typed-array.to-string`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.to-string.js), [`es.typed-array.at`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.typed-array.at.js). -```js -class ArrayBuffer { - constructor(length: any): ArrayBuffer; - slice(start: any, end: any): ArrayBuffer; - readonly attribute byteLength: number; - static isView(arg: any): boolean; -} - -class DataView { - constructor(buffer: ArrayBuffer, byteOffset?: number, byteLength?: number): DataView; - getInt8(offset: any): int8; - getUint8(offset: any): uint8 - getInt16(offset: any, littleEndian?: boolean = false): int16; - getUint16(offset: any, littleEndian?: boolean = false): uint16; - getInt32(offset: any, littleEndian?: boolean = false): int32; - getUint32(offset: any, littleEndian?: boolean = false): uint32; - getFloat32(offset: any, littleEndian?: boolean = false): float32; - getFloat64(offset: any, littleEndian?: boolean = false): float64; - setInt8(offset: any, value: any): void; - setUint8(offset: any, value: any): void; - setInt16(offset: any, value: any, littleEndian?: boolean = false): void; - setUint16(offset: any, value: any, littleEndian?: boolean = false): void; - setInt32(offset: any, value: any, littleEndian?: boolean = false): void; - setUint32(offset: any, value: any, littleEndian?: boolean = false): void; - setFloat32(offset: any, value: any, littleEndian?: boolean = false): void; - setFloat64(offset: any, value: any, littleEndian?: boolean = false): void; - readonly attribute buffer: ArrayBuffer; - readonly attribute byteLength: number; - readonly attribute byteOffset: number; -} - -class [ - Int8Array, - Uint8Array, - Uint8ClampedArray, - Int16Array, - Uint16Array, - Int32Array, - Uint32Array, - Float32Array, - Float64Array, -] extends %TypedArray% { - constructor(length: number): %TypedArray%; - constructor(object: %TypedArray% | Iterable | ArrayLike): %TypedArray%; - constructor(buffer: ArrayBuffer, byteOffset?: number, length?: number): %TypedArray% -} - -class %TypedArray% { - at(index: int): number; - copyWithin(target: number, start: number, end?: number): this; - every(callbackfn: (value: number, index: number, target: %TypedArray%) => boolean, thisArg?: any): boolean; - fill(value: number, start?: number, end?: number): this; - filter(callbackfn: (value: number, index: number, target: %TypedArray%) => boolean, thisArg?: any): %TypedArray%; - find(callbackfn: (value: number, index: number, target: %TypedArray%) => boolean), thisArg?: any): any; - findIndex(callbackfn: (value: number, index: number, target: %TypedArray%) => boolean, thisArg?: any): uint; - findLast(callbackfn: (value: any, index: number, target: %TypedArray%) => boolean, thisArg?: any): any; - findLastIndex(callbackfn: (value: any, index: number, target: %TypedArray%) => boolean, thisArg?: any): uint; - forEach(callbackfn: (value: number, index: number, target: %TypedArray%) => void, thisArg?: any): void; - includes(searchElement: any, from?: number): boolean; - indexOf(searchElement: any, from?: number): number; - join(separator: string = ','): string; - lastIndexOf(searchElement: any, from?: number): number; - map(mapFn: (value: number, index: number, target: %TypedArray%) => number, thisArg?: any): %TypedArray%; - reduce(callbackfn: (memo: any, value: number, index: number, target: %TypedArray%) => any, initialValue?: any): any; - reduceRight(callbackfn: (memo: any, value: number, index: number, target: %TypedArray%) => any, initialValue?: any): any; - reverse(): this; - set(array: ArrayLike, offset?: number): void; - slice(start?: number, end?: number): %TypedArray%; - some(callbackfn: (value: number, index: number, target: %TypedArray%) => boolean, thisArg?: any): boolean; - sort(comparefn?: (a: number, b: number) => number): this; // with modern behavior like stable sort - subarray(begin?: number, end?: number): %TypedArray%; - toString(): string; - toLocaleString(): string; - values(): Iterator; - keys(): Iterator; - entries(): Iterator<[index, value]>; - @@iterator(): Iterator; - readonly attribute buffer: ArrayBuffer; - readonly attribute byteLength: number; - readonly attribute byteOffset: number; - readonly attribute length: number; - BYTES_PER_ELEMENT: number; - static from(items: Iterable | ArrayLike, mapFn?: (value: any, index: number) => any, thisArg?: any): %TypedArray%; - static of(...args: Array): %TypedArray%; - static BYTES_PER_ELEMENT: number; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js/es|stable|actual|full/array-buffer -core-js/es|stable|actual|full/array-buffer/constructor -core-js/es|stable|actual|full/array-buffer/is-view -core-js/es|stable|actual|full/array-buffer/slice -core-js/es|stable|actual|full/data-view -core-js/es|stable|actual|full/typed-array -core-js/es|stable|actual|full/typed-array/int8-array -core-js/es|stable|actual|full/typed-array/uint8-array -core-js/es|stable|actual|full/typed-array/uint8-clamped-array -core-js/es|stable|actual|full/typed-array/int16-array -core-js/es|stable|actual|full/typed-array/uint16-array -core-js/es|stable|actual|full/typed-array/int32-array -core-js/es|stable|actual|full/typed-array/uint32-array -core-js/es|stable|actual|full/typed-array/float32-array -core-js/es|stable|actual|full/typed-array/float64-array -core-js/es|stable|actual|full/typed-array/at -core-js/es|stable|actual|full/typed-array/copy-within -core-js/es|stable|actual|full/typed-array/entries -core-js/es|stable|actual|full/typed-array/every -core-js/es|stable|actual|full/typed-array/fill -core-js/es|stable|actual|full/typed-array/filter -core-js/es|stable|actual|full/typed-array/find -core-js/es|stable|actual|full/typed-array/find-index -core-js/es|stable|actual|full/typed-array/find-last -core-js/es|stable|actual|full/typed-array/find-last-index -core-js/es|stable|actual|full/typed-array/for-each -core-js/es|stable|actual|full/typed-array/from -core-js/es|stable|actual|full/typed-array/includes -core-js/es|stable|actual|full/typed-array/index-of -core-js/es|stable|actual|full/typed-array/iterator -core-js/es|stable|actual|full/typed-array/join -core-js/es|stable|actual|full/typed-array/keys -core-js/es|stable|actual|full/typed-array/last-index-of -core-js/es|stable|actual|full/typed-array/map -core-js/es|stable|actual|full/typed-array/of -core-js/es|stable|actual|full/typed-array/reduce -core-js/es|stable|actual|full/typed-array/reduce-right -core-js/es|stable|actual|full/typed-array/reverse -core-js/es|stable|actual|full/typed-array/set -core-js/es|stable|actual|full/typed-array/slice -core-js/es|stable|actual|full/typed-array/some -core-js/es|stable|actual|full/typed-array/sort -core-js/es|stable|actual|full/typed-array/subarray -core-js/es|stable|actual|full/typed-array/to-locale-string -core-js/es|stable|actual|full/typed-array/to-string -core-js/es|stable|actual|full/typed-array/values -``` -[*Examples*](https://is.gd/Eo7ltU): -```js -new Int32Array(4); // => [0, 0, 0, 0] -new Uint8ClampedArray([1, 2, 3, 666]); // => [1, 2, 3, 255] -new Float32Array(new Set([1, 2, 3, 2, 1])); // => [1, 2, 3] - -let buffer = new ArrayBuffer(8); -let view = new DataView(buffer); -view.setFloat64(0, 123.456, true); -new Uint8Array(buffer.slice(4)); // => [47, 221, 94, 64] - -Int8Array.of(1, 1.5, 5.7, 745); // => [1, 1, 5, -23] -Uint8Array.from([1, 1.5, 5.7, 745]); // => [1, 1, 5, 233] - -let typed = new Uint8Array([1, 2, 3]); - -let a = typed.slice(1); // => [2, 3] -typed.buffer === a.buffer; // => false -let b = typed.subarray(1); // => [2, 3] -typed.buffer === b.buffer; // => true - -typed.filter(it => it % 2); // => [1, 3] -typed.map(it => it * 1.5); // => [1, 3, 4] - -for (let value of typed) console.log(value); // => 1, 2, 3 -for (let value of typed.values()) console.log(value); // => 1, 2, 3 -for (let key of typed.keys()) console.log(key); // => 0, 1, 2 -for (let [key, value] of typed.entries()) { - console.log(key); // => 0, 1, 2 - console.log(value); // => 1, 2, 3 -} - -new Int32Array([1, 2, 3]).at(1); // => 2 -new Int32Array([1, 2, 3]).at(-1); // => 3 -``` -##### Caveats when using typed arrays polyfills:[⬆](#index) - -* Polyfills of Typed Arrays constructors work completely how should work by the spec, but because of internal usage of getters / setters on each instance, are slow and consumes significant memory. However, polyfills of Typed Arrays constructors required mainly for old IE, all modern engines have native Typed Arrays constructors and require only fixes of constructors and polyfills of methods. - -#### ECMAScript: Reflect[⬆](#index) -Modules [`es.reflect.apply`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.reflect.apply.js), [`es.reflect.construct`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.reflect.construct.js), [`es.reflect.define-property`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.reflect.define-property.js), [`es.reflect.delete-property`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.reflect.delete-property.js), [`es.reflect.get`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.reflect.get.js), [`es.reflect.get-own-property-descriptor`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.reflect.get-own-property-descriptor.js), [`es.reflect.get-prototype-of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.reflect.get-prototype-of.js), [`es.reflect.has`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.reflect.has.js), [`es.reflect.is-extensible`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.reflect.is-extensible.js), [`es.reflect.own-keys`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.reflect.own-keys.js), [`es.reflect.prevent-extensions`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.reflect.prevent-extensions.js), [`es.reflect.set`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.reflect.set.js), [`es.reflect.set-prototype-of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.reflect.set-prototype-of.js). -```js -namespace Reflect { - apply(target: Function, thisArgument: any, argumentsList: Array): any; - construct(target: Function, argumentsList: Array, newTarget?: Function): Object; - defineProperty(target: Object, propertyKey: PropertyKey, attributes: PropertyDescriptor): boolean; - deleteProperty(target: Object, propertyKey: PropertyKey): boolean; - get(target: Object, propertyKey: PropertyKey, receiver?: any): any; - getOwnPropertyDescriptor(target: Object, propertyKey: PropertyKey): PropertyDescriptor | void; - getPrototypeOf(target: Object): Object | null; - has(target: Object, propertyKey: PropertyKey): boolean; - isExtensible(target: Object): boolean; - ownKeys(target: Object): Array; - preventExtensions(target: Object): boolean; - set(target: Object, propertyKey: PropertyKey, V: any, receiver?: any): boolean; - setPrototypeOf(target: Object, proto: Object | null): boolean; // required __proto__ - IE11+ -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js(-pure)/es|stable|actual|full/reflect -core-js(-pure)/es|stable|actual|full/reflect/apply -core-js(-pure)/es|stable|actual|full/reflect/construct -core-js(-pure)/es|stable|actual|full/reflect/define-property -core-js(-pure)/es|stable|actual|full/reflect/delete-property -core-js(-pure)/es|stable|actual|full/reflect/get -core-js(-pure)/es|stable|actual|full/reflect/get-own-property-descriptor -core-js(-pure)/es|stable|actual|full/reflect/get-prototype-of -core-js(-pure)/es|stable|actual|full/reflect/has -core-js(-pure)/es|stable|actual|full/reflect/is-extensible -core-js(-pure)/es|stable|actual|full/reflect/own-keys -core-js(-pure)/es|stable|actual|full/reflect/prevent-extensions -core-js(-pure)/es|stable|actual|full/reflect/set -core-js(-pure)/es|stable|actual|full/reflect/set-prototype-of -``` -[*Examples*](https://goo.gl/gVT0cH): -```js -let object = { a: 1 }; -Object.defineProperty(object, 'b', { value: 2 }); -object[Symbol('c')] = 3; -Reflect.ownKeys(object); // => ['a', 'b', Symbol(c)] - -function C(a, b) { - this.c = a + b; -} - -let instance = Reflect.construct(C, [20, 22]); -instance.c; // => 42 -``` - -#### ECMAScript: JSON[⬆](#index) -Since `JSON` object is missed only in very old engines like IE7-, `core-js` does not provide a full `JSON` polyfill, however, fix already existing implementations by the current standard, for example, [well-formed `JSON.stringify`](https://github.com/tc39/proposal-well-formed-stringify). `JSON` also fixed in other modules - for example, `Symbol` polyfill fixes `JSON.stringify` for correct work with symbols. - -Module [`es.json.to-string-tag`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.json.to-string-tag.js) and [`es.json.stringify`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.json.stringify.js). -```js -namespace JSON { - stringify(target: any, replacer?: Function | Array, space?: string | number): string | void; - @@toStringTag: 'JSON'; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js(-pure)/es|stable|actual|full/json/stringify -core-js(-pure)/es|stable|actual|full/json/to-string-tag -``` -[*Examples*](https://is.gd/izZqKn): -```js -JSON.stringify({ '𠮷': ['\uDF06\uD834'] }); // => '{"𠮷":["\\udf06\\ud834"]}' -``` - -#### ECMAScript: globalThis[⬆](#index) -Module [`es.global-this`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.global-this.js). -```js -let globalThis: Object; -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js(-pure)/es|stable|actual|full/global-this -``` -[*Examples*](https://goo.gl/LAifsc): -```js -globalThis.Array === Array; // => true -``` - -### ECMAScript proposals[⬆](#index) -[The TC39 process.](https://tc39.github.io/process-document/) - -#### Finished proposals[⬆](#index) - -Finished (stage 4) proposals already marked in `core-js` as stable ECMAScript, they are available in `core-js/stable` and `core-js/es` namespace, you can find then in related sections of this doc. However, even for finished proposals, `core-js` provide a way to include only features for a specific proposal like `core-js/proposals/proposal-name`. - -##### [`globalThis`](https://github.com/tc39/proposal-global)[⬆](#index) -```js -let globalThis: Object; -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/global-this -``` -##### [Relative indexing method](https://github.com/tc39/proposal-relative-indexing-method)[⬆](#index) -```js -class Array { - at(index: int): any; -} - -class String { - at(index: int): string; -} - -class %TypedArray% { - at(index: int): number; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js/proposals/relative-indexing-method -``` -##### [`Array.prototype.includes`](https://github.com/tc39/proposal-Array.prototype.includes)[⬆](#index) -```js -class Array { - includes(searchElement: any, from?: number): boolean; -} - -class %TypedArray% { - includes(searchElement: any, from?: number): boolean; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js/proposals/array-includes -``` -##### [`Array.prototype.flat` / `Array.prototype.flatMap`](https://github.com/tc39/proposal-flatMap)[⬆](#index) -```js -class Array { - flat(depthArg?: number = 1): Array; - flatMap(mapFn: (value: any, index: number, target: any) => any, thisArg: any): Array; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js/proposals/array-flat-map -``` -##### [Array find from last](https://github.com/tc39/proposal-array-find-from-last)[⬆](#index) -```js -class Array { - findLast(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): any; - findLastIndex(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): uint; -} - -class %TypedArray% { - findLast(callbackfn: (value: any, index: number, target: %TypedArray%) => boolean, thisArg?: any): any; - findLastIndex(callbackfn: (value: any, index: number, target: %TypedArray%) => boolean, thisArg?: any): uint; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js/proposals/array-find-from-last -``` -##### [`Object.values` / `Object.entries`](https://github.com/tc39/proposal-object-values-entries)[⬆](#index) -```js -class Object { - static entries(object: Object): Array<[string, mixed]>; - static values(object: any): Array; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js/proposals/object-values-entries -``` -##### [`Object.fromEntries`](https://github.com/tc39/proposal-object-from-entries)[⬆](#index) -```js -class Object { - static fromEntries(iterable: Iterable<[key, value]>): Object; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js/proposals/object-from-entries -``` -##### [`Object.getOwnPropertyDescriptors`](https://github.com/tc39/proposal-object-getownpropertydescriptors)[⬆](#index) -```js -class Object { - static getOwnPropertyDescriptors(object: any): { [property: PropertyKey]: PropertyDescriptor }; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js/proposals/object-getownpropertydescriptors -``` -##### [Accessible `Object.prototype.hasOwnProperty`](https://github.com/tc39/proposal-accessible-object-hasownproperty)[⬆](#index) -```js -class Object { - static hasOwn(object: object, key: PropertyKey): boolean; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js/proposals/accessible-object-hasownproperty -``` -##### [`String` padding](https://github.com/tc39/proposal-string-pad-start-end)[⬆](#index) -```js -class String { - padStart(length: number, fillStr?: string = ' '): string; - padEnd(length: number, fillStr?: string = ' '): string; -} - -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js/proposals/string-padding -``` -##### [`String#matchAll`](https://github.com/tc39/proposal-string-matchall)[⬆](#index). -```js -class String { - matchAll(regexp: RegExp): Iterator; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/string-match-all -``` -##### [`String#replaceAll`](https://github.com/tc39/proposal-string-replace-all)[⬆](#index) -```js -class String { - replaceAll(searchValue: string | RegExp, replaceString: string | (searchValue, index, this) => string): string; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/string-replace-all-stage-4 -``` -##### [`String.prototype.trimStart` / `String.prototype.trimEnd`](https://github.com/tc39/proposal-string-left-right-trim)[⬆](#index) -```js -class String { - trimLeft(): string; - trimRight(): string; - trimStart(): string; - trimEnd(): string; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/string-left-right-trim -``` -##### [`RegExp` `s` (`dotAll`) flag](https://github.com/tc39/proposal-regexp-dotall-flag)[⬆](#index) -```js -// patched for support `RegExp` dotAll (`s`) flag: -class RegExp { - constructor(pattern: RegExp | string, flags?: string): RegExp; - exec(): Array | null; - readonly attribute dotAll: boolean; - readonly attribute flags: string; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/regexp-dotall-flag -``` -##### [`RegExp` named capture groups](https://github.com/tc39/proposal-regexp-named-groups)[⬆](#index) -```js -// patched for support `RegExp` named capture groups: -class RegExp { - constructor(pattern: RegExp | string, flags?: string): RegExp; - exec(): Array | null; - @@replace(string: string, replaceValue: Function | string): string; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/regexp-named-groups -``` -##### [`Promise.allSettled`](https://github.com/tc39/proposal-promise-allSettled)[⬆](#index) -```js -class Promise { - static allSettled(iterable: Iterable): Promise; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/promise-all-settled -``` -##### [`Promise.any`](https://github.com/tc39/proposal-promise-any)[⬆](#index) -```js -class AggregateError { - constructor(errors: Iterable, message: string): AggregateError; - errors: Array; - message: string; -} - -class Promise { - static any(promises: Iterable): Promise; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/promise-any -``` -##### [`Promise.prototype.finally`](https://github.com/tc39/proposal-promise-finally)[⬆](#index) -```js -class Promise { - finally(onFinally: Function): Promise; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/promise-finally -``` -##### [`Symbol.asyncIterator` for asynchronous iteration](https://github.com/tc39/proposal-async-iteration)[⬆](#index) -```js -class Symbol { - static asyncIterator: @@asyncIterator; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/async-iteration -``` -##### [`Symbol.prototype.description`](https://github.com/tc39/proposal-Symbol-description)[⬆](#index) -```js -class Symbol { - readonly attribute description: string | void; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/symbol-description -``` -##### [Well-formed `JSON.stringify`](https://github.com/tc39/proposal-well-formed-stringify)[⬆](#index) -```js -namespace JSON { - stringify(target: any, replacer?: Function | Array, space?: string | number): string | void; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/well-formed-stringify -``` - -#### Stage 3 proposals[⬆](#index) - -`core-js/stage/3` entry point contains only stage 3 proposals, `core-js/stage/2` - stage 2 and stage 3, etc. - -[*CommonJS entry points:*](#commonjs-api) -```js -core-js(-pure)/stage/3 -``` -##### [`Array` grouping](https://github.com/tc39/proposal-array-grouping)[⬆](#index) -Modules [`esnext.array.group`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.group.js), [`esnext.array.group-to-map`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.group-to-map.js). -```js -class Array { - group(callbackfn: (value: any, index: number, target: any) => key, thisArg?: any): { [key]: Array }; - groupToMap(callbackfn: (value: any, index: number, target: any) => key, thisArg?: any): Map>; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js/proposals/array-grouping-stage-3-2 -core-js(-pure)/actual|full/array(/virtual)/group -core-js(-pure)/actual|full/array(/virtual)/group-to-map -``` -[*Examples*](https://is.gd/3a0PbH): -```js -[1, 2, 3, 4, 5].group(it => it % 2); // => { 1: [1, 3, 5], 0: [2, 4] } - -const map = [1, 2, 3, 4, 5].groupToMap(it => it % 2); -map.get(1); // => [1, 3, 5] -map.get(0); // => [2, 4] -```` -##### [Change `Array` by copy](https://github.com/tc39/proposal-change-array-by-copy)[⬆](#index) -Modules [`esnext.array.to-reversed`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.to-reversed.js), [`esnext.array.to-sorted`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.to-sorted.js), [`esnext.array.to-spliced`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.to-spliced.js), [`esnext.array.with`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.with.js), [`esnext.typed-array.to-reversed`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.typed-array.to-reversed.js), [`esnext.typed-array.to-sorted`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.typed-array.to-sorted.js), [`esnext.typed-array.with`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.typed-array.with.js). -```js -class Array { - toReversed(): Array; - toSpliced(start?: number, deleteCount?: number, ...items: Array): Array; - toSorted(comparefn?: (a: any, b: any) => number): Array; - with(index: includes, value: any): Array; -} - -class %TypedArray% { - toReversed(): %TypedArray%; - toSorted(comparefn?: (a: any, b: any) => number): %TypedArray%; - with(index: includes, value: any): %TypedArray%; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js/proposals/change-array-by-copy -core-js(-pure)/actual|full/array(/virtual)/to-reversed -core-js(-pure)/actual|full/array(/virtual)/to-sorted -core-js(-pure)/actual|full/array(/virtual)/to-spliced -core-js(-pure)/actual|full/array(/virtual)/with -core-js/actual|full/typed-array/to-reversed -core-js/actual|full/typed-array/to-sorted -core-js/actual|full/typed-array/with -``` -[*Examples*](https://is.gd/tVkbY3): -```js -const sequence = [1, 2, 3]; -sequence.toReversed(); // => [3, 2, 1] -sequence; // => [1, 2, 3] - -const array = [1, 2, 3, 4]; -array.toSpliced(1, 2, 5, 6, 7); // => [1, 5, 6, 7, 4] -array; // => [1, 2, 3, 4] - -const outOfOrder = [3, 1, 2]; -outOfOrder.toSorted(); // => [1, 2, 3] -outOfOrder; // => [3, 1, 2] - -const correctionNeeded = [1, 1, 3]; -correctionNeeded.with(1, 2); // => [1, 2, 3] -correctionNeeded; // => [1, 1, 3] -```` - -#### Stage 2 proposals[⬆](#index) -[*CommonJS entry points:*](#commonjs-api) -``` -core-js(-pure)/stage/2 -``` -##### [Iterator helpers](https://github.com/tc39/proposal-iterator-helpers)[⬆](#index) -Modules [`esnext.async-iterator.constructor`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.constructor.js), [`esnext.async-iterator.drop`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.drop.js), [`esnext.async-iterator.every`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.every.js), [`esnext.async-iterator.filter`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.filter.js), [`esnext.async-iterator.find`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.find.js), [`esnext.async-iterator.flat-map`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.flat-map.js), [`esnext.async-iterator.for-each`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.for-each.js), [`esnext.async-iterator.from`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.from.js), [`esnext.async-iterator.indexed`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.indexed.js), [`esnext.async-iterator.map`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.map.js), [`esnext.async-iterator.reduce`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.reduce.js), [`esnext.async-iterator.some`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.some.js), [`esnext.async-iterator.take`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.take.js), [`esnext.async-iterator.to-array`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.to-array.js), [`esnext.iterator.constructor`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.constructor.js), [`esnext.iterator.drop`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.drop.js), [`esnext.iterator.every`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.every.js), [`esnext.iterator.filter`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.filter.js), [`esnext.iterator.find`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.find.js), [`esnext.iterator.flat-map`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.flat-map.js), [`esnext.iterator.for-each`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.for-each.js), [`esnext.iterator.from`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.from.js), [`esnext.iterator.indexed`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.indexed.js), [`esnext.iterator.map`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.map.js), [`esnext.iterator.reduce`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.reduce.js), [`esnext.iterator.some`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.some.js), [`esnext.iterator.take`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.take.js), [`esnext.iterator.to-array`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.to-array.js) and [`esnext.iterator.to-async`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.to-async.js) -```js -class Iterator { - static from(iterable: Iterable): Iterator; - drop(limit: uint): Iterator; - every(callbackfn: value: any => boolean): boolean; - filter(callbackfn: value: any => boolean): Iterator; - find(callbackfn: value: any => boolean)): any; - flatMap(callbackfn: value => any: Iterable): Iterator; - forEach(callbackfn: value => void): void; - indexed(): Iterator<[index, any]>; - map(callbackfn: value => any): Iterator; - reduce(callbackfn: (memo: any, value: any) => any, initialValue: any): any; - some(callbackfn: value: any => boolean): boolean; - take(limit: uint): Iterator; - toArray(): Array; - toAsync(): AsyncIterator; - @@toStringTag: 'Iterator' -} - -class AsyncIterator { - static from(iterable: Iterable): AsyncIterator; - drop(limit: uint): AsyncIterator; - every(async callbackfn: value: any => boolean): Promise; - filter(async callbackfn: value: any => boolean): AsyncIterator; - find(async callbackfn: value: any => boolean)): Promise; - flatMap(async callbackfn: value => any: Iterable): AsyncIterator; - forEach(async callbackfn: value => void): Promise; - indexed(): AsyncIterator<[index, any]>; - map(async callbackfn: value => any): AsyncIterator; - reduce(async callbackfn: (memo: any, value: any) => any, initialValue: any): Promise; - some(async callbackfn: value: any => boolean): Promise; - take(limit: uint): AsyncIterator; - toArray(): Promise; - @@toStringTag: 'AsyncIterator' -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/iterator-helpers -core-js(-pure)/full/async-iterator -core-js(-pure)/full/async-iterator/drop -core-js(-pure)/full/async-iterator/every -core-js(-pure)/full/async-iterator/filter -core-js(-pure)/full/async-iterator/find -core-js(-pure)/full/async-iterator/flat-map -core-js(-pure)/full/async-iterator/for-each -core-js(-pure)/full/async-iterator/from -core-js(-pure)/full/async-iterator/indexed -core-js(-pure)/full/async-iterator/map -core-js(-pure)/full/async-iterator/reduce -core-js(-pure)/full/async-iterator/some -core-js(-pure)/full/async-iterator/take -core-js(-pure)/full/async-iterator/to-array -core-js(-pure)/full/iterator -core-js(-pure)/full/iterator/drop -core-js(-pure)/full/iterator/every -core-js(-pure)/full/iterator/filter -core-js(-pure)/full/iterator/find -core-js(-pure)/full/iterator/flat-map -core-js(-pure)/full/iterator/for-each -core-js(-pure)/full/iterator/from -core-js(-pure)/full/iterator/indexed -core-js(-pure)/full/iterator/map -core-js(-pure)/full/iterator/reduce -core-js(-pure)/full/iterator/some -core-js(-pure)/full/iterator/take -core-js(-pure)/full/iterator/to-array -core-js(-pure)/full/iterator/to-async -``` -[Examples](https://is.gd/P7YLCq): -```js -[1, 2, 3, 4, 5, 6, 7].values() - .drop(1) - .take(5) - .filter(it => it % 2) - .map(it => it ** 2) - .toArray(); // => [9, 25] - -Iterator.from({ - next: () => ({ done: Math.random() > .9, value: Math.random() * 10 | 0 }) -}).toArray(); // => [7, 6, 3, 0, 2, 8] - -await AsyncIterator.from([1, 2, 3, 4, 5, 6, 7]) - .drop(1) - .take(5) - .filter(it => it % 2) - .map(it => it ** 2) - .toArray(); // => [9, 25] - -await [1, 2, 3].values().toAsync().map(async it => it ** 2).toArray(); // => [1, 4, 9] -``` -###### Caveats:[⬆](#index) -- For preventing prototypes pollution, in the `pure` version, new `%IteratorPrototype%` methods are not added to the real `%IteratorPrototype%`, they available only on wrappers - instead of `[].values().map(fn)` use `Iterator.from([]).map(fn)`. -- Now, we have access to the real `%AsyncIteratorPrototype%` only with usage async generators syntax. So, for compatibility the library with old browsers, we should use `Function` constructor. However, that breaks compatibility with CSP. So, if you wanna use the real `%AsyncIteratorPrototype%`, you should set `USE_FUNCTION_CONSTRUCTOR` option in the `core-js/configurator` to `true`: -```js -const configurator = require('core-js/configurator'); - -configurator({ USE_FUNCTION_CONSTRUCTOR: true }); - -require('core-js/full/async-iterator'); - -(async function * () { /* empty */ })() instanceof AsyncIterator; // => true -``` -##### [New `Set` methods](https://github.com/tc39/proposal-set-methods)[⬆](#index) -Modules [`esnext.set.difference`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.set.difference.js), [`esnext.set.intersection`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.set.intersection.js), [`esnext.set.is-disjoint-from`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.set.is-disjoint-from.js), [`esnext.set.is-subset-of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.set.is-subset-of.js), [`esnext.set.is-superset-of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.set.is-superset-of.js), [`esnext.set.symmetric-difference`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.set.symmetric-difference.js), [`esnext.set.union`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.set.union.js) -```js -class Set { - difference(iterable: Iterable): Set; - intersection(iterable: Iterable): Set; - isDisjointFrom(iterable: Iterable): boolean; - isSubsetOf(iterable: Iterable): boolean; - isSupersetOf(iterable: Iterable): boolean; - symmetricDifference(iterable: Iterable): Set; - union(iterable: Iterable): Set; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/set-methods -core-js(-pure)/full/set/difference -core-js(-pure)/full/set/intersection -core-js(-pure)/full/set/is-disjoint-from -core-js(-pure)/full/set/is-subset-of -core-js(-pure)/full/set/is-superset-of -core-js(-pure)/full/set/symmetric-difference -core-js(-pure)/full/set/union -``` -[*Examples*](https://goo.gl/QMQdaJ): -```js -new Set([1, 2, 3]).union([3, 4, 5]); // => Set {1, 2, 3, 4, 5} -new Set([1, 2, 3]).intersection([3, 4, 5]); // => Set {3} -new Set([1, 2, 3]).difference([3, 4, 5]); // => Set {1, 2} -new Set([1, 2, 3]).symmetricDifference([3, 4, 5]); // => Set {1, 2, 4, 5} - -new Set([1, 2, 3]).isDisjointFrom([4, 5, 6]); // => true -new Set([1, 2, 3]).isSubsetOf([5, 4, 3, 2, 1]); // => true -new Set([5, 4, 3, 2, 1]).isSupersetOf([1, 2, 3]); // => true -``` -##### [`Map.prototype.emplace`](https://github.com/thumbsupep/proposal-upsert)[⬆](#index) -Modules [`esnext.map.emplace`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.map.emplace.js) and [`esnext.weak-map.emplace`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.weak-map.emplace.js) -```js -class Map { - emplace(key: any, { update: (value: any, key: any, handler: object) => updated: any, insert: (key: any, handler: object) => value: any): updated | value; -} - -class WeakMap { - emplace(key: any, { update: (value: any, key: any, handler: object) => updated: any, insert: (key: any, handler: object) => value: any): updated | value; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/map-upsert-stage-2 -core-js(-pure)/full/map/emplace -core-js(-pure)/full/weak-map/emplace -``` -[*Examples*](https://is.gd/ty5I2v): -```js -const map = new Map([['a', 2]]); - -map.emplace('a', { update: it => it ** 2, insert: () => 3}); // => 4 - -map.emplace('b', { update: it => it ** 2, insert: () => 3}); // => 3 - -console.log(map); // => Map { 'a': 4, 'b': 3 } -``` -##### [`Array.fromAsync`](https://github.com/tc39/proposal-array-from-async)[⬆](#index) -Modules [`esnext.array.from-async`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.from-async.js). -```js -class Array { - static fromAsync(asyncItems: AsyncIterable | Iterable | ArrayLike, mapfn?: (value: any, index: number) => any, thisArg?: any): Array; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/array-from-async-stage-2 -core-js(-pure)/full/array/from-async -``` -[*Example*](https://goo.gl/Jt7SsD): -```js -await Array.fromAsync((async function * (){ yield * [1, 2, 3] })(), i => i * i); // => [1, 4, 9] -``` -##### [`Array.isTemplateObject`](https://github.com/tc39/proposal-array-is-template-object)[⬆](#index) -Module [`esnext.array.is-template-object`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.is-template-object.js) -```js -class Array { - static isTemplateObject(value: any): boolean -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/array-is-template-object -core-js(-pure)/full/array/is-template-object -``` -*Example*: -```js -console.log(Array.isTemplateObject((it => it)`qwe${ 123 }asd`)); // => true -``` -##### [`Symbol.{ asyncDispose, dispose }` for `using` statement](https://github.com/tc39/proposal-using-statement)[⬆](#index) -Modules [`esnext.symbol.dispose`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.symbol.dispose.js) and [`esnext.symbol.async-dispose`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.symbol.async-dispose.js). -```js -class Symbol { - static asyncDispose: @@asyncDispose; - static dispose: @@dispose; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/using-statement -core-js(-pure)/full/symbol/async-dispose -core-js(-pure)/full/symbol/dispose -``` -##### [`Symbol.metadataKey` for decorators metadata proposal](https://github.com/tc39/proposal-decorator-metadata)[⬆](#index) -Module [`esnext.symbol.metadata-key`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.symbol.metadata-key.js). -```js -class Symbol { - static metadataKey: @@metadataKey; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/decorator-metadata -core-js(-pure)/full/symbol/metadata-key -``` - -#### Stage 1 proposals[⬆](#index) -[*CommonJS entry points:*](#commonjs-api) -```js -core-js(-pure)/stage/1 -``` -##### [`Observable`](https://github.com/zenparsing/es-observable)[⬆](#index) -Modules [`esnext.observable`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.observable.js) and [`esnext.symbol.observable`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.symbol.observable.js) -```js -class Observable { - constructor(subscriber: Function): Observable; - subscribe(observer: Function | { next?: Function, error?: Function, complete?: Function }): Subscription; - @@observable(): this; - static of(...items: Aray): Observable; - static from(x: Observable | Iterable): Observable; - static readonly attribute @@species: this; -} - -class Symbol { - static observable: @@observable; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/observable -core-js(-pure)/full/observable -core-js(-pure)/full/symbol/observable -``` -[*Examples*](https://goo.gl/1LDywi): -```js -new Observable(observer => { - observer.next('hello'); - observer.next('world'); - observer.complete(); -}).subscribe({ - next(it) { console.log(it); }, - complete() { console.log('!'); } -}); -``` -##### [New collections methods](https://github.com/tc39/proposal-collection-methods)[⬆](#index) -Modules [`esnext.set.add-all`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.set.add-all.js), [`esnext.set.delete-all`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.set.delete-all.js), [`esnext.set.every`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.set.every.js), [`esnext.set.filter`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.set.filter.js), [`esnext.set.find`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.set.find.js), [`esnext.set.join`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.set.join.js), [`esnext.set.map`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.set.map.js), [`esnext.set.reduce`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.set.reduce.js), [`esnext.set.some`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.set.some.js), [`esnext.map.delete-all`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.map.delete-all.js), [`esnext.map.every`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.map.every.js), [`esnext.map.filter`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.map.filter.js), [`esnext.map.find`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.map.find.js), [`esnext.map.find-key`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.map.find-key.js), [`esnext.map.group-by`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.map.group-by.js), [`esnext.map.includes`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.map.includes.js), [`esnext.map.key-by`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.map.key-by.js), [`esnext.map.key-of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.map.key-of.js), [`esnext.map.map-keys`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.map.map-keys.js), [`esnext.map.map-values`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.map.map-values.js), [`esnext.map.merge`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.map.merge.js), [`esnext.map.reduce`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.map.reduce.js), [`esnext.map.some`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.map.some.js), [`esnext.map.update`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.map.update.js), [`esnext.weak-set.add-all`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.weak-set.add-all.js), [`esnext.weak-set.delete-all`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.weak-set.delete-all.js), [`esnext.weak-map.delete-all`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.weak-map.delete-all.js) -##### [`.of` and `.from` methods on collection constructors](https://github.com/tc39/proposal-setmap-offrom)[⬆](#index) -Modules [`esnext.set.of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.set.of.js), [`esnext.set.from`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.set.from.js), [`esnext.map.of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.map.of.js), [`esnext.map.from`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.map.from.js), [`esnext.weak-set.of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.weak-set.of.js), [`esnext.weak-set.from`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.weak-set.from.js), [`esnext.weak-map.of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.weak-map.of.js), [`esnext.weak-map.from`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.weak-map.from.js) -```js -class Set { - static of(...args: Array): Set; - static from(iterable: Iterable, mapFn?: (value: any, index: number) => any, thisArg?: any): Set; - addAll(...args: Array): this; - deleteAll(...args: Array): boolean; - every(callbackfn: (value: any, key: any, target: any) => boolean, thisArg?: any): boolean; - filter(callbackfn: (value: any, key: any, target: any) => boolean, thisArg?: any): Set; - find(callbackfn: (value: any, key: any, target: any) => boolean), thisArg?: any): any; - join(separator: string = ','): string; - map(callbackfn: (value: any, key: any, target: any) => any, thisArg?: any): Set; - reduce(callbackfn: (memo: any, value: any, key: any, target: any) => any, initialValue?: any): any; - some(callbackfn: (value: any, key: any, target: any) => boolean, thisArg?: any): boolean; -} - -class Map { - static groupBy(iterable: Iterable, callbackfn?: (value: any) => any): Map; - static of(...args: Array<[key, value]>): Map; - static from(iterable: Iterable, mapFn?: (value: any, index: number) => [key: any, value: any], thisArg?: any): Map; - static keyBy(iterable: Iterable, callbackfn?: (value: any) => any): Map; - deleteAll(...args: Array): boolean; - every(callbackfn: (value: any, key: any, target: any) => boolean, thisArg?: any): boolean; - filter(callbackfn: (value: any, key: any, target: any) => boolean, thisArg?: any): Map; - find(callbackfn: (value: any, key: any, target: any) => boolean), thisArg?: any): any; - findKey(callbackfn: (value: any, key: any, target: any) => boolean), thisArg?: any): any; - includes(searchElement: any): boolean; - keyOf(searchElement: any): any; - mapKeys(mapFn: (value: any, index: number, target: any) => any, thisArg?: any): Map; - mapValues(mapFn: (value: any, index: number, target: any) => any, thisArg?: any): Map; - merge(...iterables: Array): this; - reduce(callbackfn: (memo: any, value: any, key: any, target: any) => any, initialValue?: any): any; - some(callbackfn: (value: any, key: any, target: any) => boolean, thisArg?: any): boolean; - update(key: any, callbackfn: (value: any, key: any, target: any) => any, thunk?: (key: any, target: any) => any): this; -} - -class WeakSet { - static of(...args: Array): WeakSet; - static from(iterable: Iterable, mapFn?: (value: any, index: number) => Object, thisArg?: any): WeakSet; - addAll(...args: Array): this; - deleteAll(...args: Array): boolean; -} - -class WeakMap { - static of(...args: Array<[key, value]>): WeakMap; - static from(iterable: Iterable, mapFn?: (value: any, index: number) => [key: Object, value: any], thisArg?: any): WeakMap; - deleteAll(...args: Array): boolean; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/collection-methods -core-js/proposals/collection-of-from -core-js(-pure)/full/set/add-all -core-js(-pure)/full/set/delete-all -core-js(-pure)/full/set/every -core-js(-pure)/full/set/filter -core-js(-pure)/full/set/find -core-js(-pure)/full/set/from -core-js(-pure)/full/set/join -core-js(-pure)/full/set/map -core-js(-pure)/full/set/of -core-js(-pure)/full/set/reduce -core-js(-pure)/full/set/some -core-js(-pure)/full/map/delete-all -core-js(-pure)/full/map/every -core-js(-pure)/full/map/filter -core-js(-pure)/full/map/find -core-js(-pure)/full/map/find-key -core-js(-pure)/full/map/from -core-js(-pure)/full/map/group-by -core-js(-pure)/full/map/includes -core-js(-pure)/full/map/key-by -core-js(-pure)/full/map/key-of -core-js(-pure)/full/map/map-keys -core-js(-pure)/full/map/map-values -core-js(-pure)/full/map/merge -core-js(-pure)/full/map/of -core-js(-pure)/full/map/reduce -core-js(-pure)/full/map/some -core-js(-pure)/full/map/update -core-js(-pure)/full/weak-set/add-all -core-js(-pure)/full/weak-set/delete-all -core-js(-pure)/full/weak-set/of -core-js(-pure)/full/weak-set/from -core-js(-pure)/full/weak-map/delete-all -core-js(-pure)/full/weak-map/of -core-js(-pure)/full/weak-map/from -``` -`.of` / `.from` [*examples*](https://goo.gl/mSC7eU): -```js -Set.of(1, 2, 3, 2, 1); // => Set {1, 2, 3} - -Map.from([[1, 2], [3, 4]], ([key, value]) => [key ** 2, value ** 2]); // => Map { 1: 4, 9: 16 } -``` -##### [`compositeKey` and `compositeSymbol`](https://github.com/tc39/proposal-richer-keys/tree/master/compositeKey)[⬆](#index) -Modules [`esnext.composite-key`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.composite-key.js) and [`esnext.composite-symbol`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.composite-symbol.js) -```js -function compositeKey(...args: Array): object; -function compositeSymbol(...args: Array): symbol; -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/keys-composition -core-js(-pure)/full/composite-key -core-js(-pure)/full/composite-symbol -``` -[*Examples*](https://goo.gl/2oPAH7): -```js -// returns a symbol -const symbol = compositeSymbol({}); -console.log(typeof symbol); // => 'symbol' - -// works the same, but returns a plain frozen object without a prototype -const key = compositeKey({}); -console.log(typeof key); // => 'object' -console.log({}.toString.call(key)); // => '[object Object]' -console.log(Object.getPrototypeOf(key)); // => null -console.log(Object.isFrozen(key)); // => true - -const a = ['a']; -const b = ['b']; -const c = ['c']; - -console.log(compositeSymbol(a) === compositeSymbol(a)); // => true -console.log(compositeSymbol(a) !== compositeSymbol(['a'])); // => true -console.log(compositeSymbol(a, 1) === compositeSymbol(a, 1)); // => true -console.log(compositeSymbol(a, b) !== compositeSymbol(b, a)); // => true -console.log(compositeSymbol(a, b, c) === compositeSymbol(a, b, c)); // => true -console.log(compositeSymbol(1, a) === compositeSymbol(1, a)); // => true -console.log(compositeSymbol(1, a, 2, b) === compositeSymbol(1, a, 2, b)); // => true -console.log(compositeSymbol(a, a) === compositeSymbol(a, a)); // => true -``` -##### [Array filtering](https://github.com/tc39/proposal-array-filtering)[⬆](#index) -Modules [`esnext.array.filter-reject`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.filter-reject.js) and [`esnext.typed-array.filter-reject`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.typed-array.filter-reject.js). -```js -class Array { - filterReject(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): Array; -} - -class %TypedArray% { - filterReject(callbackfn: (value: number, index: number, target: %TypedArray%) => boolean, thisArg?: any): %TypedArray%; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js/proposals/array-filtering-stage-1 -core-js(-pure)/full/array(/virtual)/filter-reject -core-js/full/typed-array/filter-reject -``` -[*Examples*](https://is.gd/jJcoWw): -```js -[1, 2, 3, 4, 5].filterReject(it => it % 2); // => [2, 4] -```` -##### [Array deduplication](https://github.com/tc39/proposal-array-unique)[⬆](#index) -Modules [`esnext.array.unique-by`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.unique-by.js) and [`esnext.typed-array.unique-by`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.typed-array.unique-by.js) -```js -class Array { - uniqueBy(resolver?: (item: any) => any): Array; -} - -class %TypedArray% { - uniqueBy(resolver?: (item: any) => any): %TypedArray%;; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js/proposals/array-unique -core-js(-pure)/full/array(/virtual)/unique-by -core-js/full/typed-array/unique-by -``` -[*Examples*](https://is.gd/lilNPu): -```js -[1, 2, 3, 2, 1].uniqueBy(); // [1, 2, 3] - -[ - { id: 1, uid: 10000 }, - { id: 2, uid: 10000 }, - { id: 3, uid: 10001 } -].uniqueBy(it => it.id); // => [{ id: 1, uid: 10000 }, { id: 3, uid: 10001 }] -``` -##### [Getting last item from `Array`](https://github.com/keithamus/proposal-array-last)[⬆](#index) -Modules [`esnext.array.last-item`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.last-item.js) and [`esnext.array.last-index`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.last-index.js) -```js -class Array { - attribute lastItem: any; - readonly attribute lastIndex: uint; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/array-last -core-js/full/array/last-item -core-js/full/array/last-index -``` -[*Examples*](https://goo.gl/2TmcMT): -```js -[1, 2, 3].lastItem; // => 3 -[1, 2, 3].lastIndex; // => 2 - -const array = [1, 2, 3]; -array.lastItem = 4; - -array; // => [1, 2, 4] -``` -##### [`Number.range`](https://github.com/tc39/proposal-Number.range)[⬆](#index) -Module [`esnext.number.range`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.number.range.js) and [`esnext.bigint.range`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.bigint.range.js) -```js -class Number { - range(start: number, end: number, options: { step: number = 1, inclusive: boolean = false } | step: number = 1): RangeIterator; -} - -class BigInt { - range(start: bigint, end: bigint | Infinity | -Infinity, options: { step: bigint = 1n, inclusive: boolean = false } | step: bigint = 1n): RangeIterator; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/number-range -core-js(-pure)/full/bigint/range -core-js(-pure)/full/number/range -``` -[*Example*](https://is.gd/caCKSb): -```js -for (const i of Number.range(1, 10)) { - console.log(i); // => 1, 2, 3, 4, 5, 6, 7, 8, 9 -} - -for (const i of Number.range(1, 10, { step: 3, inclusive: true })) { - console.log(i); // => 1, 4, 7, 10 -} -``` -##### [`Number.fromString`](https://github.com/tc39/proposal-number-fromstring)[⬆](#index) -Module [`esnext.number.from-string`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.number.from-string.js) -```js -class Number { - fromString(string: string, radix: number): number; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/number-from-string -core-js(-pure)/full/number/from-string -``` -##### [`Math` extensions](https://github.com/rwaldron/proposal-math-extensions)[⬆](#index) -Modules [`esnext.math.clamp`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.math.clamp.js), [`esnext.math.deg-per-rad`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.math.deg-per-rad.js), [`esnext.math.degrees`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.math.degrees.js), [`esnext.math.fscale`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.math.fscale.js), [`esnext.math.rad-per-deg`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.math.rad-per-deg.js), [`esnext.math.radians`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.math.radians.js) and [`esnext.math.scale`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.math.scale.js) -```js -namespace Math { - DEG_PER_RAD: number; - RAD_PER_DEG: number; - clamp(x: number, lower: number, upper: number): number; - degrees(radians: number): number; - fscale(x: number, inLow: number, inHigh: number, outLow: number, outHigh: number): number; - radians(degrees: number): number; - scale(x: number, inLow: number, inHigh: number, outLow: number, outHigh: number): number; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/math-extensions -core-js(-pure)/full/math/clamp -core-js(-pure)/full/math/deg-per-rad -core-js(-pure)/full/math/degrees -core-js(-pure)/full/math/fscale -core-js(-pure)/full/math/rad-per-deg -core-js(-pure)/full/math/radians -core-js(-pure)/full/math/scale -``` -##### [`Math.signbit`](https://github.com/tc39/proposal-Math.signbit)[⬆](#index) -Module [`esnext.math.signbit`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.math.signbit.js) -```js -namespace Math { - signbit(x: number): boolean; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/math-signbit -core-js(-pure)/full/math/signbit -``` -[*Examples*](https://goo.gl/rPWbzZ): -```js -Math.signbit(NaN); // => false -Math.signbit(1); // => false -Math.signbit(-1); // => true -Math.signbit(0); // => false -Math.signbit(-0); // => true -``` -##### [`String.cooked`](https://github.com/tc39/proposal-string-cooked)[⬆](#index) -Module [`esnext.string.cooked`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.string.cooked.js) -```js -class String { - static cooked(template: Array, ...substitutions: Array): string; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/string-cooked -core-js(-pure)/full/string/cooked -``` -[*Example*](https://is.gd/7QPnss): -```js -function safePath(strings, ...subs) { - return String.cooked(strings, ...subs.map(sub => encodeURIComponent(sub))); -} - -let id = 'spottie?'; - -safePath`/cats/${ id }`; // => /cats/spottie%3F -``` -##### [`String.prototype.codePoints`](https://github.com/tc39/proposal-string-prototype-codepoints)[⬆](#index) -Module [`esnext.string.code-points`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.string.code-points.js) -```js -class String { - codePoints(): Iterator<{ codePoint, position }>; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/string-code-points -core-js(-pure)/full/string/code-points -``` -[*Example*](https://goo.gl/Jt7SsD): -```js -for (let { codePoint, position } of 'qwe'.codePoints()) { - console.log(codePoint); // => 113, 119, 101 - console.log(position); // => 0, 1, 2 -} -``` -##### [`Symbol.matcher` for pattern matching](https://github.com/tc39/proposal-pattern-matching)[⬆](#index) -Module [`esnext.symbol.matcher`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.symbol.matcher.js). -```js -class Symbol { - static matcher: @@matcher; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/pattern-matching -core-js(-pure)/full/symbol/matcher -``` -##### [Seeded pseudo-random numbers](https://github.com/tc39/proposal-seeded-random)[⬆](#index) -**API of this proposal has been changed. This proposal will be removed from the next major `core-js` version and will be added back after adding and stabilization of the spec text.** - -Module [`esnext.math.seeded-prng`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.math.seeded-prng.js) -```js -class Math { - seededPRNG({ seed: number }): Iterator; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/seeded-random -core-js(-pure)/full/math/seeded-prng -``` -[*Example*](https://goo.gl/oj3WgQ): -```js -for (let x of Math.seededPRNG({ seed: 42 })) { - console.log(x); // => 0.16461519912315087, 0.2203933906000046, 0.8249682894209105 - if (x > .8) break; -} -``` -##### [Object iteration](https://github.com/tc39/proposal-object-iteration)[⬆](#index) -**This proposal has been withdrawn and will be removed from the next major `core-js` version.** - -Modules [`esnext.object.iterate-keys`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.object.iterate-keys.js), [`esnext.object.iterate-values`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.object.iterate-values.js), [`esnext.object.iterate-entries`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.object.iterate-entries.js). -```js -class Object { - iterateKeys(object: any): Iterator; - iterateValues(object: any): Iterator; - iterateEntries(object: any): Iterator<[string, any]>; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/object-iteration -core-js(-pure)/full/object/iterate-keys -core-js(-pure)/full/object/iterate-values -core-js(-pure)/full/object/iterate-entries -``` -[*Example*](https://is.gd/Wnm2tD): -```js -const obj = { foo: 'bar', baz: 'blah' }; - -for (const [key, value] of Object.iterateEntries(obj)) { - console.log(`${key} -> ${value}`); -} - -for (const key of Object.iterateKeys(obj)) { - console.log(key); -} - -for (const value of Object.iterateValues(obj)) { - console.log(value); -} -``` -##### [`Promise.try`](https://github.com/tc39/proposal-promise-try)[⬆](#index) -**This proposal is dead and will be removed from the next major `core-js` version.** - -Module [`esnext.promise.try`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.promise.try.js) -```js -class Promise { - static try(callbackfn: Function): promise; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/promise-try -core-js(-pure)/full/promise/try -``` -[*Examples*](https://goo.gl/k5GGRo): -```js -Promise.try(() => 42).then(it => console.log(`Promise, resolved as ${it}`)); - -Promise.try(() => { throw 42; }).catch(it => console.log(`Promise, rejected as ${it}`)); -``` - -#### Stage 0 proposals[⬆](#index) -[*CommonJS entry points:*](#commonjs-api) -```js -core-js(-pure)/stage/0 -``` -##### [`Function.prototype.unThis`](https://github.com/js-choi/proposal-function-un-this)[⬆](#index) -Module [`esnext.function.un-this`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.function.un-this.js) -```js -class Function { - unThis(): Function; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js/proposals/function-un-this -core-js(-pure)/full/function/un-this -core-js(-pure)/full/function/virtual/un-this -``` -[*Examples*](https://is.gd/t1Bvhn): -```js -const slice = Array.prototype.slice.unThis(); - -slice([1, 2, 3], 1); // => [2, 3] -``` -##### [`Function.{ isCallable, isConstructor }`](https://github.com/caitp/TC39-Proposals/blob/trunk/tc39-reflect-isconstructor-iscallable.md)[⬆](#index) - -Modules [`esnext.function.is-callable`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.function.is-callable.js), [`esnext.function.is-constructor`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.function.is-constructor.js) -```js -class Function { - static isCallable(value: any): boolean; - static isConstructor(value: any): boolean; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/function-is-callable-is-constructor -core-js(-pure)/full/function/is-callable -core-js(-pure)/full/function/is-constructor -``` -[*Examples*](https://is.gd/Kof1he): -```js -Function.isCallable(null); // => false -Function.isCallable({}); // => false -Function.isCallable(function () {}); // => true -Function.isCallable(() => {}); // => true -Function.isCallable(class {}); // => false - -Function.isConstructor(null); // => false -Function.isConstructor({}); // => false -Function.isConstructor(function () {}); // => true -Function.isConstructor(() => {}); // => false -Function.isConstructor(class {}); // => true -``` -##### [`URL`](https://github.com/jasnell/proposal-url)[⬆](#index) -See more info [in web standards namespace](#url-and-urlsearchparams) - -##### [`String#at`](https://github.com/mathiasbynens/String.prototype.at)[⬆](#index) -**This proposal has been withdrawn and will be removed from the next major `core-js` version.** - -Module [`esnext.string.at`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.string.at.js) -```js -class String { - at(index: number): string; -} -``` -[*CommonJS entry points:*](#commonjs-api) -``` -core-js/proposals/string-at -core-js(-pure)/full/string/at -core-js(-pure)/full/string/virtual/at -``` -[*Examples*](https://goo.gl/XluXI8): -```js -'a𠮷b'.at(1); // => '𠮷' -'a𠮷b'.at(1).length; // => 2 -``` -##### [Efficient 64 bit arithmetic](https://gist.github.com/BrendanEich/4294d5c212a6d2254703)[⬆](#index) -**This proposal has been withdrawn and will be removed from the next major `core-js` version.** - -Modules [`esnext.math.iaddh`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.math.iaddh.js), [`esnext.math.isubh`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.math.isubh.js), [`esnext.math.imulh`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.math.imulh.js) and [`esnext.math.umulh`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.math.umulh.js) -```js -namespace Math { - iaddh(lo0: number, hi0: number, lo1: number, hi1: number): number; - isubh(lo0: number, hi0: number, lo1: number, hi1: number): number; - imulh(a: number, b: number): number; - umulh(a: number, b: number): number; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/efficient-64-bit-arithmetic -core-js(-pure)/full/math/iaddh -core-js(-pure)/full/math/isubh -core-js(-pure)/full/math/imulh -core-js(-pure)/full/math/umulh -``` - -#### Pre-stage 0 proposals[⬆](#index) -[*CommonJS entry points:*](#commonjs-api) -```js -core-js(-pure)/stage/pre -``` -##### [`Reflect` metadata](https://github.com/rbuckton/reflect-metadata)[⬆](#index) -Modules [`esnext.reflect.define-metadata`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.reflect.define-metadata.js), [`esnext.reflect.delete-metadata`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.reflect.delete-metadata.js), [`esnext.reflect.get-metadata`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.reflect.get-metadata.js), [`esnext.reflect.get-metadata-keys`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.reflect.get-metadata-keys.js), [`esnext.reflect.get-own-metadata`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.reflect.get-own-metadata.js), [`esnext.reflect.get-own-metadata-keys`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.reflect.get-own-metadata-keys.js), [`esnext.reflect.has-metadata`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.reflect.has-metadata.js), [`esnext.reflect.has-own-metadata`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.reflect.has-own-metadata.js) and [`esnext.reflect.metadata`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.reflect.metadata.js). -```js -namespace Reflect { - defineMetadata(metadataKey: any, metadataValue: any, target: Object, propertyKey?: PropertyKey): void; - getMetadata(metadataKey: any, target: Object, propertyKey?: PropertyKey): any; - getOwnMetadata(metadataKey: any, target: Object, propertyKey?: PropertyKey): any; - hasMetadata(metadataKey: any, target: Object, propertyKey?: PropertyKey): boolean; - hasOwnMetadata(metadataKey: any, target: Object, propertyKey?: PropertyKey): boolean; - deleteMetadata(metadataKey: any, target: Object, propertyKey?: PropertyKey): boolean; - getMetadataKeys(target: Object, propertyKey?: PropertyKey): Array; - getOwnMetadataKeys(target: Object, propertyKey?: PropertyKey): Array; - metadata(metadataKey: any, metadataValue: any): decorator(target: Object, targetKey?: PropertyKey) => void; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/reflect-metadata -core-js(-pure)/full/reflect/define-metadata -core-js(-pure)/full/reflect/delete-metadata -core-js(-pure)/full/reflect/get-metadata -core-js(-pure)/full/reflect/get-metadata-keys -core-js(-pure)/full/reflect/get-own-metadata -core-js(-pure)/full/reflect/get-own-metadata-keys -core-js(-pure)/full/reflect/has-metadata -core-js(-pure)/full/reflect/has-own-metadata -core-js(-pure)/full/reflect/metadata -``` -[*Examples*](https://goo.gl/KCo3PS): -```js -let object = {}; -Reflect.defineMetadata('foo', 'bar', object); -Reflect.ownKeys(object); // => [] -Reflect.getOwnMetadataKeys(object); // => ['foo'] -Reflect.getOwnMetadata('foo', object); // => 'bar' -``` - -### Web standards[⬆](#index) -#### `structuredClone`[⬆](#index) -[Spec](https://html.spec.whatwg.org/multipage/structured-data.html#dom-structuredclone), module [`web.structured-clone`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/web.structured-clone.js) -```js -function structuredClone(value: Serializable, { transfer?: Sequence }): any; -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js(-pure)/stable|actual|full/structured-clone -``` -[*Examples*](https://is.gd/RhK7TW): -```js -const structured = [{ a: 42 }]; -const sclone = structuredClone(structured); -console.log(sclone); // => [{ a: 42 }] -console.log(structured !== sclone); // => true -console.log(structured[0] !== sclone[0]); // => true - -const circular = {}; -circular.circular = circular; -const cclone = structuredClone(circular); -console.log(cclone.circular === cclone); // => true - -structuredClone(42); // => 42 -structuredClone({ x: 42 }); // => { x: 42 } -structuredClone([1, 2, 3]); // => [1, 2, 3] -structuredClone(new Set([1, 2, 3])); // => Set{ 1, 2, 3 } -structuredClone(new Map([['a', 1], ['b', 2]])); // => Map{ a: 1, b: 2 } -structuredClone(new Int8Array([1, 2, 3])); // => new Int8Array([1, 2, 3]) -structuredClone(new AggregateError([1, 2, 3], 'message')); // => new AggregateError([1, 2, 3], 'message')) -structuredClone(new TypeError('message', { cause: 42 })); // => new TypeError('message', { cause: 42 }) -structuredClone(new DOMException('message', 'DataCloneError')); // => new DOMException('message', 'DataCloneError') -structuredClone(document.getElementById('myfileinput')); // => new FileList -structuredClone(new DOMPoint(1, 2, 3, 4)); // => new DOMPoint(1, 2, 3, 4) -structuredClone(new Blob(['test'])); // => new Blob(['test']) -structuredClone(new ImageData(8, 8)); // => new ImageData(8, 8) -// etc. - -structuredClone(new WeakMap()); // => DataCloneError on non-serializable types -``` -##### Caveats when using `structuredClone` polyfill:[⬆](#index) - -* `ArrayBuffer` instances and many platform types cannot be transferred in most engines since we have no way to polyfill this behavior, however `.transfer` option works for some platform types. I recommend avoiding this option. -* Some specific platform types can't be cloned in old engines. Mainly it's very specific types or very old engines, but here are some exceptions. For example, we have no sync way to clone `ImageBitmap` in Safari 14.0- or Firefox 83-, so it's recommended to look to the [polyfill source](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/web.structured-clone.js) if you wanna clone something specific. - -#### Base64 utility methods[⬆](#index) -[Specification](https://html.spec.whatwg.org/multipage/webappapis.html#atob), [MDN](https://developer.mozilla.org/en-US/docs/Glossary/Base64). Modules [`web.atob`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/web.atob.js), [`web.btoa`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/web.btoa.js). -```js -function atob(data: string): string; -function btoa(data: string): string; -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js(-pure)/stable|actual|full/atob -core-js(-pure)/stable|actual|full/btoa -``` -[*Examples*](https://is.gd/4Nxmzn): -```js -btoa('hi, core-js'); // => 'aGksIGNvcmUtanM=' -atob('aGksIGNvcmUtanM='); // => 'hi, core-js' -``` - -#### `setTimeout` and `setInterval`[⬆](#index) -Module [`web.timers`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/web.timers.js). Additional arguments fix for IE9-. -```js -function setTimeout(callback: any, time: any, ...args: Array): number; -function setInterval(callback: any, time: any, ...args: Array): number; -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js(-pure)/stable|actual|full/set-timeout -core-js(-pure)/stable|actual|full/set-interval -``` -```js -// Before: -setTimeout(log.bind(null, 42), 1000); -// After: -setTimeout(log, 1000, 42); -``` -#### `setImmediate`[⬆](#index) -Module [`web.immediate`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/web.immediate.js). [`setImmediate`](https://w3c.github.io/setImmediate/) polyfill. -```js -function setImmediate(callback: any, ...args: Array): number; -function clearImmediate(id: number): void; -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js(-pure)/stable|actual|full/set-immediate -core-js(-pure)/stable|actual|full/clear-immediate -``` -[*Examples*](https://goo.gl/6nXGrx): -```js -setImmediate((arg1, arg2) => { - console.log(arg1, arg2); // => Message will be displayed with minimum delay -}, 'Message will be displayed', 'with minimum delay'); - -clearImmediate(setImmediate(() => { - console.log('Message will not be displayed'); -})); -``` - -#### `queueMicrotask`[⬆](#index) -[Spec](https://html.spec.whatwg.org/multipage/timers-and-user-prompts.html#dom-queuemicrotask), module [`web.queue-microtask`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/web.queue-microtask.js) -```js -function queueMicrotask(fn: Function): void; -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js(-pure)/stable|actual|full/queue-microtask -``` -[*Examples*](https://goo.gl/nsW8P9): -```js -queueMicrotask(() => console.log('called as microtask')); -``` - -#### `URL` and `URLSearchParams`[⬆](#index) -[`URL` standard](https://url.spec.whatwg.org/) implementation. Modules [`web.url`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/web.url.js), [`web.url.to-json`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/web.url.to-json.js), [`web.url-search-params`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/web.url-search-params.js). -```js -class URL { - constructor(url: string, base?: string); - attribute href: string; - readonly attribute origin: string; - attribute protocol: string; - attribute username: string; - attribute password: string; - attribute host: string; - attribute hostname: string; - attribute port: string; - attribute pathname: string; - attribute search: string; - readonly attribute searchParams: URLSearchParams; - attribute hash: string; - toJSON(): string; - toString(): string; -} - -class URLSearchParams { - constructor(params?: string | Iterable<[key, value]> | Object); - append(name: string, value: string): void; - delete(name: string): void; - get(name: string): string | void; - getAll(name: string): Array; - has(name: string): boolean; - set(name: string, value: string): void; - sort(): void; - toString(): string; - forEach(callbackfn: (value: any, index: number, target: any) => void, thisArg: any): void; - entries(): Iterator<[key, value]>; - keys(): Iterator; - values(): Iterator; - @@iterator(): Iterator<[key, value]>; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js/proposals/url -core-js(-pure)/stable|actual|full/url -core-js/stable|actual|full/url/to-json -core-js(-pure)/stable|actual|full/url-search-params -``` -[*Examples*](https://is.gd/AfIwve): -```js -const url = new URL('https://login:password@example.com:8080/foo/bar?a=1&b=2&a=3#fragment'); - -console.log(url.href); // => 'https://login:password@example.com:8080/foo/bar?a=1&b=2&a=3#fragment' -console.log(url.origin); // => 'https://example.com:8080' -console.log(url.protocol); // => 'https:' -console.log(url.username); // => 'login' -console.log(url.password); // => 'password' -console.log(url.host); // => 'example.com:8080' -console.log(url.hostname); // => 'example.com' -console.log(url.port); // => '8080' -console.log(url.pathname); // => '/foo/bar' -console.log(url.search); // => '?a=1&b=2&a=3' -console.log(url.hash); // => '#fragment' -console.log(url.toJSON()); // => 'https://login:password@example.com:8080/foo/bar?a=1&b=2&a=3#fragment' -console.log(url.toString()); // => 'https://login:password@example.com:8080/foo/bar?a=1&b=2&a=3#fragment' - -for (let [key, value] of url.searchParams) { - console.log(key); // => 'a', 'b', 'a' - console.log(value); // => '1', '2', '3' -} - -url.pathname = ''; -url.searchParams.append('c', 4); - -console.log(url.search); // => '?a=1&b=2&a=3&c=4' -console.log(url.href); // => 'https://login:password@example.com:8080/?a=1&b=2&a=3&c=4#fragment' - -const params = new URLSearchParams('?a=1&b=2&a=3'); - -params.append('c', 4); -params.append('a', 2); -params.sort(); - -for (let [key, value] of params) { - console.log(key); // => 'a', 'a', 'a', 'b', 'c' - console.log(value); // => '1', '3', '2', '2', '4' -} - -console.log(params.toString()); // => 'a=1&a=3&a=2&b=2&c=4' -``` - -##### Caveats when using `URL` and `URLSearchParams`:[⬆](#index) -- IE8 does not support setters, so they do not work on `URL` instances. However, `URL` constructor can be used for basic `URL` parsing. -- Legacy encodings in a search query are not supported. Also, `core-js` implementation has some other encoding-related issues. -- `URL` implementations from all of the popular browsers have much more problems than `core-js`, however, replacing all of them does not looks like a good idea. You can customize the aggressiveness of polyfill [by your requirements](#configurable-level-of-aggressiveness). - -##### `DOMException`:[⬆](#index) -[The specification.](https://webidl.spec.whatwg.org/#idl-DOMException) Modules [`web.dom-exception.constructor`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/web.dom-exception.constructor.js), [`web.dom-exception.stack`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/web.dom-exception.stack.js), [`web.dom-exception.to-string-tag`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/web.dom-exception.to-string-tag.js). -```js -class DOMException { - constructor(message: string, name?: string); - readonly attribute name: string; - readonly attribute message: string; - readonly attribute code: string; - attribute stack: string; // in engines that should have it - @@toStringTag: 'DOMException'; -} -```` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js(-pure)/stable|actual|full/dom-exception -core-js(-pure)/stable|actual|full/dom-exception/constructor -core-js/stable|actual|full/dom-exception/to-string-tag -``` -[*Examples*](https://is.gd/pI6oTN): -```js -const exception = new DOMException('error', 'DataCloneError'); -console.log(exception.name); // => 'DataCloneError' -console.log(exception.message); // => 'error' -console.log(exception.code); // => 25 -console.log(typeof exception.stack); // => 'string' -console.log(exception instanceof DOMException); // => true -console.log(exception instanceof Error); // => true -console.log(exception.toString()); // => 'DataCloneError: error' -console.log(Object.prototype.toString.call(exception)); // => '[object DOMException]' -``` - -#### Iterable DOM collections[⬆](#index) -Some DOM collections should have [iterable interface](https://heycam.github.io/webidl/#idl-iterable) or should be [inherited from `Array`](https://heycam.github.io/webidl/#LegacyArrayClass). That means they should have `forEach`, `keys`, `values`, `entries` and `@@iterator` methods for iteration. So add them. Modules [`web.dom-collections.iterator`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/web.dom-collections.iterator.js) and [`web.dom-collections.for-each`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/web.dom-collections.for-each.js). -```js -class [ - CSSRuleList, - CSSStyleDeclaration, - CSSValueList, - ClientRectList, - DOMRectList, - DOMStringList, - DataTransferItemList, - FileList, - HTMLAllCollection, - HTMLCollection, - HTMLFormElement, - HTMLSelectElement, - MediaList, - MimeTypeArray, - NamedNodeMap, - PaintRequestList, - Plugin, - PluginArray, - SVGLengthList, - SVGNumberList, - SVGPathSegList, - SVGPointList, - SVGStringList, - SVGTransformList, - SourceBufferList, - StyleSheetList, - TextTrackCueList, - TextTrackList, - TouchList, -] { - @@iterator(): Iterator; -} - -class [DOMTokenList, NodeList] { - forEach(callbackfn: (value: any, index: number, target: any) => void, thisArg: any): void; - entries(): Iterator<[key, value]>; - keys(): Iterator; - values(): Iterator; - @@iterator(): Iterator; -} -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js(-pure)/stable|actual|full/dom-collections/iterator -core-js/stable|actual|full/dom-collections/for-each -``` -[*Examples*](https://goo.gl/lfXVFl): -```js -for (let { id } of document.querySelectorAll('*')) { - if (id) console.log(id); -} - -for (let [index, { id }] of document.querySelectorAll('*').entries()) { - if (id) console.log(index, id); -} - -document.querySelectorAll('*').forEach(it => console.log(it.id)); -``` -### Iteration helpers[⬆](#index) -Helpers for check iterability / get iterator in the `pure` version or, for example, for `arguments` object: -```js -function isIterable(value: any): boolean; -function getIterator(value: any): Object; -function getIteratorMethod(value: any): Function | void; -``` -[*CommonJS entry points:*](#commonjs-api) -```js -core-js-pure/es|stable|actual|full/is-iterable -core-js-pure/es|stable|actual|full/get-iterator -core-js-pure/es|stable|actual|full/get-iterator-method -``` -[*Examples*](https://goo.gl/SXsM6D): -```js -import isIterable from 'core-js-pure/actual/is-iterable'; -import getIterator from 'core-js-pure/actual/get-iterator'; -import getIteratorMethod from 'core-js-pure/actual/get-iterator-method'; - -let list = (function () { - return arguments; -})(1, 2, 3); - -console.log(isIterable(list)); // true; - -let iterator = getIterator(list); -console.log(iterator.next().value); // 1 -console.log(iterator.next().value); // 2 -console.log(iterator.next().value); // 3 -console.log(iterator.next().value); // undefined - -getIterator({}); // TypeError: [object Object] is not iterable! - -let method = getIteratorMethod(list); -console.log(typeof method); // 'function' -let iterator = method.call(list); -console.log(iterator.next().value); // 1 -console.log(iterator.next().value); // 2 -console.log(iterator.next().value); // 3 -console.log(iterator.next().value); // undefined - -console.log(getIteratorMethod({})); // undefined -``` - -## Missing polyfills[⬆](#index) -- ES `BigInt` can't be polyfilled since it requires changes in the behavior of operators, you could find more info [here](https://github.com/zloirock/core-js/issues/381). You could try to use [`JSBI`](https://github.com/GoogleChromeLabs/jsbi). -- ES `Proxy` can't be polyfilled, you can try to use [`proxy-polyfill`](https://github.com/GoogleChrome/proxy-polyfill) which provides a very little subset of features. -- ES `String#normalize` is not a very useful feature, but this polyfill will be very large. If you need it, you can use [unorm](https://github.com/walling/unorm/). -- ECMA-402 `Intl` is missed because of the size. You can use [those polyfills](https://formatjs.io/docs/polyfills). -- `window.fetch` is not a cross-platform feature, in some environments, it makes no sense. For this reason, I don't think it should be in `core-js`. Looking at a large number of requests it *might be* added in the future. Now you can use, for example, [this polyfill](https://github.com/github/fetch). +## [Index](docs) +- [Usage](docs/usage.md) + - [Installation](docs/usage.md#installation) + - [`postinstall` message](docs/usage.md#postinstall-message) + - [CommonJS API](/docs/usage.md#commonjs-api) + - [Babel](docs/usage.md#babel) + - [`@babel/polyfill`](docs/usage.md#babelpolyfill) + - [`@babel/preset-env`](docs/usage.md#babelpreset-env) + - [`@babel/runtime`](docs/usage.md#babelruntime) + - [swc](docs/usage.md#swc) + - [Configurable level of aggressiveness](docs/usage.md#configurable-level-of-aggressiveness) + - [Custom build](docs/usage.md#custom-build) +- [Compatibility data](docs/compatibility-data.md) +- [Supported engines](docs/compatibility-data.md#supported-engines) +- [Features](docs/features/README.md) + - [ECMAScript](docs/features/ecmascript/README.md) + - [ECMAScript: Object](docs/features/ecmascript/object.md) + - [ECMAScript: Function](docs/features/ecmascript/function.md) + - [ECMAScript: Error](docs/features/ecmascript/error.md) + - [ECMAScript: Array](docs/features/ecmascript/array.md) + - [ECMAScript: String and RegExp](docs/features/ecmascript/string%20and%20regexp.md) + - [ECMAScript: Number](docs/features/ecmascript/number.md) + - [ECMAScript: Math](docs/features/ecmascript/math.md) + - [ECMAScript: Date](docs/features/ecmascript/date.md) + - [ECMAScript: Promise](docs/features/ecmascript/promise.md) + - [ECMAScript: Symbol](docs/features/ecmascript/symbol.md) + - [ECMAScript: Collections](docs/features/ecmascript/collections.md) + - [ECMAScript: Typed Arrays](docs/features/ecmascript/typed-array.md) + - [ECMAScript: Reflect](docs/features/ecmascript/reflect.md) + - [ECMAScript: JSON](docs/features/ecmascript/json.md) + - [ECMAScript: globalThis](docs/features/ecmascript/global-this.md) + - [ECMAScript proposals](docs/features/proposals/README.md) + - [Finished proposals](docs/features/proposals#finished) + - [`globalThis`](docs/features/proposals/global-this.md) + - [Relative indexing method](docs/features/proposals/relative-indexing-method.md) + - [`Array.prototype.includes`](docs/features/proposals/array-includes.md) + - [`Array.prototype.flat` / `Array.prototype.flatMap`](docs/features/proposals/array-flat-map.md) + - [`Array` find from last](docs/features/proposals/array-find-from-last.md) + - [`Object.values` / `Object.entries`](docs/features/proposals/object-values-entries.md) + - [`Object.fromEntries`](docs/features/proposals/object-from-entries.md) + - [`Object.getOwnPropertyDescriptors`](docs/features/proposals/object-getownpropertydescriptors.md) + - [Accessible `Object.prototype.hasOwnProperty`](docs/features/proposals/accessible-object-hasownproperty.md) + - [`String` padding](docs/features/proposals/string-padding.md) + - [`String.prototype.matchAll`](docs/features/proposals/string-match-all.md) + - [`String.prototype.replaceAll`](docs/features/proposals/string-replace-all.md) + - [`String.prototype.trimStart` / `String.prototype.trimEnd`](docs/features/proposals/string-left-right-trim.md) + - [`RegExp` `s` (`dotAll`) flag](docs/features/proposals/regexp-dotall-flag.md) + - [`RegExp` named capture groups](docs/features/proposals/regexp-named-groups.md) + - [`Promise.allSettled`](docs/features/proposals/promise-all-settled.md) + - [`Promise.any`](docs/features/proposals/promise-any.md) + - [`Promise.prototype.finally`](docs/features/proposals/promise-finally.md) + - [`Symbol.asyncIterator` for asynchronous iteration](docs/features/proposals/async-iteration.md) + - [`Symbol.prototype.description`](docs/features/proposals/symbol-description.md) + - [Well-formed `JSON.stringify`](docs/features/proposals/well-formed-stringify.md) + - [Stage 3 proposals](docs/features/proposals#stage-3) + - [`Array` grouping](docs/features/proposals/array-grouping.md) + - [Change `Array` by copy](docs/features/proposals/change-array-by-copy.md) + - [Stage 2 proposals](docs/features/proposals#stage-2) + - [`Iterator` helpers](docs/features/proposals/iterator-helpers.md) + - [New `Set` methods](docs/features/proposals/set-methods.md) + - [`Map.prototype.emplace`](docs/features/proposals/map-upsert.md) + - [`Array.fromAsync`](docs/features/proposals/array-from-async.md) + - [`Array.isTemplateObject`](docs/features/proposals/array-is-template-object.md) + - [`Symbol.{ asyncDispose, dispose }` for `using` statement](docs/features/proposals/using-statement.md) + - [`Symbol.metadataKey` for decorators metadata proposal](docs/features/proposals/decorator-metadata.md) + - [Stage 1 proposals](docs/features/proposals#stage-1) + - [`Observable`](docs/features/proposals/observable.md) + - [New collections methods](docs/features/proposals/collection-methods.md) + - [`.of` and `.from` methods on collection constructors](docs/features/proposals/collection-of-from.md) + - [`compositeKey` and `compositeSymbol`](docs/features/proposals/keys-composition.md) + - [`Array` filtering](docs/features/proposals/array-filtering.md) + - [`Array` deduplication](docs/features/proposals/array-unique.md) + - [Getting last item from `Array`](docs/features/proposals/array-find-from-last.md) + - [`Number.range`](docs/features/proposals/number-range.md) + - [`Number.fromString`](docs/features/proposals/number-from-string.md) + - [`Math` extensions](docs/features/proposals/math-extensions.md) + - [`Math.signbit`](docs/features/proposals/math-signbit.md) + - [`String.cooked`](docs/features/proposals/string-cooked.md) + - [`String.prototype.codePoints`](docs/features/proposals/string-code-points.md) + - [`Symbol.matcher` for pattern matching](docs/features/proposals/pattern-matching.md) + - [Stage 0 proposals](docs/features/proposals#stage-0) + - [`Function.prototype.unThis`](docs/features/proposals/function-un-this.md) + - [`Function.{ isCallable, isConstructor }`](docs/features/proposals/function-is-callable-is-constructor.md) + - [`URL`](docs/features/proposals/url.md) + - [Pre-stage 0 proposals](docs/features/proposals#pre-stage-0) + - [`Reflect` metadata](docs/features/proposals/reflect-metadata.md) + - [Web standards](docs/features/web-standards/README.md) + - [`structuredClone`](docs/features/web-standards/structured-clone.md) + - [Base64 utility methods](docs/features/web-standards/base64-utility-methods.md) + - [`setTimeout` and `setInterval`](docs/features/web-standards/set-timeout%20and%20set-interval.md) + - [`setImmediate`](docs/features/web-standards/set-immediate.md) + - [`queueMicrotask`](docs/features/web-standards/queue-microtask.md) + - [`URL` and `URLSearchParams`](docs/features/web-standards/url.md) + - [`DOMException`](docs/features/web-standards/dom-exception.md) + - [Iterable DOM collections](docs/features/web-standards/dom-collections.md) + - [Iteration helpers](docs/features/iteration-helpers.md) +- [Missing polyfills](docs/missing-polyfills.md) +- [Contributing](CONTRIBUTING.md) +- [Security policy](SECURITY.md) +- [Changelog](CHANGELOG.md) + +### [Usage](docs/usage.md) +#### [Installation:](docs/usage.md#installation) +#### [`postinstall` message](docs/usage.md#postinstall-message) +#### [CommonJS API](docs/usage.md#commonjs-api) +##### [Caveats when using CommonJS API](docs/usage.md#caveats-when-using-commonjs-api) +##### [CommonJS and prototype methods without global namespace pollution](docs/usage.md#commonjs-and-prototype-methods-without-global-namespace-pollution) +#### [Babel](docs/usage.md#babel) +##### [`@babel/polyfill`](docs/usage.md#babelpolyfill) +##### [`@babel/preset-env`](docs/usage.md#babelpreset-env) +##### [`@babel/runtime`](docs/usage.md#babelruntime) +#### [swc](docs/usage.md#swc) +#### [Configurable level of aggressiveness](docs/usage.md#configurable-level-of-aggressiveness) +#### [Custom build](docs/usage.md#custom-build) + +### [Compatibility data](docs/compatibility-data.md) + +### [Supported engines](docs/compatibility-data.md#supported-engines) + +### [Features:](docs/features/README.md) + +#### [ECMAScript](docs/features/ecmascript/README.md) +##### [ECMAScript: Object](docs/features/ecmascript/object.md) +##### [ECMAScript: Function](docs/features/ecmascript/function.md) +##### [ECMAScript: Error](docs/features/ecmascript/error.md) +##### [ECMAScript: Array](docs/features/ecmascript/array.md) +##### [ECMAScript: String and RegExp](docs/features/ecmascript/string%20and%20regexp.md) +##### [ECMAScript: Number](docs/features/ecmascript/number.md) +##### [ECMAScript: Math](docs/features/ecmascript/math.md) +##### [ECMAScript: Date](docs/features/ecmascript/date.md) +##### [ECMAScript: Promise](docs/features/ecmascript/promise.md) +###### [Unhandled rejection tracking](docs/features/ecmascript/promise.md#unhandled-rejection-tracking) +##### [ECMAScript: Symbol](docs/features/ecmascript/symbol.md) +###### [Caveats when using `Symbol` polyfill](docs/features/ecmascript/symbol.md#caveats-when-using-symbol-polyfill) +##### [ECMAScript: Collections](docs/features/ecmascript/collections.md) +###### [Map](docs/features/ecmascript/collections.mp#map) +###### [Set](docs/features/ecmascript/collections.md#set) +###### [WeakMap](docs/features/ecmascript/collections#weakmap) +###### [WeakSet](docs/features/ecmascript/collections#weakset) +###### [Caveats when using collections polyfill](docs/features/ecmascript/collections.md#caveats-when-using-collections-polyfill) + +##### [ECMAScript: Typed Arrays](docs/features/ecmascript/typed-array.md) +###### [Caveats when using typed arrays polyfills](docs/features/ecmascript/typed-array.md#caveats-when-using-typed-arrays-polyfills) +##### [ECMAScript: Reflect](docs/features/ecmascript/reflect.md) +##### [ECMAScript: JSON](docs/features/ecmascript/json.md) +##### [ECMAScript: globalThis](docs/features/ecmascript/global-this.md) + +#### [ECMAScript proposals](docs/features/proposals/README.md) +##### [Finished proposals](docs/features/proposals/README.md#finished) +###### [`globalThis`](docs/features/proposals/global-this.md) +###### [Relative indexing method](docs/features/proposals/relative-indexing-method.md) +###### [`Array.prototype.includes`](docs/features/proposals/array-includes.md) +###### [`Array.prototype.flat` / `Array.prototype.flatMap`](docs/features/proposals/array-flat-map.md) +###### [Array find from last](docs/features/proposals/array-find-from-last.md) +###### [`Object.values` / `Object.entries`](docs/features/proposals/object-values-entries.md) +###### [`Object.fromEntries`](docs/features/proposals/object-from-entries.md) +###### [`Object.getOwnPropertyDescriptors`](docs/features/proposals/object-getownpropertydescriptors.md) +###### [Accessible `Object.prototype.hasOwnProperty`](docs/features/proposals/accessible-object-hasownproperty.md) +###### [`String` padding](docs/features/proposals/string-padding.md) +###### [`String#matchAll`](docs/features/proposals/string-match-all.md) +###### [`String#replaceAll`](docs/features/proposals/string-replace-all.md) +###### [`String.prototype.trimStart` / `String.prototype.trimEnd`](docs/features/proposals/string-left-right-trim.md) +###### [`RegExp` `s` (`dotAll`) flag](docs/features/proposals/regexp-dotall-flag.md) +###### [`RegExp` named capture groups](docs/features/proposals/regexp-named-groups.md) +###### [`Promise.allSettled`](docs/features/proposals/promise-all-settled.md) +###### [`Promise.any`](docs/features/proposals/promise-any.md) +###### [`Promise.prototype.finally`](docs/features/proposals/promise-finally.md) +###### [`Symbol.asyncIterator` for asynchronous iteration](docs/features/proposals/async-iteration.md) +###### [`Symbol.prototype.description`](docs/features/proposals/symbol-description.md) +###### [Well-formed `JSON.stringify`](docs/features/proposals/well-formed-stringify.md) + +##### [Stage 3 proposals](docs/features/proposals/README.md#stage-3) +###### [`Array` grouping](docs/features/proposals/array-grouping.md) +###### [Change `Array` by copy](docs/features/proposals/change-array-by-copy.md) + +##### [Stage 2 proposals](docs/features/proposals/README.md#stage-2) +###### [Iterator helpers](docs/features/proposals/iterator-helpers.md) +- [Caveats](docs/features/proposals/iterator-helpers.md#caveats) +###### [New `Set` methods](docs/features/proposals/set-methods.md) +###### [`Map.prototype.emplace`](docs/features/proposals/map-upsert.md) +###### [`Array.fromAsync`](docs/features/proposals/array-from-async.md) +###### [`Array.isTemplateObject`](docs/features/proposals/array-is-template-object.md) +###### [`Symbol.{ asyncDispose, dispose }` for `using` statement](docs/features/proposals/using-statement.md) +###### [`Symbol.metadataKey` for decorators metadata proposal](docs/features/proposals/decorator-metadata.md) + +##### [Stage 1 proposals](docs/features/proposals/README.md#stage-1) +###### [`Observable`](docs/features/proposals/observable.md) +###### [New collections methods](docs/features/proposals/collection-methods.md) +###### [`.of` and `.from` methods on collection constructors](docs/features/proposals/collection-of-from.md) +###### [`compositeKey` and `compositeSymbol`](docs/features/proposals/keys-composition.md) +###### [Array filtering](docs/features/proposals/array-filtering.md) +###### [Array deduplication](docs/features/proposals/array-unique.md) +###### [Getting last item from `Array`](docs/features/proposals/array-find-from-last.md) +###### [`Number.range`](docs/features/proposals/number-range.md) +###### [`Number.fromString`](docs/features/proposals/number-from-string.md) +###### [`Math` extensions](docs/features/proposals/math-extensions.md) +###### [`Math.signbit`](docs/features/proposals/math-signbit.md) +###### [`String.cooked`](docs/features/proposals/string-cooked.md) +###### [`String.prototype.codePoints`](docs/features/proposals/string-code-points.md) +###### [`Symbol.matcher` for pattern matching](docs/features/proposals/pattern-matching.md) +###### [Seeded pseudo-random numbers](docs/features/proposals/seeded-random.md) +###### [Object iteration](docs/features/proposals/object-iteration.md) +###### [`Promise.try`](docs/features/proposals/promise-try.md) + +##### [Stage 0 proposals](docs/features/proposals/README.md#stage-0) +###### [`Function.prototype.unThis`](docs/features/proposals/function-un-this.md) +###### [`Function.{ isCallable, isConstructor }`](docs/features/proposals/function-is-callable-is-constructor.md) +###### [`URL`](docs/features/proposals/url.md) +###### [`String#at`](docs/features/proposals/string-at.md) +###### [Efficient 64 bit arithmetic](docs/features/proposals/efficient-64-bit-arithmetic.md) + +##### [Pre-stage 0 proposals](docs/features/proposals/README.md#pre-stage-0) +###### [`Reflect` metadata](docs/features/proposals/reflect-metadata.md) + + +#### [Web standards](docs/features/web-standards/README.md) +##### [`structuredClone`](docs/features/web-standards/structuredclone) +###### [Caveats when using `structuredClone` polyfill](docs/features/web-standards/structured-clone.md#caveats-when-using-structuredclone-polyfill) +##### [Base64 utility methods](docs/features/web-standards/base64-utility-methods.md) +##### [`setTimeout` and `setInterval`](docs/features/web-standards/set-timeout%20and%20set-interval.md) +##### [`setImmediate`](docs/features/web-standards/set-immediate.md) +##### [`QueueMicrotask`](docs/features/web-standards/queue-microtask.md) +##### [`URL` and `URLSearchParams`](docs/features/web-standards/url.md) +###### [Caveats when using `URL` and `URLSearchParams`](docs/features/web-standards/url.md#caveats-when-using-url-and-urlsearchparams) +##### [`DOMException`](docs/features/web-standards/dom-exception.md) +##### [Iterable DOM collections](docs/features/web-standards/dom-collections.md) + +#### [Iteration helpers](docs/features/iteration-helpers.md) + +### [Missing polyfills](docs/missing-polyfills.md) diff --git a/deno/corejs/README.md b/deno/corejs/README.md index cf9a6ee5ef94..d23c4d148295 100644 --- a/deno/corejs/README.md +++ b/deno/corejs/README.md @@ -2,11 +2,11 @@ [![Open Collective](https://opencollective.com/core-js/all/badge.svg?label=open%20collective)](https://opencollective.com/core-js) [![version](https://img.shields.io/npm/v/core-js.svg)](https://www.npmjs.com/package/core-js) [![core-js downloads](https://img.shields.io/npm/dm/core-js.svg?label=npm%20i%20core-js)](https://npm-stat.com/charts.html?package=core-js&package=core-js-pure&package=core-js-compat&from=2014-11-18) [![core-js-pure downloads](https://img.shields.io/npm/dm/core-js-pure.svg?label=npm%20i%20core-js-pure)](https://npm-stat.com/charts.html?package=core-js&package=core-js-pure&package=core-js-compat&from=2014-11-18) [![tests](https://github.com/zloirock/core-js/workflows/tests/badge.svg)](https://github.com/zloirock/core-js/actions) [![eslint](https://github.com/zloirock/core-js/workflows/eslint/badge.svg)](https://github.com/zloirock/core-js/actions) -> Modular standard library for JavaScript. Includes polyfills for [ECMAScript up to 2021](https://github.com/zloirock/core-js#ecmascript): [promises](https://github.com/zloirock/core-js#ecmascript-promise), [symbols](https://github.com/zloirock/core-js#ecmascript-symbol), [collections](https://github.com/zloirock/core-js#ecmascript-collections), iterators, [typed arrays](https://github.com/zloirock/core-js#ecmascript-typed-arrays), many other features, [ECMAScript proposals](https://github.com/zloirock/core-js#ecmascript-proposals), [some cross-platform WHATWG / W3C features and proposals](#web-standards) like [`URL`](https://github.com/zloirock/core-js#url-and-urlsearchparams). You can load only required features or use it without global namespace pollution. +> Modular standard library for JavaScript. Includes polyfills for [ECMAScript up to 2021](/README.md#ecmascript): [promises](/README.md#ecmascript-promise), [symbols](/README.md#ecmascript-symbol), [collections](/README.md#ecmascript-collections), iterators, [typed arrays](/README.md#ecmascript-typed-arrays), many other features, [ECMAScript proposals](/README.md#ecmascript-proposals), [some cross-platform WHATWG / W3C features and proposals](/README.md#web-standards) like [`URL`](/README.md#url-and-urlsearchparams). You can load only required features or use it without global namespace pollution. ## As advertising: the author is looking for a good job -) -## [core-js@3, babel and a look into the future](https://github.com/zloirock/core-js/tree/master/docs/2019-03-19-core-js-3-babel-and-a-look-into-the-future.md) +## [core-js@3, babel and a look into the future](/docs/2019-03-19-core-js-3-babel-and-a-look-into-the-future.md) ## Raising funds @@ -46,4 +46,4 @@ Promise.any([ .toArray(); // => [9, 25] ``` -**It's a bundled global version for Deno 1.0+, for more info see [`core-js` documentation](https://github.com/zloirock/core-js/blob/master/README.md).** +**It's a bundled global version for Deno 1.0+, for more info see [`core-js` documentation](/README.md).** diff --git a/docs/compatibility-data.md b/docs/compatibility-data.md new file mode 100644 index 000000000000..bc662dff9966 --- /dev/null +++ b/docs/compatibility-data.md @@ -0,0 +1,21 @@ +# Compat data +`core-js` project provides (as [`core-js-compat`](/packages/core-js-compat) package) all required data about the necessity of `core-js` modules, entry points, and tools for work with it - it's useful for integration with tools like `babel` or `swc`. If you wanna help, you could take a look at the related section of [`CONTRIBUTING.md`](/CONTRIBUTING.md#how-to-update-core-js-compat-data). The visualization of compatibility data and the browser tests runner is available [here](http://zloirock.github.io/core-js/compat/), the example: + +![compat-table](https://user-images.githubusercontent.com/2213682/180694428-856bcd0f-cab3-446f-be1a-2f669614dcc0.png) + +# Supported engines +**Tested in:** +- Chrome 26+ +- Firefox 4+ +- Safari 5+ +- Opera 12+ +- Internet Explorer 8+ (sure, IE8 with ES3 limitations; IE7- also should work, but no longer tested) +- Edge +- Android Browser 2.3+ +- iOS Safari 5.1+ +- PhantomJS 1.9+ +- NodeJS 0.8+ +- Deno 1.0+ +- Rhino 1.7.14+ + +...and it doesn't mean `core-js` will not work in other engines, they just have not been tested. diff --git a/docs/features/README.md b/docs/features/README.md new file mode 100644 index 000000000000..71db42b41ceb --- /dev/null +++ b/docs/features/README.md @@ -0,0 +1,10 @@ +# Features +These are divided in 3 main categories: +- [ES](ecmascript/README.md) +- [Proposals](proposals/README.md) +- [Web standards](web-standards/README.md) + +[*CommonJS entry points:*](docs/usage.md#commonjs-api) +``` +core-js(-pure) +``` diff --git a/docs/features/ecmascript/README.md b/docs/features/ecmascript/README.md new file mode 100644 index 000000000000..c58b3b86a4ba --- /dev/null +++ b/docs/features/ecmascript/README.md @@ -0,0 +1,24 @@ +# ES +Polyfills for properties of global object namespaces. + +[*CommonJS entry points:*](docs/usage.md#commonjs-api) +``` +core-js(-pure)/es +``` + +## Index +- [`Object`](object.md) +- [`Function`](function.md) +- [`Error`](error.md) +- [`Array`](array.md) +- [`String` and `RegExp`](string%20and%20regexp.md) +- [`Number`](number.md) +- [`Math`](math.md) +- [`Date`](date.md) +- [`Promise`](promise.md) +- [`Symbol`](symbol.md) +- [Collections](collections.md) +- [`TypedArray`s](typed-array.md) +- [`Reflect`](reflect.md) +- [`JSON`](json.md) +- [`globalThis`](global-this.md) diff --git a/docs/features/ecmascript/array.md b/docs/features/ecmascript/array.md new file mode 100644 index 000000000000..61c469d8e61b --- /dev/null +++ b/docs/features/ecmascript/array.md @@ -0,0 +1,165 @@ +# `Array` +Modules [`es.array.from`](/packages/core-js/modules/es.array.from.js), [`es.array.is-array`](/packages/core-js/modules/es.array.is-array.js), [`es.array.of`](/packages/core-js/modules/es.array.of.js), [`es.array.copy-within`](/packages/core-js/modules/es.array.copy-within.js), [`es.array.fill`](/packages/core-js/modules/es.array.fill.js), [`es.array.find`](/packages/core-js/modules/es.array.find.js), [`es.array.find-index`](/packages/core-js/modules/es.array.find-index.js), [`es.array.find-last`](/packages/core-js/modules/es.array.find-last.js), [`es.array.find-last-index`](/packages/core-js/modules/es.array.find-last-index.js), [`es.array.iterator`](/packages/core-js/modules/es.array.iterator.js), [`es.array.includes`](/packages/core-js/modules/es.array.includes.js), [`es.array.push`](/packages/core-js/modules/es.array.push.js), [`es.array.slice`](/packages/core-js/modules/es.array.slice.js), [`es.array.join`](/packages/core-js/modules/es.array.join.js), [`es.array.unshift`](/packages/core-js/modules/es.array.unshift.js), [`es.array.index-of`](/packages/core-js/modules/es.array.index-of.js), [`es.array.last-index-of`](/packages/core-js/modules/es.array.last-index-of.js), [`es.array.every`](/packages/core-js/modules/es.array.every.js), [`es.array.some`](/packages/core-js/modules/es.array.some.js), [`es.array.for-each`](/packages/core-js/modules/es.array.for-each.js), [`es.array.map`](/packages/core-js/modules/es.array.map.js), [`es.array.filter`](/packages/core-js/modules/es.array.filter.js), [`es.array.reduce`](/packages/core-js/modules/es.array.reduce.js), [`es.array.reduce-right`](/packages/core-js/modules/es.array.reduce-right.js), [`es.array.reverse`](/packages/core-js/modules/es.array.reverse.js), [`es.array.sort`](/packages/core-js/modules/es.array.sort.js), [`es.array.flat`](/packages/core-js/modules/es.array.flat.js), [`es.array.flat-map`](/packages/core-js/modules/es.array.flat-map.js), [`es.array.unscopables.flat`](/packages/core-js/modules/es.array.unscopables.flat.js), [`es.array.unscopables.flat-map`](/packages/core-js/modules/es.array.unscopables.flat-map.js), [`es.array.at`](/packages/core-js/modules/es.array.at.js). +```ts +class Array { + at(index: int): any; + concat(...args: Array): Array; // with adding support of @@isConcatSpreadable and @@species + copyWithin(target: number, start: number, end?: number): this; + entries(): Iterator<[index, value]>; + every(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): boolean; + fill(value: any, start?: number, end?: number): this; + filter(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): Array; // with adding support of @@species + find(callbackfn: (value: any, index: number, target: any) => boolean), thisArg?: any): any; + findIndex(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): uint; + findLast(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): any; + findLastIndex(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): uint; + flat(depthArg?: number = 1): Array; + flatMap(mapFn: (value: any, index: number, target: any) => any, thisArg: any): Array; + forEach(callbackfn: (value: any, index: number, target: any) => void, thisArg?: any): void; + includes(searchElement: any, from?: number): boolean; + indexOf(searchElement: any, from?: number): number; + join(separator: string = ','): string; + keys(): Iterator; + lastIndexOf(searchElement: any, from?: number): number; + map(mapFn: (value: any, index: number, target: any) => any, thisArg?: any): Array; // with adding support of @@species + push(...args: Array): uint; + reduce(callbackfn: (memo: any, value: any, index: number, target: any) => any, initialValue?: any): any; + reduceRight(callbackfn: (memo: any, value: any, index: number, target: any) => any, initialValue?: any): any; + reverse(): this; // Safari 12.0 bug fix + slice(start?: number, end?: number): Array; // with adding support of @@species + splice(start?: number, deleteCount?: number, ...items: Array): Array; // with adding support of @@species + some(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): boolean; + sort(comparefn?: (a: any, b: any) => number): this; // with modern behavior like stable sort + unshift(...args: Array): uint; + values(): Iterator; + @@iterator(): Iterator; + @@unscopables: { [newMethodNames: string]: true }; + static from(items: Iterable | ArrayLike, mapFn?: (value: any, index: number) => any, thisArg?: any): Array; + static isArray(value: any): boolean; + static of(...args: Array): Array; +} + +class Arguments { + @@iterator(): Iterator; // available only in core-js methods +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/es|stable|actual|full/array +core-js(-pure)/es|stable|actual|full/array/from +core-js(-pure)/es|stable|actual|full/array/of +core-js(-pure)/es|stable|actual|full/array/is-array +core-js(-pure)/es|stable|actual|full/array/at +core-js(-pure)/es|stable|actual|full/array/concat +core-js(-pure)/es|stable|actual|full/array/entries +core-js(-pure)/es|stable|actual|full/array/every +core-js(-pure)/es|stable|actual|full/array/copy-within +core-js(-pure)/es|stable|actual|full/array/fill +core-js(-pure)/es|stable|actual|full/array/filter +core-js(-pure)/es|stable|actual|full/array/find +core-js(-pure)/es|stable|actual|full/array/find-index +core-js(-pure)/es|stable|actual|full/array/find-last +core-js(-pure)/es|stable|actual|full/array/find-last-index +core-js(-pure)/es|stable|actual|full/array/flat +core-js(-pure)/es|stable|actual|full/array/flat-map +core-js(-pure)/es|stable|actual|full/array/for-each +core-js(-pure)/es|stable|actual|full/array/includes +core-js(-pure)/es|stable|actual|full/array/index-of +core-js(-pure)/es|stable|actual|full/array/iterator +core-js(-pure)/es|stable|actual|full/array/join +core-js(-pure)/es|stable|actual|full/array/keys +core-js(-pure)/es|stable|actual|full/array/last-index-of +core-js(-pure)/es|stable|actual|full/array/map +core-js(-pure)/es|stable|actual|full/array/push +core-js(-pure)/es|stable|actual|full/array/reduce +core-js(-pure)/es|stable|actual|full/array/reduce-right +core-js(-pure)/es|stable|actual|full/array/reverse +core-js(-pure)/es|stable|actual|full/array/slice +core-js(-pure)/es|stable|actual|full/array/splice +core-js(-pure)/es|stable|actual|full/array/some +core-js(-pure)/es|stable|actual|full/array/sort +core-js(-pure)/es|stable|actual|full/array/unshift +core-js(-pure)/es|stable|actual|full/array/values +core-js(-pure)/es|stable|actual|full/array/virtual/at +core-js(-pure)/es|stable|actual|full/array/virtual/concat +core-js(-pure)/es|stable|actual|full/array/virtual/copy-within +core-js(-pure)/es|stable|actual|full/array/virtual/entries +core-js(-pure)/es|stable|actual|full/array/virtual/every +core-js(-pure)/es|stable|actual|full/array/virtual/fill +core-js(-pure)/es|stable|actual|full/array/virtual/filter +core-js(-pure)/es|stable|actual|full/array/virtual/find +core-js(-pure)/es|stable|actual|full/array/virtual/find-index +core-js(-pure)/es|stable|actual|full/array/virtual/find-last +core-js(-pure)/es|stable|actual|full/array/virtual/find-last-index +core-js(-pure)/es|stable|actual|full/array/virtual/flat +core-js(-pure)/es|stable|actual|full/array/virtual/flat-map +core-js(-pure)/es|stable|actual|full/array/virtual/for-each +core-js(-pure)/es|stable|actual|full/array/virtual/includes +core-js(-pure)/es|stable|actual|full/array/virtual/index-of +core-js(-pure)/es|stable|actual|full/array/virtual/iterator +core-js(-pure)/es|stable|actual|full/array/virtual/join +core-js(-pure)/es|stable|actual|full/array/virtual/keys +core-js(-pure)/es|stable|actual|full/array/virtual/last-index-of +core-js(-pure)/es|stable|actual|full/array/virtual/map +core-js(-pure)/es|stable|actual|full/array/virtual/push +core-js(-pure)/es|stable|actual|full/array/virtual/reduce +core-js(-pure)/es|stable|actual|full/array/virtual/reduce-right +core-js(-pure)/es|stable|actual|full/array/virtual/reverse +core-js(-pure)/es|stable|actual|full/array/virtual/slice +core-js(-pure)/es|stable|actual|full/array/virtual/some +core-js(-pure)/es|stable|actual|full/array/virtual/sort +core-js(-pure)/es|stable|actual|full/array/virtual/splice +core-js(-pure)/es|stable|actual|full/array/virtual/unshift +core-js(-pure)/es|stable|actual|full/array/virtual/values +``` +[*Examples*](https://tinyurl.com/2br28bgj): +```js +Array.from(new Set([1, 2, 3, 2, 1])); // => [1, 2, 3] +Array.from({ 0: 1, 1: 2, 2: 3, length: 3 }); // => [1, 2, 3] +Array.from('123', Number); // => [1, 2, 3] +Array.from('123', it => it * it); // => [1, 4, 9] + +Array.of(1); // => [1] +Array.of(1, 2, 3); // => [1, 2, 3] + +let array = ['a', 'b', 'c']; + +for (let value of array) console.log(value); // => 'a', 'b', 'c' +for (let value of array.values()) console.log(value); // => 'a', 'b', 'c' +for (let key of array.keys()) console.log(key); // => 0, 1, 2 +for (let [key, value] of array.entries()) { + console.log(key); // => 0, 1, 2 + console.log(value); // => 'a', 'b', 'c' +} + +function isOdd(value) { + return value % 2; +} +[4, 8, 15, 16, 23, 42].find(isOdd); // => 15 +[4, 8, 15, 16, 23, 42].findIndex(isOdd); // => 2 +[1, 2, 3, 4].findLast(isOdd); // => 3 +[1, 2, 3, 4].findLastIndex(isOdd); // => 2 + +Array(5).fill(42); // => [42, 42, 42, 42, 42] + +[1, 2, 3, 4, 5].copyWithin(0, 3); // => [4, 5, 3, 4, 5] + + +[1, 2, 3].includes(2); // => true +[1, 2, 3].includes(4); // => false +[1, 2, 3].includes(2, 2); // => false + +[NaN].indexOf(NaN); // => -1 +[NaN].includes(NaN); // => true +Array(1).indexOf(undefined); // => -1 +Array(1).includes(undefined); // => true + +[1, [2, 3], [4, 5]].flat(); // => [1, 2, 3, 4, 5] +[1, [2, [3, [4]]], 5].flat(); // => [1, 2, [3, [4]], 5] +[1, [2, [3, [4]]], 5].flat(3); // => [1, 2, 3, 4, 5] + +[{ a: 1, b: 2 }, { a: 3, b: 4 }, { a: 5, b: 6 }].flatMap(it => [it.a, it.b]); // => [1, 2, 3, 4, 5, 6] + +[1, 2, 3].at(1); // => 2 +[1, 2, 3].at(-1); // => 3 +``` diff --git a/docs/features/ecmascript/collections.md b/docs/features/ecmascript/collections.md new file mode 100644 index 000000000000..3ecb28449e6c --- /dev/null +++ b/docs/features/ecmascript/collections.md @@ -0,0 +1,182 @@ +# Collections +`core-js` uses native collections in most cases, just fixes methods / constructor, if it's required, and in old environments uses fast polyfill (O(1) lookup). +- [Map](#map) +- [Set](#set) +- [WeakMap](#weakmap) +- [WeakSet](#weakset) + +## `Map` +Module [`es.map`](/packages/core-js/modules/es.map.js). +```ts +class Map { + constructor(iterable?: Iterable<[key, value]>): Map; + clear(): void; + delete(key: any): boolean; + forEach(callbackfn: (value: any, key: any, target: any) => void, thisArg: any): void; + get(key: any): any; + has(key: any): boolean; + set(key: any, val: any): this; + values(): Iterator; + keys(): Iterator; + entries(): Iterator<[key, value]>; + @@iterator(): Iterator<[key, value]>; + readonly attribute size: number; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/es|stable|actual|full/map +``` +[*Examples*](https://goo.gl/GWR7NI): +```js +let array = [1]; + +let map = new Map([['a', 1], [42, 2]]); +map.set(array, 3).set(true, 4); + +console.log(map.size); // => 4 +console.log(map.has(array)); // => true +console.log(map.has([1])); // => false +console.log(map.get(array)); // => 3 +map.forEach((val, key) => { + console.log(val); // => 1, 2, 3, 4 + console.log(key); // => 'a', 42, [1], true +}); +map.delete(array); +console.log(map.size); // => 3 +console.log(map.get(array)); // => undefined +console.log(Array.from(map)); // => [['a', 1], [42, 2], [true, 4]] + +let map = new Map([['a', 1], ['b', 2], ['c', 3]]); + +for (let [key, value] of map) { + console.log(key); // => 'a', 'b', 'c' + console.log(value); // => 1, 2, 3 +} +for (let value of map.values()) console.log(value); // => 1, 2, 3 +for (let key of map.keys()) console.log(key); // => 'a', 'b', 'c' +for (let [key, value] of map.entries()) { + console.log(key); // => 'a', 'b', 'c' + console.log(value); // => 1, 2, 3 +} +``` +## `Set` +Module [`es.set`](/packages/core-js/modules/es.set.js). +```ts +class Set { + constructor(iterable?: Iterable): Set; + add(key: any): this; + clear(): void; + delete(key: any): boolean; + forEach((value: any, key: any, target: any) => void, thisArg: any): void; + has(key: any): boolean; + values(): Iterator; + keys(): Iterator; + entries(): Iterator<[value, value]>; + @@iterator(): Iterator; + readonly attribute size: number; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/es|stable|actual|full/set +``` +[*Examples*](https://goo.gl/bmhLwg): +```js +let set = new Set(['a', 'b', 'a', 'c']); +set.add('d').add('b').add('e'); +console.log(set.size); // => 5 +console.log(set.has('b')); // => true +set.forEach(it => { + console.log(it); // => 'a', 'b', 'c', 'd', 'e' +}); +set.delete('b'); +console.log(set.size); // => 4 +console.log(set.has('b')); // => false +console.log(Array.from(set)); // => ['a', 'c', 'd', 'e'] + +let set = new Set([1, 2, 3, 2, 1]); + +for (let value of set) console.log(value); // => 1, 2, 3 +for (let value of set.values()) console.log(value); // => 1, 2, 3 +for (let key of set.keys()) console.log(key); // => 1, 2, 3 +for (let [key, value] of set.entries()) { + console.log(key); // => 1, 2, 3 + console.log(value); // => 1, 2, 3 +} +``` +## `WeakMap` +Module [`es.weak-map`](/packages/core-js/modules/es.weak-map.js). +```ts +class WeakMap { + constructor(iterable?: Iterable<[key, value]>): WeakMap; + delete(key: Object): boolean; + get(key: Object): any; + has(key: Object): boolean; + set(key: Object, val: any): this; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/es|stable|actual|full/weak-map +``` +[*Examples*](https://goo.gl/SILXyw): +```js +let a = [1]; +let b = [2]; +let c = [3]; + +let weakmap = new WeakMap([[a, 1], [b, 2]]); +weakmap.set(c, 3).set(b, 4); +console.log(weakmap.has(a)); // => true +console.log(weakmap.has([1])); // => false +console.log(weakmap.get(a)); // => 1 +weakmap.delete(a); +console.log(weakmap.get(a)); // => undefined + +// Private properties store: +let Person = (() => { + let names = new WeakMap; + return class { + constructor(name) { + names.set(this, name); + } + getName() { + return names.get(this); + } + } +})(); + +let person = new Person('Vasya'); +console.log(person.getName()); // => 'Vasya' +for (let key in person) console.log(key); // => only 'getName' +``` +## `WeakSet` +Module [`es.weak-set`](/packages/core-js/modules/es.weak-set.js). +```ts +class WeakSet { + constructor(iterable?: Iterable): WeakSet; + add(key: Object): this; + delete(key: Object): boolean; + has(key: Object): boolean; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/es|stable|actual|full/weak-set +``` +[*Examples*](https://goo.gl/TdFbEx): +```js +let a = [1]; +let b = [2]; +let c = [3]; + +let weakset = new WeakSet([a, b, a]); +weakset.add(c).add(b).add(c); +console.log(weakset.has(b)); // => true +console.log(weakset.has([2])); // => false +weakset.delete(b); +console.log(weakset.has(b)); // => false +``` +## Caveats when using collections polyfill: +* Weak-collections polyfill stores values as hidden properties of keys. It works correctly and doesn't leak in most cases. However, it is desirable to store a collection longer than its keys. diff --git a/docs/features/ecmascript/date.md b/docs/features/ecmascript/date.md new file mode 100644 index 000000000000..726b6903edb6 --- /dev/null +++ b/docs/features/ecmascript/date.md @@ -0,0 +1,32 @@ +# `Date` +Modules [`es.date.to-string`](/packages/core-js/modules/es.date.to-string.js), ES5 features with fixes: [`es.date.now`](/packages/core-js/modules/es.date.now.js), [`es.date.to-iso-string`](/packages/core-js/modules/es.date.to-iso-string.js), [`es.date.to-json`](/packages/core-js/modules/es.date.to-json.js) and [`es.date.to-primitive`](/packages/core-js/modules/es.date.to-primitive.js). + +Annex B methods. Modules [`es.date.get-year`](/packages/core-js/modules/es.date.get-year.js), [`es.date.set-year`](/packages/core-js/modules/es.date.set-year.js) and [`es.date.to-gmt-string`](/packages/core-js/modules/es.date.to-gmt-string.js). +```ts +class Date { + getYear(): int; + setYear(year: int): number; + toGMTString(): string; + toISOString(): string; + toJSON(): string; + toString(): string; + @@toPrimitive(hint: 'default' | 'number' | 'string'): string | number; + static now(): number; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/es|stable|actual|full/date +core-js/es|stable|actual|full/date/to-string +core-js(-pure)/es|stable|actual|full/date/now +core-js(-pure)/es|stable|actual|full/date/get-year +core-js(-pure)/es|stable|actual|full/date/set-year +core-js(-pure)/es|stable|actual|full/date/to-gmt-string +core-js(-pure)/es|stable|actual|full/date/to-iso-string +core-js(-pure)/es|stable|actual|full/date/to-json +core-js(-pure)/es|stable|actual|full/date/to-primitive +``` +[*Example*](https://goo.gl/haeHLR): +```js +new Date(NaN).toString(); // => 'Invalid Date' +``` diff --git a/docs/features/ecmascript/error.md b/docs/features/ecmascript/error.md new file mode 100644 index 000000000000..cdda399130d7 --- /dev/null +++ b/docs/features/ecmascript/error.md @@ -0,0 +1,49 @@ +# ES Error +Modules [`es.aggregate-error`](/packages/core-js/modules/es.aggregate-error.js), [`es.aggregate-error.cause`](/packages/core-js/modules/es.aggregate-error.cause.js), [`es.error.cause`](/packages/core-js/modules/es.error.cause.js). +```ts +class [ + Error, + EvalError, + RangeError, + ReferenceError, + SyntaxError, + TypeError, + URIError, + WebAssembly.CompileError, + WebAssembly.LinkError, + WebAssembly.RuntimeError, +] { + constructor(message: string, { cause: any }): %Error%; +} + +class AggregateError { + constructor(errors: Iterable, message: string, { cause: any }): AggregateError; + errors: Array; + message: string; +} + +class Error { + toString(): string; // different fixes +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/es|stable|actual|full/aggregate-error +core-js/es|stable|actual|full/error +core-js/es|stable|actual|full/error/constructor +core-js/es|stable|actual|full/error/to-string +``` +[*Example*](https://is.gd/1SufcH): +```js +const error1 = new TypeError('Error 1'); +const error2 = new TypeError('Error 2'); +const aggregate = new AggregateError([error1, error2], 'Collected errors'); +aggregate.errors[0] === error1; // => true +aggregate.errors[1] === error2; // => true + +const cause = new TypeError('Something wrong'); +const error = new TypeError('Here explained what`s wrong', { cause }); +error.cause === cause; // => true + +Error.prototype.toString.call({ message: 1, name: 2 }) === '2: 1'; // => true +``` diff --git a/docs/features/ecmascript/function.md b/docs/features/ecmascript/function.md new file mode 100644 index 000000000000..74ba85884b68 --- /dev/null +++ b/docs/features/ecmascript/function.md @@ -0,0 +1,23 @@ +# `Function` +Modules [`es.function.name`](/packages/core-js/modules/es.function.name.js), [`es.function.has-instance`](/packages/core-js/modules/es.function.has-instance.js). Just ES5: [`es.function.bind`](/packages/core-js/modules/es.function.bind.js). +```ts +class Function { + name: string; + bind(thisArg: any, ...args: Array): Function; + @@hasInstance(value: any): boolean; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/es|stable|actual|full/function +core-js/es|stable|actual|full/function/name +core-js/es|stable|actual|full/function/has-instance +core-js(-pure)/es|stable|actual|full/function/bind +core-js(-pure)/es|stable|actual|full/function/virtual/bind +``` +[*Example*](https://goo.gl/zqu3Wp): +```js +(function foo() {}).name // => 'foo' + +console.log.bind(console, 42)(43); // => 42 43 +``` diff --git a/docs/features/ecmascript/global-this.md b/docs/features/ecmascript/global-this.md new file mode 100644 index 000000000000..30b0366276ef --- /dev/null +++ b/docs/features/ecmascript/global-this.md @@ -0,0 +1,13 @@ +# `globalThis` +Module [`es.global-this`](/packages/core-js/modules/es.global-this.js). +```ts +let globalThis: Object; +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/es|stable|actual|full/global-this +``` +[*Examples*](https://goo.gl/LAifsc): +```js +globalThis.Array === Array; // => true +``` diff --git a/docs/features/ecmascript/json.md b/docs/features/ecmascript/json.md new file mode 100644 index 000000000000..1bca64c690db --- /dev/null +++ b/docs/features/ecmascript/json.md @@ -0,0 +1,19 @@ +# `JSON` +Since `JSON` object is missed only in very old engines like IE7-, `core-js` does not provide a full `JSON` polyfill, however, fix already existing implementations by the current standard, for example, [well-formed `JSON.stringify`](https://github.com/tc39/proposal-well-formed-stringify). `JSON` also fixed in other modules - for example, `Symbol` polyfill fixes `JSON.stringify` for correct work with symbols. + +Module [`es.json.to-string-tag`](/packages/core-js/modules/es.json.to-string-tag.js) and [`es.json.stringify`](/packages/core-js/modules/es.json.stringify.js). +```ts +namespace JSON { + stringify(target: any, replacer?: Function | Array, space?: string | number): string | void; + @@toStringTag: 'JSON'; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/es|stable|actual|full/json/stringify +core-js(-pure)/es|stable|actual|full/json/to-string-tag +``` +[*Examples*](https://is.gd/izZqKn): +```js +JSON.stringify({ '𠮷': ['\uDF06\uD834'] }); // => '{"𠮷":["\\udf06\\ud834"]}' +``` diff --git a/docs/features/ecmascript/math.md b/docs/features/ecmascript/math.md new file mode 100644 index 000000000000..f34de9630c05 --- /dev/null +++ b/docs/features/ecmascript/math.md @@ -0,0 +1,44 @@ +# `Math` +Modules [`es.math.acosh`](/packages/core-js/modules/es.math.acosh.js), [`es.math.asinh`](/packages/core-js/modules/es.math.asinh.js), [`es.math.atanh`](/packages/core-js/modules/es.math.atanh.js), [`es.math.cbrt`](/packages/core-js/modules/es.math.cbrt.js), [`es.math.clz32`](/packages/core-js/modules/es.math.clz32.js), [`es.math.cosh`](/packages/core-js/modules/es.math.cosh.js), [`es.math.expm1`](/packages/core-js/modules/es.math.expm1.js), [`es.math.fround`](/packages/core-js/modules/es.math.fround.js), [`es.math.hypot`](/packages/core-js/modules/es.math.hypot.js), [`es.math.imul`](/packages/core-js/modules/es.math.imul.js), [`es.math.log10`](/packages/core-js/modules/es.math.log10.js), [`es.math.log1p`](/packages/core-js/modules/es.math.log1p.js), [`es.math.log2`](/packages/core-js/modules/es.math.log2.js), [`es.math.sign`](/packages/core-js/modules/es.math.sign.js), [`es.math.sinh`](/packages/core-js/modules/es.math.sinh.js), [`es.math.tanh`](/packages/core-js/modules/es.math.tanh.js), [`es.math.trunc`](/packages/core-js/modules/es.math.trunc.js). +```ts +namespace Math { + acosh(number: number): number; + asinh(number: number): number; + atanh(number: number): number; + cbrt(number: number): number; + clz32(number: number): number; + cosh(number: number): number; + expm1(number: number): number; + fround(number: number): number; + hypot(...args: Array): number; + imul(number1: number, number2: number): number; + log1p(number: number): number; + log10(number: number): number; + log2(number: number): number; + sign(number: number): 1 | -1 | 0 | -0 | NaN; + sinh(number: number): number; + tanh(number: number): number; + trunc(number: number): number; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/es|stable|actual|full/math +core-js(-pure)/es|stable|actual|full/math/acosh +core-js(-pure)/es|stable|actual|full/math/asinh +core-js(-pure)/es|stable|actual|full/math/atanh +core-js(-pure)/es|stable|actual|full/math/cbrt +core-js(-pure)/es|stable|actual|full/math/clz32 +core-js(-pure)/es|stable|actual|full/math/cosh +core-js(-pure)/es|stable|actual|full/math/expm1 +core-js(-pure)/es|stable|actual|full/math/fround +core-js(-pure)/es|stable|actual|full/math/hypot +core-js(-pure)/es|stable|actual|full/math/imul +core-js(-pure)/es|stable|actual|full/math/log1p +core-js(-pure)/es|stable|actual|full/math/log10 +core-js(-pure)/es|stable|actual|full/math/log2 +core-js(-pure)/es|stable|actual|full/math/sign +core-js(-pure)/es|stable|actual|full/math/sinh +core-js(-pure)/es|stable|actual|full/math/tanh +core-js(-pure)/es|stable|actual|full/math/trunc +``` diff --git a/docs/features/ecmascript/number.md b/docs/features/ecmascript/number.md new file mode 100644 index 000000000000..2e15f8ecb8a5 --- /dev/null +++ b/docs/features/ecmascript/number.md @@ -0,0 +1,46 @@ +# `Number` +Module [`es.number.constructor`](/packages/core-js/modules/es.number.constructor.js). `Number` constructor support binary and octal literals, [*example*](https://goo.gl/jRd6b3): +```js +Number('0b1010101'); // => 85 +Number('0o7654321'); // => 2054353 +``` +Modules [`es.number.epsilon`](/packages/core-js/modules/es.number.epsilon.js), [`es.number.is-finite`](/packages/core-js/modules/es.number.is-finite.js), [`es.number.is-integer`](/packages/core-js/modules/es.number.is-integer.js), [`es.number.is-nan`](/packages/core-js/modules/es.number.is-nan.js), [`es.number.is-safe-integer`](/packages/core-js/modules/es.number.is-safe-integer.js), [`es.number.max-safe-integer`](/packages/core-js/modules/es.number.max-safe-integer.js), [`es.number.min-safe-integer`](/packages/core-js/modules/es.number.min-safe-integer.js), [`es.number.parse-float`](/packages/core-js/modules/es.number.parse-float.js), [`es.number.parse-int`](/packages/core-js/modules/es.number.parse-int.js), [`es.number.to-exponential`](/packages/core-js/modules/es.number.to-exponential.js), [`es.number.to-fixed`](/packages/core-js/modules/es.number.to-fixed.js), [`es.number.to-precision`](/packages/core-js/modules/es.number.to-precision.js), [`es.parse-int`](/packages/core-js/modules/es.parse-int.js), [`es.parse-float`](/packages/core-js/modules/es.parse-float.js). +```ts +class Number { + constructor(value: any): number; + toExponential(digits: number): string; + toFixed(digits: number): string; + toPrecision(precision: number): string; + static isFinite(number: any): boolean; + static isNaN(number: any): boolean; + static isInteger(number: any): boolean; + static isSafeInteger(number: any): boolean; + static parseFloat(string: string): number; + static parseInt(string: string, radix?: number = 10): number; + static EPSILON: number; + static MAX_SAFE_INTEGER: number; + static MIN_SAFE_INTEGER: number; +} + +function parseFloat(string: string): number; +function parseInt(string: string, radix?: number = 10): number; +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/es|stable|actual|full/number +core-js/es|stable|actual|full/number/constructor +core-js(-pure)/es|stable|actual|full/number/is-finite +core-js(-pure)/es|stable|actual|full/number/is-nan +core-js(-pure)/es|stable|actual|full/number/is-integer +core-js(-pure)/es|stable|actual|full/number/is-safe-integer +core-js(-pure)/es|stable|actual|full/number/parse-float +core-js(-pure)/es|stable|actual|full/number/parse-int +core-js(-pure)/es|stable|actual|full/number/epsilon +core-js(-pure)/es|stable|actual|full/number/max-safe-integer +core-js(-pure)/es|stable|actual|full/number/min-safe-integer +core-js(-pure)/es|stable|actual|full/number(/virtual)/to-exponential +core-js(-pure)/es|stable|actual|full/number(/virtual)/to-fixed +core-js(-pure)/es|stable|actual|full/number(/virtual)/to-precision +core-js(-pure)/es|stable|actual|full/parse-float +core-js(-pure)/es|stable|actual|full/parse-int +``` diff --git a/docs/features/ecmascript/object.md b/docs/features/ecmascript/object.md new file mode 100644 index 000000000000..e55745afec1e --- /dev/null +++ b/docs/features/ecmascript/object.md @@ -0,0 +1,125 @@ +# `Object` +Modules [`es.object.assign`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.assign.js), [`es.object.create`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.create.js), [`es.object.define-getter`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.define-getter.js), [`es.object.define-property`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.define-property.js), [`es.object.define-properties`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.es.object.define-properties.js), [`es.object.define-setter`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.define-setter.js), [`es.object.entries`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.entries.js), [`es.object.freeze`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.freeze.js), [`es.object.from-entries`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.from-entries.js), [`es.object.get-own-property-descriptor`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.get-own-property-descriptor.js), [`es.object.get-own-property-descriptors`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.get-own-property-descriptors.js), [`es.object.get-own-property-names`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.get-own-property-names.js), [`es.object.get-prototype-of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.get-prototype-of.js), [`es.object.has-own`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.has-own.js), [`es.object.is`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.is.js), [`es.object.is-extensible`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.is-extensible.js), [`es.object.is-frozen`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.is-frozen.js), [`es.object.is-sealed`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.is-sealed.js), [`es.object.keys`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.keys.js), [`es.object.lookup-setter`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.lookup-setter.js), [`es.object.lookup-getter`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.lookup-getter.js), [`es.object.prevent-extensions`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.prevent-extensions.js), [`es.object.proto`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.proto.js), [`es.object.to-string`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.to-string.js), [`es.object.seal`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.seal.js), [`es.object.set-prototype-of`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.set-prototype-of.js), [`es.object.values`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.object.values.js). + +```ts +class Object { + toString(): string; // ES2015+ fix: @@toStringTag support + __defineGetter__(property: PropertyKey, getter: Function): void; + __defineSetter__(property: PropertyKey, setter: Function): void; + __lookupGetter__(property: PropertyKey): Function | void; + __lookupSetter__(property: PropertyKey): Function | void; + __proto__: Object | null; // required a way setting of prototype - will not in IE10-, it's for modern engines like Deno + static assign(target: Object, ...sources: Array): Object; + static create(prototype: Object | null, properties?: { [property: PropertyKey]: PropertyDescriptor }): Object; + static defineProperties(object: Object, properties: { [property: PropertyKey]: PropertyDescriptor }): Object; + static defineProperty(object: Object, property: PropertyKey, attributes: PropertyDescriptor): Object; + static entries(object: Object): Array<[string, mixed]>; + static freeze(object: any): any; + static fromEntries(iterable: Iterable<[key, value]>): Object; + static getOwnPropertyDescriptor(object: any, property: PropertyKey): PropertyDescriptor | void; + static getOwnPropertyDescriptors(object: any): { [property: PropertyKey]: PropertyDescriptor }; + static getOwnPropertyNames(object: any): Array; + static getPrototypeOf(object: any): Object | null; + static hasOwn(object: object, key: PropertyKey): boolean; + static is(value1: any, value2: any): boolean; + static isExtensible(object: any): boolean; + static isFrozen(object: any): boolean; + static isSealed(object: any): boolean; + static keys(object: any): Array; + static preventExtensions(object: any): any; + static seal(object: any): any; + static setPrototypeOf(target: any, prototype: Object | null): any; // required __proto__ - IE11+ + static values(object: any): Array; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/es|stable|actual|full/object +core-js(-pure)/es|stable|actual|full/object/assign +core-js(-pure)/es|stable|actual|full/object/is +core-js(-pure)/es|stable|actual|full/object/set-prototype-of +core-js(-pure)/es|stable|actual|full/object/get-prototype-of +core-js(-pure)/es|stable|actual|full/object/create +core-js(-pure)/es|stable|actual|full/object/define-property +core-js(-pure)/es|stable|actual|full/object/define-properties +core-js(-pure)/es|stable|actual|full/object/get-own-property-descriptor +core-js(-pure)/es|stable|actual|full/object/get-own-property-descriptors +core-js(-pure)/es|stable|actual|full/object/has-own +core-js(-pure)/es|stable|actual|full/object/keys +core-js(-pure)/es|stable|actual|full/object/values +core-js(-pure)/es|stable|actual|full/object/entries +core-js(-pure)/es|stable|actual|full/object/get-own-property-names +core-js(-pure)/es|stable|actual|full/object/freeze +core-js(-pure)/es|stable|actual|full/object/from-entries +core-js(-pure)/es|stable|actual|full/object/seal +core-js(-pure)/es|stable|actual|full/object/prevent-extensions +core-js/es|stable|actual|full/object/proto +core-js(-pure)/es|stable|actual|full/object/is-frozen +core-js(-pure)/es|stable|actual|full/object/is-sealed +core-js(-pure)/es|stable|actual|full/object/is-extensible +core-js/es|stable|actual|full/object/to-string +core-js(-pure)/es|stable|actual|full/object/define-getter +core-js(-pure)/es|stable|actual|full/object/define-setter +core-js(-pure)/es|stable|actual|full/object/lookup-getter +core-js(-pure)/es|stable|actual|full/object/lookup-setter +``` +[*Examples*](https://is.gd/udzZq0): +```js +let foo = { q: 1, w: 2 }; +let bar = { e: 3, r: 4 }; +let baz = { t: 5, y: 6 }; +Object.assign(foo, bar, baz); // => foo = { q: 1, w: 2, e: 3, r: 4, t: 5, y: 6 } + +Object.is(NaN, NaN); // => true +Object.is(0, -0); // => false +Object.is(42, 42); // => true +Object.is(42, '42'); // => false + +function Parent() {} +function Child() {} +Object.setPrototypeOf(Child.prototype, Parent.prototype); +new Child() instanceof Child; // => true +new Child() instanceof Parent; // => true + +let object = { + [Symbol.toStringTag]: 'Foo' +}; + +'' + object; // => '[object Foo]' + +Object.keys('qwe'); // => ['0', '1', '2'] +Object.getPrototypeOf('qwe') === String.prototype; // => true + +Object.values({ a: 1, b: 2, c: 3 }); // => [1, 2, 3] +Object.entries({ a: 1, b: 2, c: 3 }); // => [['a', 1], ['b', 2], ['c', 3]] + +for (let [key, value] of Object.entries({ a: 1, b: 2, c: 3 })) { + console.log(key); // => 'a', 'b', 'c' + console.log(value); // => 1, 2, 3 +} + +// Shallow object cloning with prototype and descriptors: +let copy = Object.create(Object.getPrototypeOf(object), Object.getOwnPropertyDescriptors(object)); +// Mixin: +Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); + +const map = new Map([['a', 1], ['b', 2]]); +Object.fromEntries(map); // => { a: 1, b: 2 } + +class Unit { + constructor(id) { + this.id = id; + } + toString() { + return `unit${ this.id }`; + } +} + +const units = new Set([new Unit(101), new Unit(102)]); + +Object.fromEntries(units.entries()); // => { unit101: Unit { id: 101 }, unit102: Unit { id: 102 } } + +Object.hasOwn({ foo: 42 }, 'foo'); // => true +Object.hasOwn({ foo: 42 }, 'bar'); // => false +Object.hasOwn({}, 'toString'); // => false +``` diff --git a/docs/features/ecmascript/promise.md b/docs/features/ecmascript/promise.md new file mode 100644 index 000000000000..09b9da903f19 --- /dev/null +++ b/docs/features/ecmascript/promise.md @@ -0,0 +1,157 @@ +# `Promise` +Modules [`es.promise`](/packages/core-js/modules/es.promise.js), [`es.promise.all-settled`](/packages/core-js/modules/es.promise.all-settled.js), [`es.promise.any`](/packages/core-js/modules/es.promise.any.js) and [`es.promise.finally`](/packages/core-js/modules/es.promise.finally.js). +```ts +class Promise { + constructor(executor: (resolve: Function, reject: Function) => void): Promise; + then(onFulfilled: Function, onRejected: Function): Promise; + catch(onRejected: Function): Promise; + finally(onFinally: Function): Promise; + static resolve(x: any): Promise; + static reject(r: any): Promise; + static all(iterable: Iterable): Promise; + static allSettled(iterable: Iterable): Promise; + static any(promises: Iterable): Promise; + static race(iterable: Iterable): Promise; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/es|stable|actual|full/promise +core-js(-pure)/es|stable|actual|full/promise/all-settled +core-js(-pure)/es|stable|actual|full/promise/any +core-js(-pure)/es|stable|actual|full/promise/finally +``` +Basic [*example*](https://goo.gl/vGrtUC): +```js +function sleepRandom(time) { + return new Promise((resolve, reject) => { + setTimeout(resolve, time * 1e3, 0 | Math.random() * 1e3); + }); +} + +console.log('Run'); // => Run +sleepRandom(5).then(result => { + console.log(result); // => 869, after 5 sec. + return sleepRandom(10); +}).then(result => { + console.log(result); // => 202, after 10 sec. +}).then(() => { + console.log('immediately after'); // => immediately after + throw Error('Irror!'); +}).then(() => { + console.log('will not be displayed'); +}).catch(x => console.log(x)); // => => Error: Irror! +``` +`Promise.resolve` and `Promise.reject` [*example*](https://goo.gl/vr8TN3): +```js +Promise.resolve(42).then(x => console.log(x)); // => 42 +Promise.reject(42).catch(x => console.log(x)); // => 42 + +Promise.resolve($.getJSON('/data.json')); // => ES promise +``` +`Promise#finally` [*example*](https://goo.gl/AhyBbJ): +```js +Promise.resolve(42).finally(() => console.log('You will see it anyway')); + +Promise.reject(42).finally(() => console.log('You will see it anyway')); +``` +`Promise.all` [*example*](https://goo.gl/RdoDBZ): +```js +Promise.all([ + 'foo', + sleepRandom(5), + sleepRandom(15), + sleepRandom(10) // after 15 sec: +]).then(x => console.log(x)); // => ['foo', 956, 85, 382] +``` +`Promise.race` [*example*](https://goo.gl/L8ovkJ): +```js +function timeLimit(promise, time) { + return Promise.race([promise, new Promise((resolve, reject) => { + setTimeout(reject, time * 1e3, Error('Await > ' + time + ' sec')); + })]); +} + +timeLimit(sleepRandom(5), 10).then(x => console.log(x)); // => 853, after 5 sec. +timeLimit(sleepRandom(15), 10).catch(x => console.log(x)); // Error: Await > 10 sec +``` +`Promise.allSettled` [*example*](https://goo.gl/PXXLNJ): +```js +Promise.allSettled([ + Promise.resolve(1), + Promise.reject(2), + Promise.resolve(3), +]).then(console.log); // => [{ value: 1, status: 'fulfilled' }, { reason: 2, status: 'rejected' }, { value: 3, status: 'fulfilled' }] +``` +`Promise.any` [*example*](https://goo.gl/iErvmp): +```js +Promise.any([ + Promise.resolve(1), + Promise.reject(2), + Promise.resolve(3), +]).then(console.log); // => 1 + +Promise.any([ + Promise.reject(1), + Promise.reject(2), + Promise.reject(3), +]).catch(({ errors }) => console.log(errors)); // => [1, 2, 3] +``` +[Example](https://goo.gl/wnQS4j) with async functions: +```js +let delay = time => new Promise(resolve => setTimeout(resolve, time)) + +async function sleepRandom(time) { + await delay(time * 1e3); + return 0 | Math.random() * 1e3; +} + +async function sleepError(time, msg) { + await delay(time * 1e3); + throw Error(msg); +} + +(async () => { + try { + console.log('Run'); // => Run + console.log(await sleepRandom(5)); // => 936, after 5 sec. + let [a, b, c] = await Promise.all([ + sleepRandom(5), + sleepRandom(15), + sleepRandom(10) + ]); + console.log(a, b, c); // => 210 445 71, after 15 sec. + await sleepError(5, 'Error!'); + console.log('Will not be displayed'); + } catch (e) { + console.log(e); // => Error: 'Error!', after 5 sec. + } +})(); +``` +## Unhandled rejection tracking + +In Node.js, like in native implementation, available events [`unhandledRejection`](https://nodejs.org/api/process.html#process_event_unhandledrejection) and [`rejectionHandled`](https://nodejs.org/api/process.html#process_event_rejectionhandled): +```js +process.on('unhandledRejection', (reason, promise) => console.log('unhandled', reason, promise)); +process.on('rejectionHandled', (promise) => console.log('handled', promise)); + +let promise = Promise.reject(42); +// unhandled 42 [object Promise] + +setTimeout(() => promise.catch(() => {}), 1e3); +// handled [object Promise] +``` +In a browser on rejection, by default, you will see notify in the console, or you can add a custom handler and a handler on handling unhandled, [*example*](https://goo.gl/Wozskl): +```js +window.addEventListener('unhandledrejection', e => console.log('unhandled', e.reason, e.promise)); +window.addEventListener('rejectionhandled', e => console.log('handled', e.reason, e.promise)); +// or +window.onunhandledrejection = e => console.log('unhandled', e.reason, e.promise); +window.onrejectionhandled = e => console.log('handled', e.reason, e.promise); + +let promise = Promise.reject(42); +// => unhandled 42 [object Promise] + +setTimeout(() => promise.catch(() => {}), 1e3); +// => handled 42 [object Promise] +``` diff --git a/docs/features/ecmascript/reflect.md b/docs/features/ecmascript/reflect.md new file mode 100644 index 000000000000..22c803284a18 --- /dev/null +++ b/docs/features/ecmascript/reflect.md @@ -0,0 +1,50 @@ +# `Reflect` +Modules [`es.reflect.apply`](/packages/core-js/modules/es.reflect.apply.js), [`es.reflect.construct`](/packages/core-js/modules/es.reflect.construct.js), [`es.reflect.define-property`](/packages/core-js/modules/es.reflect.define-property.js), [`es.reflect.delete-property`](/packages/core-js/modules/es.reflect.delete-property.js), [`es.reflect.get`](/packages/core-js/modules/es.reflect.get.js), [`es.reflect.get-own-property-descriptor`](/packages/core-js/modules/es.reflect.get-own-property-descriptor.js), [`es.reflect.get-prototype-of`](/packages/core-js/modules/es.reflect.get-prototype-of.js), [`es.reflect.has`](/packages/core-js/modules/es.reflect.has.js), [`es.reflect.is-extensible`](/packages/core-js/modules/es.reflect.is-extensible.js), [`es.reflect.own-keys`](/packages/core-js/modules/es.reflect.own-keys.js), [`es.reflect.prevent-extensions`](/packages/core-js/modules/es.reflect.prevent-extensions.js), [`es.reflect.set`](/packages/core-js/modules/es.reflect.set.js), [`es.reflect.set-prototype-of`](/packages/core-js/modules/es.reflect.set-prototype-of.js). +```ts +namespace Reflect { + apply(target: Function, thisArgument: any, argumentsList: Array): any; + construct(target: Function, argumentsList: Array, newTarget?: Function): Object; + defineProperty(target: Object, propertyKey: PropertyKey, attributes: PropertyDescriptor): boolean; + deleteProperty(target: Object, propertyKey: PropertyKey): boolean; + get(target: Object, propertyKey: PropertyKey, receiver?: any): any; + getOwnPropertyDescriptor(target: Object, propertyKey: PropertyKey): PropertyDescriptor | void; + getPrototypeOf(target: Object): Object | null; + has(target: Object, propertyKey: PropertyKey): boolean; + isExtensible(target: Object): boolean; + ownKeys(target: Object): Array; + preventExtensions(target: Object): boolean; + set(target: Object, propertyKey: PropertyKey, V: any, receiver?: any): boolean; + setPrototypeOf(target: Object, proto: Object | null): boolean; // required __proto__ - IE11+ +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/es|stable|actual|full/reflect +core-js(-pure)/es|stable|actual|full/reflect/apply +core-js(-pure)/es|stable|actual|full/reflect/construct +core-js(-pure)/es|stable|actual|full/reflect/define-property +core-js(-pure)/es|stable|actual|full/reflect/delete-property +core-js(-pure)/es|stable|actual|full/reflect/get +core-js(-pure)/es|stable|actual|full/reflect/get-own-property-descriptor +core-js(-pure)/es|stable|actual|full/reflect/get-prototype-of +core-js(-pure)/es|stable|actual|full/reflect/has +core-js(-pure)/es|stable|actual|full/reflect/is-extensible +core-js(-pure)/es|stable|actual|full/reflect/own-keys +core-js(-pure)/es|stable|actual|full/reflect/prevent-extensions +core-js(-pure)/es|stable|actual|full/reflect/set +core-js(-pure)/es|stable|actual|full/reflect/set-prototype-of +``` +[*Examples*](https://goo.gl/gVT0cH): +```js +let object = { a: 1 }; +Object.defineProperty(object, 'b', { value: 2 }); +object[Symbol('c')] = 3; +Reflect.ownKeys(object); // => ['a', 'b', Symbol(c)] + +function C(a, b) { + this.c = a + b; +} + +let instance = Reflect.construct(C, [20, 22]); +instance.c; // => 42 +``` diff --git a/docs/features/ecmascript/string and regexp.md b/docs/features/ecmascript/string and regexp.md new file mode 100644 index 000000000000..880306e4c3eb --- /dev/null +++ b/docs/features/ecmascript/string and regexp.md @@ -0,0 +1,189 @@ +# `String` and `RegExp` +The main part of `String` features: modules [`es.string.from-code-point`](/packages/core-js/modules/es.string.from-code-point.js), [`es.string.raw`](/packages/core-js/modules/es.string.raw.js), [`es.string.iterator`](/packages/core-js/modules/es.string.iterator.js), [`es.string.split`](/packages/core-js/modules/es.string.split.js), [`es.string.code-point-at`](/packages/core-js/modules/es.string.code-point-at.js), [`es.string.ends-with`](/packages/core-js/modules/es.string.ends-with.js), [`es.string.includes`](/packages/core-js/modules/es.string.includes.js), [`es.string.repeat`](/packages/core-js/modules/es.string.repeat.js), [`es.string.pad-start`](/packages/core-js/modules/es.string.pad-start.js), [`es.string.pad-end`](/packages/core-js/modules/es.string.pad-end.js), [`es.string.starts-with`](/packages/core-js/modules/es.string.starts-with.js), [`es.string.trim`](/packages/core-js/modules/es.string.trim.js), [`es.string.trim-start`](/packages/core-js/modules/es.string.trim-start.js), [`es.string.trim-end`](/packages/core-js/modules/es.string.trim-end.js), [`es.string.match-all`](/packages/core-js/modules/es.string.match-all.js), [`es.string.replace-all`](/packages/core-js/modules/es.string.replace-all.js), [`es.string.at-alternative`](/packages/core-js/modules/es.string.at-alternative.js). + +Adding support of well-known [symbols](./Symbol.md) `@@match`, `@@replace`, `@@search` and `@@split` and direct `.exec` calls to related `String` methods, modules [`es.string.match`](/packages/core-js/modules/es.string.match.js), [`es.string.replace`](/packages/core-js/modules/es.string.replace.js), [`es.string.search`](/packages/core-js/modules/es.string.search.js) and [`es.string.split`](/packages/core-js/modules/es.string.split.js). + +Annex B methods. Modules [`es.string.anchor`](/packages/core-js/modules/es.string.anchor.js), [`es.string.big`](/packages/core-js/modules/es.string.big.js), [`es.string.blink`](/packages/core-js/modules/es.string.blink.js), [`es.string.bold`](/packages/core-js/modules/es.string.bold.js), [`es.string.fixed`](/packages/core-js/modules/es.string.fixed.js), [`es.string.fontcolor`](/packages/core-js/modules/es.string.fontcolor.js), [`es.string.fontsize`](/packages/core-js/modules/es.string.fontsize.js), [`es.string.italics`](/packages/core-js/modules/es.string.italics.js), [`es.string.link`](/packages/core-js/modules/es.string.link.js), [`es.string.small`](/packages/core-js/modules/es.string.small.js), [`es.string.strike`](/packages/core-js/modules/es.string.strike.js), [`es.string.sub`](/packages/core-js/modules/es.string.sub.js), [`es.string.sup`](/packages/core-js/modules/es.string.sup.js), [`es.string.substr`](/packages/core-js/modules/es.string.substr.js), [`es.escape`](/packages/core-js/modules/es.escape.js) and [`es.unescape`](/packages/core-js/modules/es.unescape.js). + +`RegExp` features: modules [`es.regexp.constructor`](/packages/core-js/modules/es.regexp.constructor.js), [`es.regexp.dot-all`](/packages/core-js/modules/es.regexp.dot-all.js), [`es.regexp.flags`](/packages/core-js/modules/es.regexp.flags.js), [`es.regexp.sticky`](/packages/core-js/modules/es.regexp.sticky.js) and [`es.regexp.test`](/packages/core-js/modules/es.regexp.test.js). +```ts +class String { + static fromCodePoint(...codePoints: Array): string; + static raw({ raw: Array }, ...substitutions: Array): string; + at(index: int): string; + includes(searchString: string, position?: number): boolean; + startsWith(searchString: string, position?: number): boolean; + endsWith(searchString: string, position?: number): boolean; + repeat(count: number): string; + padStart(length: number, fillStr?: string = ' '): string; + padEnd(length: number, fillStr?: string = ' '): string; + codePointAt(pos: number): number | void; + match(template: any): any; // ES2015+ fix for support @@match + matchAll(regexp: RegExp): Iterator; + replace(template: any, replacer: any): any; // ES2015+ fix for support @@replace + replaceAll(searchValue: string | RegExp, replaceString: string | (searchValue, index, this) => string): string; + search(template: any): any; // ES2015+ fix for support @@search + split(template: any, limit?: int): Array;; // ES2015+ fix for support @@split, some fixes for old engines + trim(): string; + trimLeft(): string; + trimRight(): string; + trimStart(): string; + trimEnd(): string; + anchor(name: string): string; + big(): string; + blink(): string; + bold(): string; + fixed(): string; + fontcolor(color: string): string; + fontsize(size: any): string; + italics(): string; + link(url: string): string; + small(): string; + strike(): string; + sub(): string; + substr(start: int, length?: int): string; + sup(): string; + @@iterator(): Iterator; +} + +class RegExp { + // support of sticky (`y`) flag, dotAll (`s`) flag, named capture groups, can alter flags + constructor(pattern: RegExp | string, flags?: string): RegExp; + exec(): Array | null; // IE8 fixes + test(string: string): boolean; // delegation to `.exec` + toString(): string; // ES2015+ fix - generic + @@match(string: string): Array | null; + @@matchAll(string: string): Iterator; + @@replace(string: string, replaceValue: Function | string): string; + @@search(string: string): number; + @@split(string: string, limit: number): Array; + readonly attribute dotAll: boolean; // IE9+ + readonly attribute flags: string; // IE9+ + readonly attribute sticky: boolean; // IE9+ +} + +function escape(string: string): string; +function unescape(string: string): string; +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/es|stable|actual|full/string +core-js(-pure)/es|stable|actual|full/string/from-code-point +core-js(-pure)/es|stable|actual|full/string/raw +core-js/es|stable|actual|full/string/match +core-js/es|stable|actual|full/string/replace +core-js/es|stable|actual|full/string/search +core-js/es|stable|actual|full/string/split +core-js(-pure)/es|stable|actual/string(/virtual)/at +core-js(-pure)/es|stable|actual|full/string(/virtual)/code-point-at +core-js(-pure)/es|stable|actual|full/string(/virtual)/ends-with +core-js(-pure)/es|stable|actual|full/string(/virtual)/includes +core-js(-pure)/es|stable|actual|full/string(/virtual)/starts-with +core-js(-pure)/es|stable|actual|full/string(/virtual)/match-all +core-js(-pure)/es|stable|actual|full/string(/virtual)/pad-start +core-js(-pure)/es|stable|actual|full/string(/virtual)/pad-end +core-js(-pure)/es|stable|actual|full/string(/virtual)/repeat +core-js(-pure)/es|stable|actual|full/string(/virtual)/replace-all +core-js(-pure)/es|stable|actual|full/string(/virtual)/trim +core-js(-pure)/es|stable|actual|full/string(/virtual)/trim-start +core-js(-pure)/es|stable|actual|full/string(/virtual)/trim-end +core-js(-pure)/es|stable|actual|full/string(/virtual)/trim-left +core-js(-pure)/es|stable|actual|full/string(/virtual)/trim-right +core-js(-pure)/es|stable|actual|full/string(/virtual)/anchor +core-js(-pure)/es|stable|actual|full/string(/virtual)/big +core-js(-pure)/es|stable|actual|full/string(/virtual)/blink +core-js(-pure)/es|stable|actual|full/string(/virtual)/bold +core-js(-pure)/es|stable|actual|full/string(/virtual)/fixed +core-js(-pure)/es|stable|actual|full/string(/virtual)/fontcolor +core-js(-pure)/es|stable|actual|full/string(/virtual)/fontsize +core-js(-pure)/es|stable|actual|full/string(/virtual)/italics +core-js(-pure)/es|stable|actual|full/string(/virtual)/link +core-js(-pure)/es|stable|actual|full/string(/virtual)/small +core-js(-pure)/es|stable|actual|full/string(/virtual)/strike +core-js(-pure)/es|stable|actual|full/string(/virtual)/sub +core-js(-pure)/es|stable|actual|full/string(/virtual)/substr +core-js(-pure)/es|stable|actual|full/string(/virtual)/sup +core-js(-pure)/es|stable|actual|full/string(/virtual)/iterator +core-js/es|stable|actual|full/regexp +core-js/es|stable|actual|full/regexp/constructor +core-js/es|stable|actual|full/regexp/dot-all +core-js(-pure)/es|stable|actual|full/regexp/flags +core-js/es|stable|actual|full/regexp/sticky +core-js/es|stable|actual|full/regexp/test +core-js/es|stable|actual|full/regexp/to-string +core-js/es|stable|actual|full/escape +core-js/es|stable|actual|full/unescape +``` +[*Examples*](https://is.gd/Q8eRhG): +```js +for (let value of 'a𠮷b') { + console.log(value); // => 'a', '𠮷', 'b' +} + +'foobarbaz'.includes('bar'); // => true +'foobarbaz'.includes('bar', 4); // => false +'foobarbaz'.startsWith('foo'); // => true +'foobarbaz'.startsWith('bar', 3); // => true +'foobarbaz'.endsWith('baz'); // => true +'foobarbaz'.endsWith('bar', 6); // => true + +'string'.repeat(3); // => 'stringstringstring' + +'hello'.padStart(10); // => ' hello' +'hello'.padStart(10, '1234'); // => '12341hello' +'hello'.padEnd(10); // => 'hello ' +'hello'.padEnd(10, '1234'); // => 'hello12341' + +'𠮷'.codePointAt(0); // => 134071 +String.fromCodePoint(97, 134071, 98); // => 'a𠮷b' + +let name = 'Bob'; +String.raw`Hi\n${name}!`; // => 'Hi\\nBob!' (ES2015 template string syntax) +String.raw({ raw: 'test' }, 0, 1, 2); // => 't0e1s2t' + +'foo'.bold(); // => 'foo' +'bar'.anchor('a"b'); // => 'bar' +'baz'.link('https://example.com'); // => 'baz' + +RegExp('.', 's').test('\n'); // => true +RegExp('.', 's').dotAll; // => true + +RegExp('foo:(?\\w+),bar:(?\\w+)').exec('foo:abc,bar:def').groups.bar; // => 'def' + +'foo:abc,bar:def'.replace(RegExp('foo:(?\\w+),bar:(?\\w+)'), '$,$'); // => 'def,abc' + +RegExp(/./g, 'm'); // => /./m + +/foo/.flags; // => '' +/foo/gim.flags; // => 'gim' + +RegExp('foo', 'y').sticky; // => true + +const text = 'First line\nSecond line'; +const regex = RegExp('(\\S+) line\\n?', 'y'); + +regex.exec(text)[1]; // => 'First' +regex.exec(text)[1]; // => 'Second' +regex.exec(text); // => null + +'foo'.match({ [Symbol.match]: () => 1 }); // => 1 +'foo'.replace({ [Symbol.replace]: () => 2 }); // => 2 +'foo'.search({ [Symbol.search]: () => 3 }); // => 3 +'foo'.split({ [Symbol.split]: () => 4 }); // => 4 + +RegExp.prototype.toString.call({ source: 'foo', flags: 'bar' }); // => '/foo/bar' + +' hello '.trimLeft(); // => 'hello ' +' hello '.trimRight(); // => ' hello' +' hello '.trimStart(); // => 'hello ' +' hello '.trimEnd(); // => ' hello' + +for (let [_, d, D] of '1111a2b3cccc'.matchAll(/(\d)(\D)/g)) { + console.log(d, D); // => 1 a, 2 b, 3 c +} + +'Test abc test test abc test.'.replaceAll('abc', 'foo'); // -> 'Test foo test test foo test.' + +'abc'.at(1); // => 'b' +'abc'.at(-1); // => 'c' +``` diff --git a/docs/features/ecmascript/symbol.md b/docs/features/ecmascript/symbol.md new file mode 100644 index 000000000000..2e597f6b53f6 --- /dev/null +++ b/docs/features/ecmascript/symbol.md @@ -0,0 +1,124 @@ +# `Symbol` +Modules [`es.symbol`](/packages/core-js/modules/es.symbol.js), [`es.symbol.async-iterator`](/packages/core-js/modules/es.symbol.async-iterator.js), [`es.symbol.description`](/packages/core-js/modules/es.symbol.description.js), [`es.symbol.has-instance`](/packages/core-js/modules/es.symbol.has-instance.js), [`es.symbol.is-concat-spreadable`](/packages/core-js/modules/es.symbol.is-concat-spreadable.js), [`es.symbol.iterator`](/packages/core-js/modules/es.symbol.iterator.js), [`es.symbol.match`](/packages/core-js/modules/es.symbol.match.js), [`es.symbol.replace`](/packages/core-js/modules/es.symbol.replace.js), [`es.symbol.search`](/packages/core-js/modules/es.symbol.search.js), [`es.symbol.species`](/packages/core-js/modules/es.symbol.species.js), [`es.symbol.split`](/packages/core-js/modules/es.symbol.split.js), [`es.symbol.to-primitive`](/packages/core-js/modules/es.symbol.to-primitive.js), [`es.symbol.to-string-tag`](/packages/core-js/modules/es.symbol.to-string-tag.js), [`es.symbol.unscopables`](/packages/core-js/modules/es.symbol.unscopables.js), [`es.math.to-string-tag`](/packages/core-js/modules/es.math.to-string-tag.js). +```ts +class Symbol { + constructor(description?): symbol; + readonly attribute description: string | void; + static asyncIterator: @@asyncIterator; + static hasInstance: @@hasInstance; + static isConcatSpreadable: @@isConcatSpreadable; + static iterator: @@iterator; + static match: @@match; + static replace: @@replace; + static search: @@search; + static species: @@species; + static split: @@split; + static toPrimitive: @@toPrimitive; + static toStringTag: @@toStringTag; + static unscopables: @@unscopables; + static for(key: string): symbol; + static keyFor(sym: symbol): string; + static useSimple(): void; + static useSetter(): void; +} + +class Object { + static getOwnPropertySymbols(object: any): Array; +} +``` +Also wrapped some methods for correct work with `Symbol` polyfill. +```ts +class Object { + static create(prototype: Object | null, properties?: { [property: PropertyKey]: PropertyDescriptor }): Object; + static defineProperties(object: Object, properties: { [property: PropertyKey]: PropertyDescriptor })): Object; + static defineProperty(object: Object, property: PropertyKey, attributes: PropertyDescriptor): Object; + static getOwnPropertyDescriptor(object: any, property: PropertyKey): PropertyDescriptor | void; + static getOwnPropertyNames(object: any): Array; + propertyIsEnumerable(key: PropertyKey): boolean; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/es|stable|actual|full/symbol +core-js(-pure)/es|stable|actual|full/symbol/async-iterator +core-js/es|stable|actual|full/symbol/description +core-js(-pure)/es|stable|actual|full/symbol/has-instance +core-js(-pure)/es|stable|actual|full/symbol/is-concat-spreadable +core-js(-pure)/es|stable|actual|full/symbol/iterator +core-js(-pure)/es|stable|actual|full/symbol/match +core-js(-pure)/es|stable|actual|full/symbol/replace +core-js(-pure)/es|stable|actual|full/symbol/search +core-js(-pure)/es|stable|actual|full/symbol/species +core-js(-pure)/es|stable|actual|full/symbol/split +core-js(-pure)/es|stable|actual|full/symbol/to-primitive +core-js(-pure)/es|stable|actual|full/symbol/to-string-tag +core-js(-pure)/es|stable|actual|full/symbol/unscopables +core-js(-pure)/es|stable|actual|full/symbol/for +core-js(-pure)/es|stable|actual|full/symbol/key-for +core-js(-pure)/es|stable|actual|full/object/get-own-property-symbols +core-js(-pure)/es|stable|actual|full/math/to-string-tag +``` +[*Basic example*](https://goo.gl/BbvWFc): +```js +let Person = (() => { + let NAME = Symbol('name'); + return class { + constructor(name) { + this[NAME] = name; + } + getName() { + return this[NAME]; + } + } +})(); + +let person = new Person('Vasya'); +console.log(person.getName()); // => 'Vasya' +console.log(person['name']); // => undefined +console.log(person[Symbol('name')]); // => undefined, symbols are uniq +for (let key in person) console.log(key); // => nothing, symbols are not enumerable +``` +`Symbol.for` & `Symbol.keyFor` [*example*](https://goo.gl/0pdJjX): +```js +let symbol = Symbol.for('key'); +symbol === Symbol.for('key'); // true +Symbol.keyFor(symbol); // 'key' +``` +[*Example*](https://goo.gl/mKVOQJ) with methods for getting own object keys: +```js +let object = { a: 1 }; +Object.defineProperty(object, 'b', { value: 2 }); +object[Symbol('c')] = 3; +Object.keys(object); // => ['a'] +Object.getOwnPropertyNames(object); // => ['a', 'b'] +Object.getOwnPropertySymbols(object); // => [Symbol(c)] +Reflect.ownKeys(object); // => ['a', 'b', Symbol(c)] +``` + +[*Symbol#description getter*](https://goo.gl/MWizfc): +```js +Symbol('foo').description; // => 'foo' +Symbol().description; // => undefined +``` +## Caveats when using `Symbol` polyfill: + +* We can't add new primitive type, `Symbol` returns object. +* `Symbol.for` and `Symbol.keyFor` can't be polyfilled cross-realm. +* By default, to hide the keys, `Symbol` polyfill defines setter in `Object.prototype`. For this reason, uncontrolled creation of symbols can cause memory leak and the `in` operator is not working correctly with `Symbol` polyfill: `Symbol() in {} // => true`. + +You can disable defining setters in `Object.prototype`. [Example](https://goo.gl/N5UD7J): +```js +Symbol.useSimple(); +let symbol1 = Symbol('symbol1'); +let object1 = {}; +object1[symbol1] = true; +for (let key in object1) console.log(key); // => 'Symbol(symbol1)_t.qamkg9f3q', w/o native Symbol + +Symbol.useSetter(); +let symbol2 = Symbol('symbol2'); +let object2 = {}; +object2[symbol2] = true; +for (let key in object2) console.log(key); // nothing +``` +* Currently, `core-js` not adds setters to `Object.prototype` for well-known symbols for correct work something like `Symbol.iterator in foo`. It can cause problems with their enumerability. +* Some problems possible with environment exotic objects (for example, IE `localStorage`). diff --git a/docs/features/ecmascript/typed-array.md b/docs/features/ecmascript/typed-array.md new file mode 100644 index 000000000000..0d0fc356d90d --- /dev/null +++ b/docs/features/ecmascript/typed-array.md @@ -0,0 +1,178 @@ +# `TypedArray`s +Implementations and fixes for `ArrayBuffer`, `DataView`, Typed Arrays constructors, static and prototype methods. Typed arrays work only in environments with support descriptors (IE9+), `ArrayBuffer` and `DataView` should work anywhere. + +Modules [`es.array-buffer.constructor`](/packages/core-js/modules/es.array-buffer.constructor.js), [`es.array-buffer.is-view`](/packages/core-js/modules/es.array-buffer.is-view.js), [`es.array-buffer.slice`](/packages/core-js/modules/es.array-buffer.slice.js), [`es.data-view`](/packages/core-js/modules/es.data-view.js), [`es.typed-array.int8-array`](/packages/core-js/modules/es.typed-array.int8-array.js), [`es.typed-array.uint8-array`](/packages/core-js/modules/es.typed-array.uint8-array.js), [`es.typed-array.uint8-clamped-array`](/packages/core-js/modules/es.typed-array.uint8-clamped-array.js), [`es.typed-array.int16-array`](/packages/core-js/modules/es.typed-array.int16-array.js), [`es.typed-array.uint16-array`](/packages/core-js/modules/es.typed-array.uint16-array.js), [`es.typed-array.int32-array`](/packages/core-js/modules/es.typed.int32-array.js), [`es.typed-array.uint32-array`](/packages/core-js/modules/es.typed-array.uint32-array.js), [`es.typed-array.float32-array`](/packages/core-js/modules/es.typed-array.float32-array.js), [`es.typed-array.float64-array`](/packages/core-js/modules/es.typed-array.float64-array.js), [`es.typed-array.copy-within`](/packages/core-js/modules/es.typed-array.copy-within.js), [`es.typed-array.every`](/packages/core-js/modules/es.typed-array.every.js), [`es.typed-array.fill`](/packages/core-js/modules/es.typed-array.fill.js), [`es.typed-array.filter`](/packages/core-js/modules/es.typed-array.filter.js), [`es.typed-array.find`](/packages/core-js/modules/es.typed-array.find.js), [`es.typed-array.find-index`](/packages/core-js/modules/es.typed-array.find-index.js), [`es.typed-array.find-last`](/packages/core-js/modules/es.typed-array.find-last.js), [`es.typed-array.find-last-index`](/packages/core-js/modules/es.typed-array.find-last-index.js), [`es.typed-array.for-each`](/packages/core-js/modules/es.typed-array.for-each.js), [`es.typed-array.from`](/packages/core-js/modules/es.typed-array.from.js), [`es.typed-array.includes`](/packages/core-js/modules/es.typed-array.includes.js), [`es.typed-array.index-of`](/packages/core-js/modules/es.typed-array.index-of.js), [`es.typed-array.iterator`](/packages/core-js/modules/es.typed-array.iterator.js), [`es.typed-array.last-index-of`](/packages/core-js/modules/es.typed-array.last-index-of.js), [`es.typed-array.map`](/packages/core-js/modules/es.typed-array.map.js), [`es.typed-array.of`](/packages/core-js/modules/es.typed-array.of.js), [`es.typed-array.reduce`](/packages/core-js/modules/es.typed-array.reduce.js), [`es.typed-array.reduce-right`](/packages/core-js/modules/es.typed-array.reduce-right.js), [`es.typed-array.reverse`](/packages/core-js/modules/es.typed-array.reverse.js), [`es.typed-array.set`](/packages/core-js/modules/es.typed-array.set.js), [`es.typed-array.slice`](/packages/core-js/modules/es.typed-array.slice.js), [`es.typed-array.some`](/packages/core-js/modules/es.typed-array.some.js), [`es.typed-array.sort`](/packages/core-js/modules/es.typed-array.sort.js), [`es.typed-array.subarray`](/packages/core-js/modules/es.typed-array.subarray.js), [`es.typed-array.to-locale-string`](/packages/core-js/modules/es.typed-array.to-locale-string.js), [`es.typed-array.to-string`](/packages/core-js/modules/es.typed-array.to-string.js), [`es.typed-array.at`](/packages/core-js/modules/es.typed-array.at.js). +```ts +class ArrayBuffer { + constructor(length: any): ArrayBuffer; + slice(start: any, end: any): ArrayBuffer; + readonly attribute byteLength: number; + static isView(arg: any): boolean; +} + +class DataView { + constructor(buffer: ArrayBuffer, byteOffset?: number, byteLength?: number): DataView; + getInt8(offset: any): int8; + getUint8(offset: any): uint8 + getInt16(offset: any, littleEndian?: boolean = false): int16; + getUint16(offset: any, littleEndian?: boolean = false): uint16; + getInt32(offset: any, littleEndian?: boolean = false): int32; + getUint32(offset: any, littleEndian?: boolean = false): uint32; + getFloat32(offset: any, littleEndian?: boolean = false): float32; + getFloat64(offset: any, littleEndian?: boolean = false): float64; + setInt8(offset: any, value: any): void; + setUint8(offset: any, value: any): void; + setInt16(offset: any, value: any, littleEndian?: boolean = false): void; + setUint16(offset: any, value: any, littleEndian?: boolean = false): void; + setInt32(offset: any, value: any, littleEndian?: boolean = false): void; + setUint32(offset: any, value: any, littleEndian?: boolean = false): void; + setFloat32(offset: any, value: any, littleEndian?: boolean = false): void; + setFloat64(offset: any, value: any, littleEndian?: boolean = false): void; + readonly attribute buffer: ArrayBuffer; + readonly attribute byteLength: number; + readonly attribute byteOffset: number; +} + +class [ + Int8Array, + Uint8Array, + Uint8ClampedArray, + Int16Array, + Uint16Array, + Int32Array, + Uint32Array, + Float32Array, + Float64Array, +] extends %TypedArray% { + constructor(length: number): %TypedArray%; + constructor(object: %TypedArray% | Iterable | ArrayLike): %TypedArray%; + constructor(buffer: ArrayBuffer, byteOffset?: number, length?: number): %TypedArray% +} + +class %TypedArray% { + at(index: int): number; + copyWithin(target: number, start: number, end?: number): this; + every(callbackfn: (value: number, index: number, target: %TypedArray%) => boolean, thisArg?: any): boolean; + fill(value: number, start?: number, end?: number): this; + filter(callbackfn: (value: number, index: number, target: %TypedArray%) => boolean, thisArg?: any): %TypedArray%; + find(callbackfn: (value: number, index: number, target: %TypedArray%) => boolean), thisArg?: any): any; + findIndex(callbackfn: (value: number, index: number, target: %TypedArray%) => boolean, thisArg?: any): uint; + findLast(callbackfn: (value: any, index: number, target: %TypedArray%) => boolean, thisArg?: any): any; + findLastIndex(callbackfn: (value: any, index: number, target: %TypedArray%) => boolean, thisArg?: any): uint; + forEach(callbackfn: (value: number, index: number, target: %TypedArray%) => void, thisArg?: any): void; + includes(searchElement: any, from?: number): boolean; + indexOf(searchElement: any, from?: number): number; + join(separator: string = ','): string; + lastIndexOf(searchElement: any, from?: number): number; + map(mapFn: (value: number, index: number, target: %TypedArray%) => number, thisArg?: any): %TypedArray%; + reduce(callbackfn: (memo: any, value: number, index: number, target: %TypedArray%) => any, initialValue?: any): any; + reduceRight(callbackfn: (memo: any, value: number, index: number, target: %TypedArray%) => any, initialValue?: any): any; + reverse(): this; + set(array: ArrayLike, offset?: number): void; + slice(start?: number, end?: number): %TypedArray%; + some(callbackfn: (value: number, index: number, target: %TypedArray%) => boolean, thisArg?: any): boolean; + sort(comparefn?: (a: number, b: number) => number): this; // with modern behavior like stable sort + subarray(begin?: number, end?: number): %TypedArray%; + toString(): string; + toLocaleString(): string; + values(): Iterator; + keys(): Iterator; + entries(): Iterator<[index, value]>; + @@iterator(): Iterator; + readonly attribute buffer: ArrayBuffer; + readonly attribute byteLength: number; + readonly attribute byteOffset: number; + readonly attribute length: number; + BYTES_PER_ELEMENT: number; + static from(items: Iterable | ArrayLike, mapFn?: (value: any, index: number) => any, thisArg?: any): %TypedArray%; + static of(...args: Array): %TypedArray%; + static BYTES_PER_ELEMENT: number; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/es|stable|actual|full/array-buffer +core-js/es|stable|actual|full/array-buffer/constructor +core-js/es|stable|actual|full/array-buffer/is-view +core-js/es|stable|actual|full/array-buffer/slice +core-js/es|stable|actual|full/data-view +core-js/es|stable|actual|full/typed-array +core-js/es|stable|actual|full/typed-array/int8-array +core-js/es|stable|actual|full/typed-array/uint8-array +core-js/es|stable|actual|full/typed-array/uint8-clamped-array +core-js/es|stable|actual|full/typed-array/int16-array +core-js/es|stable|actual|full/typed-array/uint16-array +core-js/es|stable|actual|full/typed-array/int32-array +core-js/es|stable|actual|full/typed-array/uint32-array +core-js/es|stable|actual|full/typed-array/float32-array +core-js/es|stable|actual|full/typed-array/float64-array +core-js/es|stable|actual|full/typed-array/at +core-js/es|stable|actual|full/typed-array/copy-within +core-js/es|stable|actual|full/typed-array/entries +core-js/es|stable|actual|full/typed-array/every +core-js/es|stable|actual|full/typed-array/fill +core-js/es|stable|actual|full/typed-array/filter +core-js/es|stable|actual|full/typed-array/find +core-js/es|stable|actual|full/typed-array/find-index +core-js/es|stable|actual|full/typed-array/find-last +core-js/es|stable|actual|full/typed-array/find-last-index +core-js/es|stable|actual|full/typed-array/for-each +core-js/es|stable|actual|full/typed-array/from +core-js/es|stable|actual|full/typed-array/includes +core-js/es|stable|actual|full/typed-array/index-of +core-js/es|stable|actual|full/typed-array/iterator +core-js/es|stable|actual|full/typed-array/join +core-js/es|stable|actual|full/typed-array/keys +core-js/es|stable|actual|full/typed-array/last-index-of +core-js/es|stable|actual|full/typed-array/map +core-js/es|stable|actual|full/typed-array/of +core-js/es|stable|actual|full/typed-array/reduce +core-js/es|stable|actual|full/typed-array/reduce-right +core-js/es|stable|actual|full/typed-array/reverse +core-js/es|stable|actual|full/typed-array/set +core-js/es|stable|actual|full/typed-array/slice +core-js/es|stable|actual|full/typed-array/some +core-js/es|stable|actual|full/typed-array/sort +core-js/es|stable|actual|full/typed-array/subarray +core-js/es|stable|actual|full/typed-array/to-locale-string +core-js/es|stable|actual|full/typed-array/to-string +core-js/es|stable|actual|full/typed-array/values +``` +[*Examples*](https://is.gd/Eo7ltU): +```js +new Int32Array(4); // => [0, 0, 0, 0] +new Uint8ClampedArray([1, 2, 3, 666]); // => [1, 2, 3, 255] +new Float32Array(new Set([1, 2, 3, 2, 1])); // => [1, 2, 3] + +let buffer = new ArrayBuffer(8); +let view = new DataView(buffer); +view.setFloat64(0, 123.456, true); +new Uint8Array(buffer.slice(4)); // => [47, 221, 94, 64] + +Int8Array.of(1, 1.5, 5.7, 745); // => [1, 1, 5, -23] +Uint8Array.from([1, 1.5, 5.7, 745]); // => [1, 1, 5, 233] + +let typed = new Uint8Array([1, 2, 3]); + +let a = typed.slice(1); // => [2, 3] +typed.buffer === a.buffer; // => false +let b = typed.subarray(1); // => [2, 3] +typed.buffer === b.buffer; // => true + +typed.filter(it => it % 2); // => [1, 3] +typed.map(it => it * 1.5); // => [1, 3, 4] + +for (let value of typed) console.log(value); // => 1, 2, 3 +for (let value of typed.values()) console.log(value); // => 1, 2, 3 +for (let key of typed.keys()) console.log(key); // => 0, 1, 2 +for (let [key, value] of typed.entries()) { + console.log(key); // => 0, 1, 2 + console.log(value); // => 1, 2, 3 +} + +new Int32Array([1, 2, 3]).at(1); // => 2 +new Int32Array([1, 2, 3]).at(-1); // => 3 +``` + +## Caveats when using typed arrays polyfills: +* Polyfills of Typed Arrays constructors work completely how should work by the spec, but because of internal usage of getters / setters on each instance, are slow and consumes significant memory. However, polyfills of Typed Arrays constructors required mainly for old IE, all modern engines have native Typed Arrays constructors and require only fixes of constructors and polyfills of methods. diff --git a/docs/features/iteration-helpers.md b/docs/features/iteration-helpers.md new file mode 100644 index 000000000000..df3fc7e455fd --- /dev/null +++ b/docs/features/iteration-helpers.md @@ -0,0 +1,43 @@ +# Iter-helpers +Helpers for check iterability / get iterator in the `pure` version or, for example, for `arguments` object: +```ts +function isIterable(value: any): boolean; +function getIterator(value: any): Object; +function getIteratorMethod(value: any): Function | void; +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js-pure/es|stable|actual|full/is-iterable +core-js-pure/es|stable|actual|full/get-iterator +core-js-pure/es|stable|actual|full/get-iterator-method +``` +[*Examples*](https://goo.gl/SXsM6D): +```js +import isIterable from 'core-js-pure/actual/is-iterable'; +import getIterator from 'core-js-pure/actual/get-iterator'; +import getIteratorMethod from 'core-js-pure/actual/get-iterator-method'; + +let list = (function () { + return arguments; +})(1, 2, 3); + +console.log(isIterable(list)); // true; + +let iterator = getIterator(list); +console.log(iterator.next().value); // 1 +console.log(iterator.next().value); // 2 +console.log(iterator.next().value); // 3 +console.log(iterator.next().value); // undefined + +getIterator({}); // TypeError: [object Object] is not iterable! + +let method = getIteratorMethod(list); +console.log(typeof method); // 'function' +let iterator = method.call(list); +console.log(iterator.next().value); // 1 +console.log(iterator.next().value); // 2 +console.log(iterator.next().value); // 3 +console.log(iterator.next().value); // undefined + +console.log(getIteratorMethod({})); // undefined +``` diff --git a/docs/features/proposals/README.md b/docs/features/proposals/README.md new file mode 100644 index 000000000000..9c45274014e9 --- /dev/null +++ b/docs/features/proposals/README.md @@ -0,0 +1,94 @@ +# ES Proposals +[The TC39 process.](https://tc39.github.io/process-document/) + +# Index +- [Finished](#finished) +- [Stage 3](#stage-3) +- [Stage 2](#stage-2) +- [Stage 1](#stage-1) +- [Stage 0](#stage-0) +- [Pre-stage 0](#pre-stage-0) + +## Finished[⬆](#index) +Finished (stage 4) proposals already marked in `core-js` as stable ECMAScript, they are available in `core-js/stable` and `core-js/es` namespace, you can find then in related sections of this doc. However, even for finished proposals, `core-js` provide a way to include only features for a specific proposal like `core-js/proposals/proposal-name`. +### [`globalThis`](global-this.md) +### [Relative indexing method](relative-indexing-method.md) +### [`Array.prototype.includes`](array-includes.md) +### [`Array.prototype.flat` / `Array.prototype.flatMap`](array-flat-map.md) +### [`Array` find from last](array-find-from-last.md) +### [`Object.values` / `Object.entries`](object-values-entries.md) +### [`Object.fromEntries`](object-from-entries.md) +### [`Object.getOwnPropertyDescriptors`](object-getownpropertydescriptors.md) +### [Accessible `Object.prototype.hasOwnProperty`](accessible-object-hasownproperty.md) +### [`String` padding](string-padding.md) +### [`String.prototype.matchAll`](string-match-all.md) +### [`String.prototype.replaceAll`](string-replace-all.md) +### [`String.prototype.trimStart` / `String.prototype.trimEnd`](string-left-right-trim.md) +### [`RegExp` `s` (`dotAll`) flag](regexp-dotall-flag.md) +### [`RegExp` named capture groups](regexp-named-groups.md) +### [`Promise.allSettled`](promise-all-settled.md) +### [`Promise.any`](promise-any.md) +### [`Promise.prototype.finally`](promise-finally.md) +### [`Symbol.asyncIterator` for asynchronous iteration](async-iteration.md) +### [`Symbol.prototype.description`](symbol-description.md) +### [Well-formed `JSON.stringify`](well-formed-stringify.md) + +## Stage 3[⬆](#index) +`core-js/stage/3` entry point contains only stage 3 proposals, `core-js/stage/2` - stage 2 and stage 3, etc. + +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/stage/3 +``` +### [`Array` grouping](array-grouping.md) +### [Change `Array` by copy](change-array-by-copy.md) + +## Stage 2[⬆](#index) +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/stage/2 +``` +### [`Iterator` helpers](iterator-helpers.md) +### [New `Set` methods](set-methods.md) +### [`Map.prototype.emplace`](map-upsert.md) +### [`Array.fromAsync`](array-from-async.md) +### [`Array.isTemplateObject`](array-is-template-object.md) +### [`Symbol.{ asyncDispose, dispose }` for `using` statement](using-statement.md) +### [`Symbol.metadataKey` for decorators metadata proposal](decorator-metadata.md) + +## Stage 1[⬆](#index) +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/stage/1 +``` +### [`Observable`](observable.md) +### [New collections methods](collection-methods.md) +### [`.of` and `.from` methods on collection constructors](collection-of-from.md) +### [`compositeKey` and `compositeSymbol`](keys-composition.md) +### [`Array` filtering](array-filtering.md) +### [`Array` deduplication](array-unique.md) +### [Getting last item from `Array`](array-find-from-last.md) +### [`Number.range`](number-range.md) +### [`Number.fromString`](number-from-string.md) +### [`Math` extensions](math-extensions.md) +### [`Math.signbit`](math-signbit.md) +### [`String.cooked`](string-cooked.md) +### [`String.prototype.codePoints`](string-code-points.md) +### [`Symbol.matcher` for pattern matching](pattern-matching.md) +### [Seeded pseudo-random numbers](seeded-random.md) + +## Stage 0[⬆](#index) +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/stage/0 +``` +### [`Function.prototype.unThis`](function-un-this.md) +### [`Function.{ isCallable, isConstructor }`](function-is-callable-is-constructor.md) +### [`URL`](url.md) + +## Pre-stage 0[⬆](#index) +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/stage/pre +``` +### [`Reflect` metadata](reflect-metadata.md) diff --git a/docs/features/proposals/accessible-object-hasownproperty.md b/docs/features/proposals/accessible-object-hasownproperty.md new file mode 100644 index 000000000000..72ec25e5d740 --- /dev/null +++ b/docs/features/proposals/accessible-object-hasownproperty.md @@ -0,0 +1,10 @@ +# [Accessible `Object.prototype.hasOwnProperty`](https://github.com/tc39/proposal-accessible-object-hasownproperty) +```ts +class Object { + static hasOwn(object: object, key: PropertyKey): boolean; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/accessible-object-hasownproperty +``` diff --git a/docs/features/proposals/array-filtering.md b/docs/features/proposals/array-filtering.md new file mode 100644 index 000000000000..8c3831f84796 --- /dev/null +++ b/docs/features/proposals/array-filtering.md @@ -0,0 +1,21 @@ +# [Array filtering](https://github.com/tc39/proposal-array-filtering) +Modules [`esnext.array.filter-reject`](/packages/core-js/modules/esnext.array.filter-reject.js) and [`esnext.typed-array.filter-reject`](/packages/core-js/modules/esnext.typed-array.filter-reject.js). +```ts +class Array { + filterReject(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): Array; +} + +class %TypedArray% { + filterReject(callbackfn: (value: number, index: number, target: %TypedArray%) => boolean, thisArg?: any): %TypedArray%; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/array-filtering-stage-1 +core-js(-pure)/full/array(/virtual)/filter-reject +core-js/full/typed-array/filter-reject +``` +[*Examples*](https://is.gd/jJcoWw): +```js +[1, 2, 3, 4, 5].filterReject(it => it % 2); // => [2, 4] +``` diff --git a/docs/features/proposals/array-find-from-last.md b/docs/features/proposals/array-find-from-last.md new file mode 100644 index 000000000000..5870d42802c2 --- /dev/null +++ b/docs/features/proposals/array-find-from-last.md @@ -0,0 +1,16 @@ +# [Array find from last](https://github.com/tc39/proposal-array-find-from-last) +```ts +class Array { + findLast(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): any; + findLastIndex(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): uint; +} + +class %TypedArray% { + findLast(callbackfn: (value: any, index: number, target: %TypedArray%) => boolean, thisArg?: any): any; + findLastIndex(callbackfn: (value: any, index: number, target: %TypedArray%) => boolean, thisArg?: any): uint; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/array-find-from-last +``` diff --git a/docs/features/proposals/array-flat-map.md b/docs/features/proposals/array-flat-map.md new file mode 100644 index 000000000000..8e559e079a57 --- /dev/null +++ b/docs/features/proposals/array-flat-map.md @@ -0,0 +1,11 @@ +# [`Array.prototype.flat` & `Array.prototype.flatMap`](https://github.com/tc39/proposal-flatMap) +```ts +class Array { + flat(depthArg?: number = 1): Array; + flatMap(mapFn: (value: any, index: number, target: any) => any, thisArg: any): Array; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/array-flat-map +``` diff --git a/docs/features/proposals/array-from-async.md b/docs/features/proposals/array-from-async.md new file mode 100644 index 000000000000..09f5beea9aaf --- /dev/null +++ b/docs/features/proposals/array-from-async.md @@ -0,0 +1,16 @@ +# [`Array.fromAsync`](https://github.com/tc39/proposal-array-from-async) +Modules [`esnext.array.from-async`](/packages/core-js/modules/esnext.array.from-async.js). +```ts +class Array { + static fromAsync(asyncItems: AsyncIterable | Iterable | ArrayLike, mapfn?: (value: any, index: number) => any, thisArg?: any): Array; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/array-from-async-stage-2 +core-js(-pure)/full/array/from-async +``` +[*Example*](https://goo.gl/Jt7SsD): +```js +await Array.fromAsync((async function * (){ yield * [1, 2, 3] })(), i => i * i); // => [1, 4, 9] +``` diff --git a/docs/features/proposals/array-grouping.md b/docs/features/proposals/array-grouping.md new file mode 100644 index 000000000000..d927d2264011 --- /dev/null +++ b/docs/features/proposals/array-grouping.md @@ -0,0 +1,22 @@ +# [`Array` grouping](https://github.com/tc39/proposal-array-grouping) +Modules [`esnext.array.group`](/packages/core-js/modules/esnext.array.group.js), [`esnext.array.group-to-map`](/packages/core-js/modules/esnext.array.group-to-map.js). +```ts +class Array { + group(callbackfn: (value: any, index: number, target: any) => key, thisArg?: any): { [key]: Array }; + groupToMap(callbackfn: (value: any, index: number, target: any) => key, thisArg?: any): Map>; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/array-grouping-stage-3-2 +core-js(-pure)/actual|full/array(/virtual)/group +core-js(-pure)/actual|full/array(/virtual)/group-to-map +``` +[*Examples*](https://is.gd/3a0PbH): +```js +[1, 2, 3, 4, 5].group(it => it % 2); // => { 1: [1, 3, 5], 0: [2, 4] } + +const map = [1, 2, 3, 4, 5].groupToMap(it => it % 2); +map.get(1); // => [1, 3, 5] +map.get(0); // => [2, 4] +``` diff --git a/docs/features/proposals/array-includes.md b/docs/features/proposals/array-includes.md new file mode 100644 index 000000000000..27d90fe0a7fa --- /dev/null +++ b/docs/features/proposals/array-includes.md @@ -0,0 +1,14 @@ +# [`Array.prototype.includes`](https://github.com/tc39/proposal-Array.prototype.includes) +```ts +class Array { + includes(searchElement: any, from?: number): boolean; +} + +class %TypedArray% { + includes(searchElement: any, from?: number): boolean; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/array-includes +``` diff --git a/docs/features/proposals/array-is-template-object.md b/docs/features/proposals/array-is-template-object.md new file mode 100644 index 000000000000..82ec9db22c90 --- /dev/null +++ b/docs/features/proposals/array-is-template-object.md @@ -0,0 +1,16 @@ +# [`Array.isTemplateObject`](https://github.com/tc39/proposal-array-is-template-object) +Module [`esnext.array.is-template-object`](/packages/core-js/modules/esnext.array.is-template-object.js) +```ts +class Array { + static isTemplateObject(value: any): boolean +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/array-is-template-object +core-js(-pure)/full/array/is-template-object +``` +*Example*: +```js +console.log(Array.isTemplateObject((it => it)`qwe${ 123 }asd`)); // => true +``` diff --git a/docs/features/proposals/array-last.md b/docs/features/proposals/array-last.md new file mode 100644 index 000000000000..4438af6ea44b --- /dev/null +++ b/docs/features/proposals/array-last.md @@ -0,0 +1,24 @@ +# [Getting last item from `Array`](https://github.com/keithamus/proposal-array-last) +Modules [`esnext.array.last-item`](/packages/core-js/modules/esnext.array.last-item.js) and [`esnext.array.last-index`](/packages/core-js/modules/esnext.array.last-index.js) +```ts +class Array { + attribute lastItem: any; + readonly attribute lastIndex: uint; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/array-last +core-js/full/array/last-item +core-js/full/array/last-index +``` +[*Examples*](https://goo.gl/2TmcMT): +```js +[1, 2, 3].lastItem; // => 3 +[1, 2, 3].lastIndex; // => 2 + +const array = [1, 2, 3]; +array.lastItem = 4; + +array; // => [1, 2, 4] +``` diff --git a/docs/features/proposals/array-unique.md b/docs/features/proposals/array-unique.md new file mode 100644 index 000000000000..29a598f6d069 --- /dev/null +++ b/docs/features/proposals/array-unique.md @@ -0,0 +1,27 @@ +# [`Array` deduplication](https://github.com/tc39/proposal-array-unique) +Modules [`esnext.array.unique-by`](/packages/core-js/modules/esnext.array.unique-by.js) and [`esnext.typed-array.unique-by`](/packages/core-js/modules/esnext.typed-array.unique-by.js) +```ts +class Array { + uniqueBy(resolver?: (item: any) => any): Array; +} + +class %TypedArray% { + uniqueBy(resolver?: (item: any) => any): %TypedArray%;; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/array-unique +core-js(-pure)/full/array(/virtual)/unique-by +core-js/full/typed-array/unique-by +``` +[*Examples*](https://is.gd/lilNPu): +```js +[1, 2, 3, 2, 1].uniqueBy(); // [1, 2, 3] + +[ + { id: 1, uid: 10000 }, + { id: 2, uid: 10000 }, + { id: 3, uid: 10001 } +].uniqueBy(it => it.id); // => [{ id: 1, uid: 10000 }, { id: 3, uid: 10001 }] +``` diff --git a/docs/features/proposals/async-iteration.md b/docs/features/proposals/async-iteration.md new file mode 100644 index 000000000000..d812d2c57eda --- /dev/null +++ b/docs/features/proposals/async-iteration.md @@ -0,0 +1,10 @@ +# [`Symbol.asyncIterator` for asynchronous iteration](https://github.com/tc39/proposal-async-iteration) +```ts +class Symbol { + static asyncIterator: @@asyncIterator; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/async-iteration +``` diff --git a/docs/features/proposals/change-array-by-copy.md b/docs/features/proposals/change-array-by-copy.md new file mode 100644 index 000000000000..9292253dd184 --- /dev/null +++ b/docs/features/proposals/change-array-by-copy.md @@ -0,0 +1,45 @@ +# [Change `Array` by copy](https://github.com/tc39/proposal-change-array-by-copy) +Modules [`esnext.array.to-reversed`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.to-reversed.js), [`esnext.array.to-sorted`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.to-sorted.js), [`esnext.array.to-spliced`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.to-spliced.js), [`esnext.array.with`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.with.js), [`esnext.typed-array.to-reversed`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.typed-array.to-reversed.js), [`esnext.typed-array.to-sorted`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.typed-array.to-sorted.js), [`esnext.typed-array.with`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.typed-array.with.js). +```ts +class Array { + toReversed(): Array; + toSpliced(start?: number, deleteCount?: number, ...items: Array): Array; + toSorted(comparefn?: (a: any, b: any) => number): Array; + with(index: includes, value: any): Array; +} + +class %TypedArray% { + toReversed(): %TypedArray%; + toSorted(comparefn?: (a: any, b: any) => number): %TypedArray%; + with(index: includes, value: any): %TypedArray%; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/change-array-by-copy +core-js(-pure)/actual|full/array(/virtual)/to-reversed +core-js(-pure)/actual|full/array(/virtual)/to-sorted +core-js(-pure)/actual|full/array(/virtual)/to-spliced +core-js(-pure)/actual|full/array(/virtual)/with +core-js/actual|full/typed-array/to-reversed +core-js/actual|full/typed-array/to-sorted +core-js/actual|full/typed-array/with +``` +[*Examples*](https://is.gd/tVkbY3): +```js +const sequence = [1, 2, 3]; +sequence.toReversed(); // => [3, 2, 1] +sequence; // => [1, 2, 3] + +const array = [1, 2, 3, 4]; +array.toSpliced(1, 2, 5, 6, 7); // => [1, 5, 6, 7, 4] +array; // => [1, 2, 3, 4] + +const outOfOrder = [3, 1, 2]; +outOfOrder.toSorted(); // => [1, 2, 3] +outOfOrder; // => [3, 1, 2] + +const correctionNeeded = [1, 1, 3]; +correctionNeeded.with(1, 2); // => [1, 2, 3] +correctionNeeded; // => [1, 1, 3] +``` diff --git a/docs/features/proposals/collection-methods.md b/docs/features/proposals/collection-methods.md new file mode 100644 index 000000000000..386ae6214f1e --- /dev/null +++ b/docs/features/proposals/collection-methods.md @@ -0,0 +1,97 @@ +# [New collections methods](https://github.com/tc39/proposal-collection-methods) +Modules [`esnext.set.add-all`](/packages/core-js/modules/esnext.set.add-all.js), [`esnext.set.delete-all`](/packages/core-js/modules/esnext.set.delete-all.js), [`esnext.set.every`](/packages/core-js/modules/esnext.set.every.js), [`esnext.set.filter`](/packages/core-js/modules/esnext.set.filter.js), +[`esnext.set.find`](/packages/core-js/modules/esnext.set.find.js), [`esnext.set.join`](/packages/core-js/modules/esnext.set.join.js), [`esnext.set.map`](/packages/core-js/modules/esnext.set.map.js), [`esnext.set.reduce`](/packages/core-js/modules/esnext.set.reduce.js), [`esnext.set.some`](/packages/core-js/modules/esnext.set.some.js), [`esnext.map.delete-all`](/packages/core-js/modules/esnext.map.delete-all.js), [`esnext.map.every`](/packages/core-js/modules/esnext.map.every.js), [`esnext.map.filter`](/packages/core-js/modules/esnext.map.filter.js), [`esnext.map.find`](/packages/core-js/modules/esnext.map.find.js), [`esnext.map.find-key`](/packages/core-js/modules/esnext.map.find-key.js), [`esnext.map.group-by`](/packages/core-js/modules/esnext.map.group-by.js), [`esnext.map.includes`](/packages/core-js/modules/esnext.map.includes.js), [`esnext.map.key-by`](/packages/core-js/modules/esnext.map.key-by.js), [`esnext.map.key-of`](/packages/core-js/modules/esnext.map.key-of.js), [`esnext.map.map-keys`](/packages/core-js/modules/esnext.map.map-keys.js), [`esnext.map.map-values`](/packages/core-js/modules/esnext.map.map-values.js), [`esnext.map.merge`](/packages/core-js/modules/esnext.map.merge.js), [`esnext.map.reduce`](/packages/core-js/modules/esnext.map.reduce.js), [`esnext.map.some`](/packages/core-js/modules/esnext.map.some.js), [`esnext.map.update`](/packages/core-js/modules/esnext.map.update.js), [`esnext.weak-set.add-all`](/packages/core-js/modules/esnext.weak-set.add-all.js), [`esnext.weak-set.delete-all`](/packages/core-js/modules/esnext.weak-set.delete-all.js), [`esnext.weak-map.delete-all`](/packages/core-js/modules/esnext.weak-map.delete-all.js), [`esnext.set.of`](/packages/core-js/modules/esnext.set.of.js), [`esnext.set.from`](/packages/core-js/modules/esnext.set.from.js), [`esnext.map.of`](/packages/core-js/modules/esnext.map.of.js), [`esnext.map.from`](/packages/core-js/modules/esnext.map.from.js), [`esnext.weak-set.of`](/packages/core-js/modules/esnext.weak-set.of.js), [`esnext.weak-set.from`](/packages/core-js/modules/esnext.weak-set.from.js), [`esnext.weak-map.of`](/packages/core-js/modules/esnext.weak-map.of.js), [`esnext.weak-map.from`](/packages/core-js/modules/esnext.weak-map.from.js) +```ts +class Set { + static of(...args: Array): Set; + static from(iterable: Iterable, mapFn?: (value: any, index: number) => any, thisArg?: any): Set; + addAll(...args: Array): this; + deleteAll(...args: Array): boolean; + every(callbackfn: (value: any, key: any, target: any) => boolean, thisArg?: any): boolean; + filter(callbackfn: (value: any, key: any, target: any) => boolean, thisArg?: any): Set; + find(callbackfn: (value: any, key: any, target: any) => boolean), thisArg?: any): any; + join(separator: string = ','): string; + map(callbackfn: (value: any, key: any, target: any) => any, thisArg?: any): Set; + reduce(callbackfn: (memo: any, value: any, key: any, target: any) => any, initialValue?: any): any; + some(callbackfn: (value: any, key: any, target: any) => boolean, thisArg?: any): boolean; +} + +class Map { + static groupBy(iterable: Iterable, callbackfn?: (value: any) => any): Map; + static of(...args: Array<[key, value]>): Map; + static from(iterable: Iterable, mapFn?: (value: any, index: number) => [key: any, value: any], thisArg?: any): Map; + static keyBy(iterable: Iterable, callbackfn?: (value: any) => any): Map; + deleteAll(...args: Array): boolean; + every(callbackfn: (value: any, key: any, target: any) => boolean, thisArg?: any): boolean; + filter(callbackfn: (value: any, key: any, target: any) => boolean, thisArg?: any): Map; + find(callbackfn: (value: any, key: any, target: any) => boolean), thisArg?: any): any; + findKey(callbackfn: (value: any, key: any, target: any) => boolean), thisArg?: any): any; + includes(searchElement: any): boolean; + keyOf(searchElement: any): any; + mapKeys(mapFn: (value: any, index: number, target: any) => any, thisArg?: any): Map; + mapValues(mapFn: (value: any, index: number, target: any) => any, thisArg?: any): Map; + merge(...iterables: Array): this; + reduce(callbackfn: (memo: any, value: any, key: any, target: any) => any, initialValue?: any): any; + some(callbackfn: (value: any, key: any, target: any) => boolean, thisArg?: any): boolean; + update(key: any, callbackfn: (value: any, key: any, target: any) => any, thunk?: (key: any, target: any) => any): this; +} + +class WeakSet { + static of(...args: Array): WeakSet; + static from(iterable: Iterable, mapFn?: (value: any, index: number) => Object, thisArg?: any): WeakSet; + addAll(...args: Array): this; + deleteAll(...args: Array): boolean; +} + +class WeakMap { + static of(...args: Array<[key, value]>): WeakMap; + static from(iterable: Iterable, mapFn?: (value: any, index: number) => [key: Object, value: any], thisArg?: any): WeakMap; + deleteAll(...args: Array): boolean; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/collection-methods +core-js/proposals/collection-of-from +core-js(-pure)/full/set/add-all +core-js(-pure)/full/set/delete-all +core-js(-pure)/full/set/every +core-js(-pure)/full/set/filter +core-js(-pure)/full/set/find +core-js(-pure)/full/set/from +core-js(-pure)/full/set/join +core-js(-pure)/full/set/map +core-js(-pure)/full/set/of +core-js(-pure)/full/set/reduce +core-js(-pure)/full/set/some +core-js(-pure)/full/map/delete-all +core-js(-pure)/full/map/every +core-js(-pure)/full/map/filter +core-js(-pure)/full/map/find +core-js(-pure)/full/map/find-key +core-js(-pure)/full/map/from +core-js(-pure)/full/map/group-by +core-js(-pure)/full/map/includes +core-js(-pure)/full/map/key-by +core-js(-pure)/full/map/key-of +core-js(-pure)/full/map/map-keys +core-js(-pure)/full/map/map-values +core-js(-pure)/full/map/merge +core-js(-pure)/full/map/of +core-js(-pure)/full/map/reduce +core-js(-pure)/full/map/some +core-js(-pure)/full/map/update +core-js(-pure)/full/weak-set/add-all +core-js(-pure)/full/weak-set/delete-all +core-js(-pure)/full/weak-set/of +core-js(-pure)/full/weak-set/from +core-js(-pure)/full/weak-map/delete-all +core-js(-pure)/full/weak-map/of +core-js(-pure)/full/weak-map/from +``` +`.of` / `.from` [*examples*](https://goo.gl/mSC7eU): +```js +Set.of(1, 2, 3, 2, 1); // => Set {1, 2, 3} + +Map.from([[1, 2], [3, 4]], ([key, value]) => [key ** 2, value ** 2]); // => Map { 1: 4, 9: 16 } +``` \ No newline at end of file diff --git a/docs/features/proposals/collection-of-from.md b/docs/features/proposals/collection-of-from.md new file mode 100644 index 000000000000..a9bc019e9d69 --- /dev/null +++ b/docs/features/proposals/collection-of-from.md @@ -0,0 +1,42 @@ +# [`.of` and `.from` methods on collection constructors](https://github.com/tc39/proposal-setmap-offrom) +Modules [`esnext.set.of`](/packages/core-js/modules/esnext.set.of.js), [`esnext.set.from`](/packages/core-js/modules/esnext.set.from.js), [`esnext.map.of`](/packages/core-js/modules/esnext.map.of.js), [`esnext.map.from`](/packages/core-js/modules/esnext.map.from.js), [`esnext.weak-set.of`](/packages/core-js/modules/esnext.weak-set.of.js), [`esnext.weak-set.from`](/packages/core-js/modules/esnext.weak-set.from.js), [`esnext.weak-map.of`](/packages/core-js/modules/esnext.weak-map.of.js), [`esnext.weak-map.from`](/packages/core-js/modules/esnext.weak-map.from.js) +```ts +class Set { + static of(...args: Array): Set; + static from(iterable: Iterable, mapFn?: (value: any, index: number) => any, thisArg?: any): Set; +} + +class Map { + static of(...args: Array<[key, value]>): Map; + static from(iterable: Iterable, mapFn?: (value: any, index: number) => [key: any, value: any], thisArg?: any): Map; +} + +class WeakSet { + static of(...args: Array): WeakSet; + static from(iterable: Iterable, mapFn?: (value: any, index: number) => Object, thisArg?: any): WeakSet; +} + +class WeakMap { + static of(...args: Array<[key, value]>): WeakMap; + static from(iterable: Iterable, mapFn?: (value: any, index: number) => [key: Object, value: any], thisArg?: any): WeakMap; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/collection-methods +core-js/proposals/collection-of-from +core-js(-pure)/full/set/from +core-js(-pure)/full/set/of +core-js(-pure)/full/map/from +core-js(-pure)/full/map/of +core-js(-pure)/full/weak-set/of +core-js(-pure)/full/weak-set/from +core-js(-pure)/full/weak-map/of +core-js(-pure)/full/weak-map/from +``` +`.of` / `.from` [*examples*](https://goo.gl/mSC7eU): +```js +Set.of(1, 2, 3, 2, 1); // => Set {1, 2, 3} + +Map.from([[1, 2], [3, 4]], ([key, value]) => [key ** 2, value ** 2]); // => Map { 1: 4, 9: 16 } +``` \ No newline at end of file diff --git a/docs/features/proposals/decorator-metadata.md b/docs/features/proposals/decorator-metadata.md new file mode 100644 index 000000000000..99259f0ca1ba --- /dev/null +++ b/docs/features/proposals/decorator-metadata.md @@ -0,0 +1,12 @@ +# [`Symbol.metadataKey` for decorators metadata proposal](https://github.com/tc39/proposal-decorator-metadata) +Module [`esnext.symbol.metadata-key`](/packages/core-js/modules/esnext.symbol.metadata-key.js). +```ts +class Symbol { + static metadataKey: @@metadataKey; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/decorator-metadata +core-js(-pure)/full/symbol/metadata-key +``` diff --git a/docs/features/proposals/efficient-64-bit-arithmetic.md b/docs/features/proposals/efficient-64-bit-arithmetic.md new file mode 100644 index 000000000000..965d419bc585 --- /dev/null +++ b/docs/features/proposals/efficient-64-bit-arithmetic.md @@ -0,0 +1,20 @@ +# [Efficient 64 bit arithmetic](https://gist.github.com/BrendanEich/4294d5c212a6d2254703) +**This proposal has been withdrawn and will be removed from the next major `core-js` version.** + +Modules [`esnext.math.iaddh`](/packages/core-js/modules/esnext.math.iaddh.js), [`esnext.math.isubh`](/packages/core-js/modules/esnext.math.isubh.js), [`esnext.math.imulh`](/packages/core-js/modules/esnext.math.imulh.js) and [`esnext.math.umulh`](/packages/core-js/modules/esnext.math.umulh.js) +```ts +namespace Math { + iaddh(lo0: number, hi0: number, lo1: number, hi1: number): number; + isubh(lo0: number, hi0: number, lo1: number, hi1: number): number; + imulh(a: number, b: number): number; + umulh(a: number, b: number): number; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/efficient-64-bit-arithmetic +core-js(-pure)/full/math/iaddh +core-js(-pure)/full/math/isubh +core-js(-pure)/full/math/imulh +core-js(-pure)/full/math/umulh +``` diff --git a/docs/features/proposals/function-is-callable-is-constructor.md b/docs/features/proposals/function-is-callable-is-constructor.md new file mode 100644 index 000000000000..76fcd26d9e89 --- /dev/null +++ b/docs/features/proposals/function-is-callable-is-constructor.md @@ -0,0 +1,29 @@ +# [`Function.{ isCallable, isConstructor }`](https://github.com/caitp/TC39-Proposals/blob/trunk/tc39-reflect-isconstructor-iscallable.md) + +Modules [`esnext.function.is-callable`](/packages/core-js/modules/esnext.function.is-callable.js), [`esnext.function.is-constructor`](/packages/core-js/modules/esnext.function.is-constructor.js) +```ts +class Function { + static isCallable(value: any): boolean; + static isConstructor(value: any): boolean; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/function-is-callable-is-constructor +core-js(-pure)/full/function/is-callable +core-js(-pure)/full/function/is-constructor +``` +[*Examples*](https://is.gd/Kof1he): +```js +Function.isCallable(null); // => false +Function.isCallable({}); // => false +Function.isCallable(function () {}); // => true +Function.isCallable(() => {}); // => true +Function.isCallable(class {}); // => false + +Function.isConstructor(null); // => false +Function.isConstructor({}); // => false +Function.isConstructor(function () {}); // => true +Function.isConstructor(() => {}); // => false +Function.isConstructor(class {}); // => true +``` diff --git a/docs/features/proposals/function-un-this.md b/docs/features/proposals/function-un-this.md new file mode 100644 index 000000000000..9c26250ee487 --- /dev/null +++ b/docs/features/proposals/function-un-this.md @@ -0,0 +1,19 @@ +# [`Function.prototype.unThis`](https://github.com/js-choi/proposal-function-un-this) +Module [`esnext.function.un-this`](/packages/core-js/modules/esnext.function.un-this.js) +```ts +class Function { + unThis(): Function; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/function-un-this +core-js(-pure)/full/function/un-this +core-js(-pure)/full/function/virtual/un-this +``` +[*Examples*](https://is.gd/t1Bvhn): +```js +const slice = Array.prototype.slice.unThis(); + +slice([1, 2, 3], 1); // => [2, 3] +``` diff --git a/docs/features/proposals/global-this.md b/docs/features/proposals/global-this.md new file mode 100644 index 000000000000..2475ae422569 --- /dev/null +++ b/docs/features/proposals/global-this.md @@ -0,0 +1,8 @@ +# [ES `globalThis`](https://github.com/tc39/proposal-global) +```ts +let globalThis: Object; +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/global-this +``` diff --git a/docs/features/proposals/iterator-helpers.md b/docs/features/proposals/iterator-helpers.md new file mode 100644 index 000000000000..ad4a394ecfa1 --- /dev/null +++ b/docs/features/proposals/iterator-helpers.md @@ -0,0 +1,105 @@ +# [Iterator helpers](https://github.com/tc39/proposal-iterator-helpers) +Modules [`esnext.async-iterator.constructor`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.constructor.js), [`esnext.async-iterator.drop`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.drop.js), [`esnext.async-iterator.every`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.every.js), [`esnext.async-iterator.filter`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.filter.js), [`esnext.async-iterator.find`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.find.js), [`esnext.async-iterator.flat-map`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.flat-map.js), [`esnext.async-iterator.for-each`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.for-each.js), [`esnext.async-iterator.from`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.from.js), [`esnext.async-iterator.indexed`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.indexed.js), [`esnext.async-iterator.map`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.map.js), [`esnext.async-iterator.reduce`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.reduce.js), [`esnext.async-iterator.some`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.some.js), [`esnext.async-iterator.take`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.take.js), [`esnext.async-iterator.to-array`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.async-iterator.to-array.js), [`esnext.iterator.constructor`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.constructor.js), [`esnext.iterator.drop`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.drop.js), [`esnext.iterator.every`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.every.js), [`esnext.iterator.filter`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.filter.js), [`esnext.iterator.find`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.find.js), [`esnext.iterator.flat-map`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.flat-map.js), [`esnext.iterator.for-each`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.for-each.js), [`esnext.iterator.from`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.from.js), [`esnext.iterator.indexed`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.indexed.js), [`esnext.iterator.map`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.map.js), [`esnext.iterator.reduce`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.reduce.js), [`esnext.iterator.some`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.some.js), [`esnext.iterator.take`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.take.js), [`esnext.iterator.to-array`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.to-array.js) and [`esnext.iterator.to-async`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.iterator.to-async.js) +```ts +class Iterator { + static from(iterable: Iterable): Iterator; + drop(limit: uint): Iterator; + every(callbackfn: value: any => boolean): boolean; + filter(callbackfn: value: any => boolean): Iterator; + find(callbackfn: value: any => boolean)): any; + flatMap(callbackfn: value => any: Iterable): Iterator; + forEach(callbackfn: value => void): void; + indexed(): Iterator<[index, any]>; + map(callbackfn: value => any): Iterator; + reduce(callbackfn: (memo: any, value: any) => any, initialValue: any): any; + some(callbackfn: value: any => boolean): boolean; + take(limit: uint): Iterator; + toArray(): Array; + toAsync(): AsyncIterator; + @@toStringTag: 'Iterator' +} + +class AsyncIterator { + static from(iterable: Iterable): AsyncIterator; + drop(limit: uint): AsyncIterator; + every(async callbackfn: value: any => boolean): Promise; + filter(async callbackfn: value: any => boolean): AsyncIterator; + find(async callbackfn: value: any => boolean)): Promise; + flatMap(async callbackfn: value => any: Iterable): AsyncIterator; + forEach(async callbackfn: value => void): Promise; + indexed(): Iterator<[index, any]>; + map(async callbackfn: value => any): AsyncIterator; + reduce(async callbackfn: (memo: any, value: any) => any, initialValue: any): Promise; + some(async callbackfn: value: any => boolean): Promise; + take(limit: uint): AsyncIterator; + toArray(): Promise; + @@toStringTag: 'AsyncIterator' +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/iterator-helpers +core-js(-pure)/full/async-iterator +core-js(-pure)/full/async-iterator/drop +core-js(-pure)/full/async-iterator/every +core-js(-pure)/full/async-iterator/filter +core-js(-pure)/full/async-iterator/find +core-js(-pure)/full/async-iterator/flat-map +core-js(-pure)/full/async-iterator/for-each +core-js(-pure)/full/async-iterator/from +core-js(-pure)/full/async-iterator/indexed +core-js(-pure)/full/async-iterator/map +core-js(-pure)/full/async-iterator/reduce +core-js(-pure)/full/async-iterator/some +core-js(-pure)/full/async-iterator/take +core-js(-pure)/full/async-iterator/to-array +core-js(-pure)/full/iterator +core-js(-pure)/full/iterator/drop +core-js(-pure)/full/iterator/every +core-js(-pure)/full/iterator/filter +core-js(-pure)/full/iterator/find +core-js(-pure)/full/iterator/flat-map +core-js(-pure)/full/iterator/for-each +core-js(-pure)/full/iterator/from +core-js(-pure)/full/iterator/indexed +core-js(-pure)/full/iterator/map +core-js(-pure)/full/iterator/reduce +core-js(-pure)/full/iterator/some +core-js(-pure)/full/iterator/take +core-js(-pure)/full/iterator/to-array +core-js(-pure)/full/iterator/to-async +``` +[Examples](https://is.gd/P7YLCq): +```js +[1, 2, 3, 4, 5, 6, 7].values() + .drop(1) + .take(5) + .filter(it => it % 2) + .map(it => it ** 2) + .toArray(); // => [9, 25] + +Iterator.from({ + next: () => ({ done: Math.random() > .9, value: Math.random() * 10 | 0 }) +}).toArray(); // => [7, 6, 3, 0, 2, 8] + +await AsyncIterator.from([1, 2, 3, 4, 5, 6, 7]) + .drop(1) + .take(5) + .filter(it => it % 2) + .map(it => it ** 2) + .toArray(); // => [9, 25] + +await [1, 2, 3].values().toAsync().map(async it => it ** 2).toArray(); // => [1, 4, 9] +``` +## Caveats: +- For preventing prototypes pollution, in the `pure` version, new `%IteratorPrototype%` methods are not added to the real `%IteratorPrototype%`, they available only on wrappers - instead of `[].values().map(fn)` use `Iterator.from([]).map(fn)`. +- Now, we have access to the real `%AsyncIteratorPrototype%` only with usage async generators syntax. So, for compatibility the library with old browsers, we should use `Function` constructor. However, that breaks compatibility with CSP. So, if you wanna use the real `%AsyncIteratorPrototype%`, you should set `USE_FUNCTION_CONSTRUCTOR` option in the `core-js/configurator` to `true`: +```js +const configurator = require('core-js/configurator'); + +configurator({ USE_FUNCTION_CONSTRUCTOR: true }); + +require('core-js/full/async-iterator'); + +(async function * () { /* empty */ })() instanceof AsyncIterator; // => true +``` diff --git a/docs/features/proposals/keys-composition.md b/docs/features/proposals/keys-composition.md new file mode 100644 index 000000000000..d2fd145aae79 --- /dev/null +++ b/docs/features/proposals/keys-composition.md @@ -0,0 +1,38 @@ +# [`compositeKey` and `compositeSymbol`](https://github.com/tc39/proposal-richer-keys/tree/master/compositeKey) +Modules [`esnext.composite-key`](/packages/core-js/modules/esnext.composite-key.js) and [`esnext.composite-symbol`](/packages/core-js/modules/esnext.composite-symbol.js) +```ts +function compositeKey(...args: Array): object; +function compositeSymbol(...args: Array): symbol; +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/keys-composition +core-js(-pure)/full/composite-key +core-js(-pure)/full/composite-symbol +``` +[*Examples*](https://goo.gl/2oPAH7): +```js +// returns a symbol +const symbol = compositeSymbol({}); +console.log(typeof symbol); // => 'symbol' + +// works the same, but returns a plain frozen object without a prototype +const key = compositeKey({}); +console.log(typeof key); // => 'object' +console.log({}.toString.call(key)); // => '[object Object]' +console.log(Object.getPrototypeOf(key)); // => null +console.log(Object.isFrozen(key)); // => true + +const a = ['a']; +const b = ['b']; +const c = ['c']; + +console.log(compositeSymbol(a) === compositeSymbol(a)); // => true +console.log(compositeSymbol(a) !== compositeSymbol(['a'])); // => true +console.log(compositeSymbol(a, 1) === compositeSymbol(a, 1)); // => true +console.log(compositeSymbol(a, b) !== compositeSymbol(b, a)); // => true +console.log(compositeSymbol(a, b, c) === compositeSymbol(a, b, c)); // => true +console.log(compositeSymbol(1, a) === compositeSymbol(1, a)); // => true +console.log(compositeSymbol(1, a, 2, b) === compositeSymbol(1, a, 2, b)); // => true +console.log(compositeSymbol(a, a) === compositeSymbol(a, a)); // => true +``` diff --git a/docs/features/proposals/map-upsert.md b/docs/features/proposals/map-upsert.md new file mode 100644 index 000000000000..b3c9d7f9bbe1 --- /dev/null +++ b/docs/features/proposals/map-upsert.md @@ -0,0 +1,27 @@ +# [`Map.prototype.emplace`](https://github.com/thumbsupep/proposal-upsert) +Modules [`esnext.map.emplace`](/packages/core-js/modules/esnext.map.emplace.js) and [`esnext.weak-map.emplace`](/packages/core-js/modules/esnext.weak-map.emplace.js) +```ts +class Map { + emplace(key: any, { update: (value: any, key: any, handler: object) => updated: any, insert: (key: any, handler: object) => value: any): updated | value; +} + +class WeakMap { + emplace(key: any, { update: (value: any, key: any, handler: object) => updated: any, insert: (key: any, handler: object) => value: any): updated | value; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/map-upsert-stage-2 +core-js(-pure)/full/map/emplace +core-js(-pure)/full/weak-map/emplace +``` +[*Examples*](https://is.gd/ty5I2v): +```js +const map = new Map([['a', 2]]); + +map.emplace('a', { update: it => it ** 2, insert: () => 3}); // => 4 + +map.emplace('b', { update: it => it ** 2, insert: () => 3}); // => 3 + +console.log(map); // => Map { 'a': 4, 'b': 3 } +``` diff --git a/docs/features/proposals/math-extensions.md b/docs/features/proposals/math-extensions.md new file mode 100644 index 000000000000..2136e0f97ff5 --- /dev/null +++ b/docs/features/proposals/math-extensions.md @@ -0,0 +1,24 @@ +# [`Math` extensions](https://github.com/rwaldron/proposal-math-extensions) +Modules [`esnext.math.clamp`](/packages/core-js/modules/esnext.math.clamp.js), [`esnext.math.deg-per-rad`](/packages/core-js/modules/esnext.math.deg-per-rad.js), [`esnext.math.degrees`](/packages/core-js/modules/esnext.math.degrees.js), [`esnext.math.fscale`](/packages/core-js/modules/esnext.math.fscale.js), [`esnext.math.rad-per-deg`](/packages/core-js/modules/esnext.math.rad-per-deg.js), [`esnext.math.radians`](/packages/core-js/modules/esnext.math.radians.js) and [`esnext.math.scale`](/packages/core-js/modules/esnext.math.scale.js) +```ts +namespace Math { + DEG_PER_RAD: number; + RAD_PER_DEG: number; + clamp(x: number, lower: number, upper: number): number; + degrees(radians: number): number; + fscale(x: number, inLow: number, inHigh: number, outLow: number, outHigh: number): number; + radians(degrees: number): number; + scale(x: number, inLow: number, inHigh: number, outLow: number, outHigh: number): number; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/math-extensions +core-js(-pure)/full/math/clamp +core-js(-pure)/full/math/deg-per-rad +core-js(-pure)/full/math/degrees +core-js(-pure)/full/math/fscale +core-js(-pure)/full/math/rad-per-deg +core-js(-pure)/full/math/radians +core-js(-pure)/full/math/scale +``` diff --git a/docs/features/proposals/math-signbit.md b/docs/features/proposals/math-signbit.md new file mode 100644 index 000000000000..538d571b9af8 --- /dev/null +++ b/docs/features/proposals/math-signbit.md @@ -0,0 +1,20 @@ +# [`Math.signbit`](https://github.com/tc39/proposal-Math.signbit) +Module [`esnext.math.signbit`](/packages/core-js/modules/esnext.math.signbit.js) +```ts +namespace Math { + signbit(x: number): boolean; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/math-signbit +core-js(-pure)/full/math/signbit +``` +[*Examples*](https://goo.gl/rPWbzZ): +```js +Math.signbit(NaN); // => false +Math.signbit(1); // => false +Math.signbit(-1); // => true +Math.signbit(0); // => false +Math.signbit(-0); // => true +``` diff --git a/docs/features/proposals/number-from-string.md b/docs/features/proposals/number-from-string.md new file mode 100644 index 000000000000..8363d5883f35 --- /dev/null +++ b/docs/features/proposals/number-from-string.md @@ -0,0 +1,12 @@ +# [`Number.fromString`](https://github.com/tc39/proposal-number-fromstring) +Module [`esnext.number.from-string`](/packages/core-js/modules/esnext.number.from-string.js) +```ts +class Number { + fromString(string: string, radix: number): number; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/number-from-string +core-js(-pure)/full/number/from-string +``` diff --git a/docs/features/proposals/number-range.md b/docs/features/proposals/number-range.md new file mode 100644 index 000000000000..a79a60054699 --- /dev/null +++ b/docs/features/proposals/number-range.md @@ -0,0 +1,27 @@ +# [`Number.range`](https://github.com/tc39/proposal-Number.range) +Module [`esnext.number.range`](/packages/core-js/modules/esnext.number.range.js) and [`esnext.bigint.range`](/packages/core-js/modules/esnext.bigint.range.js) +```ts +class Number { + range(start: number, end: number, options: { step: number = 1, inclusive: boolean = false } | step: number = 1): RangeIterator; +} + +class BigInt { + range(start: bigint, end: bigint | Infinity | -Infinity, options: { step: bigint = 1n, inclusive: boolean = false } | step: bigint = 1n): RangeIterator; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/number-range +core-js(-pure)/full/bigint/range +core-js(-pure)/full/number/range +``` +[*Example*](https://is.gd/caCKSb): +```js +for (const i of Number.range(1, 10)) { + console.log(i); // => 1, 2, 3, 4, 5, 6, 7, 8, 9 +} + +for (const i of Number.range(1, 10, { step: 3, inclusive: true })) { + console.log(i); // => 1, 4, 7, 10 +} +``` diff --git a/docs/features/proposals/object-from-entries.md b/docs/features/proposals/object-from-entries.md new file mode 100644 index 000000000000..38894ebbade7 --- /dev/null +++ b/docs/features/proposals/object-from-entries.md @@ -0,0 +1,10 @@ +# [`Object.fromEntries`](https://github.com/tc39/proposal-object-from-entries) +```ts +class Object { + static fromEntries(iterable: Iterable<[key, value]>): Object; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/object-from-entries +``` diff --git a/docs/features/proposals/object-getownpropertydescriptors.md b/docs/features/proposals/object-getownpropertydescriptors.md new file mode 100644 index 000000000000..e1c2e299b5af --- /dev/null +++ b/docs/features/proposals/object-getownpropertydescriptors.md @@ -0,0 +1,10 @@ +# [`Object.getOwnPropertyDescriptors`](https://github.com/tc39/proposal-object-getownpropertydescriptors) +```ts +class Object { + static getOwnPropertyDescriptors(object: any): { [property: PropertyKey]: PropertyDescriptor }; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/object-getownpropertydescriptors +``` diff --git a/docs/features/proposals/object-iteration.md b/docs/features/proposals/object-iteration.md new file mode 100644 index 000000000000..7eda7a55c80a --- /dev/null +++ b/docs/features/proposals/object-iteration.md @@ -0,0 +1,34 @@ +# [Object iteration](https://github.com/tc39/proposal-object-iteration) +**This proposal has been withdrawn and will be removed from the next major `core-js` version.** + +Modules [`esnext.object.iterate-keys`](/packages/core-js/modules/esnext.object.iterate-keys.js), [`esnext.object.iterate-values`](/packages/core-js/modules/esnext.object.iterate-values.js), [`esnext.object.iterate-entries`](/packages/core-js/modules/esnext.object.iterate-entries.js). +```ts +class Object { + iterateKeys(object: any): Iterator; + iterateValues(object: any): Iterator; + iterateEntries(object: any): Iterator<[string, any]>; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/object-iteration +core-js(-pure)/full/object/iterate-keys +core-js(-pure)/full/object/iterate-values +core-js(-pure)/full/object/iterate-entries +``` +[*Example*](https://is.gd/Wnm2tD): +```js +const obj = { foo: 'bar', baz: 'blah' }; + +for (const [key, value] of Object.iterateEntries(obj)) { + console.log(`${key} -> ${value}`); +} + +for (const key of Object.iterateKeys(obj)) { + console.log(key); +} + +for (const value of Object.iterateValues(obj)) { + console.log(value); +} +``` diff --git a/docs/features/proposals/object-values-entries.md b/docs/features/proposals/object-values-entries.md new file mode 100644 index 000000000000..aadd1ff2c66f --- /dev/null +++ b/docs/features/proposals/object-values-entries.md @@ -0,0 +1,11 @@ +# [`Object.values` / `Object.entries`](https://github.com/tc39/proposal-object-values-entries) +```ts +class Object { + static entries(object: Object): Array<[string, mixed]>; + static values(object: any): Array; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/object-values-entries +``` diff --git a/docs/features/proposals/observable.md b/docs/features/proposals/observable.md new file mode 100644 index 000000000000..3d2ecf1086a8 --- /dev/null +++ b/docs/features/proposals/observable.md @@ -0,0 +1,33 @@ +# [`Observable`](https://github.com/zenparsing/es-observable) +Modules [`esnext.observable`](/packages/core-js/modules/esnext.observable.js) and [`esnext.symbol.observable`](/packages/core-js/modules/esnext.symbol.observable.js) +```ts +class Observable { + constructor(subscriber: Function): Observable; + subscribe(observer: Function | { next?: Function, error?: Function, complete?: Function }): Subscription; + @@observable(): this; + static of(...items: Aray): Observable; + static from(x: Observable | Iterable): Observable; + static readonly attribute @@species: this; +} + +class Symbol { + static observable: @@observable; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/observable +core-js(-pure)/full/observable +core-js(-pure)/full/symbol/observable +``` +[*Examples*](https://goo.gl/1LDywi): +```js +new Observable(observer => { + observer.next('hello'); + observer.next('world'); + observer.complete(); +}).subscribe({ + next(it) { console.log(it); }, + complete() { console.log('!'); } +}); +``` diff --git a/docs/features/proposals/pattern-matching.md b/docs/features/proposals/pattern-matching.md new file mode 100644 index 000000000000..509feef36183 --- /dev/null +++ b/docs/features/proposals/pattern-matching.md @@ -0,0 +1,12 @@ +# [`Symbol.matcher` for pattern matching](https://github.com/tc39/proposal-pattern-matching) +Module [`esnext.symbol.matcher`](/packages/core-js/modules/esnext.symbol.matcher.js). +```ts +class Symbol { + static matcher: @@matcher; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/pattern-matching +core-js(-pure)/full/symbol/matcher +``` diff --git a/docs/features/proposals/promise-all-settled.md b/docs/features/proposals/promise-all-settled.md new file mode 100644 index 000000000000..91894085e2e4 --- /dev/null +++ b/docs/features/proposals/promise-all-settled.md @@ -0,0 +1,10 @@ +# [`Promise.allSettled`](https://github.com/tc39/proposal-promise-allSettled) +```ts +class Promise { + static allSettled(iterable: Iterable): Promise; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/promise-all-settled +``` diff --git a/docs/features/proposals/promise-any.md b/docs/features/proposals/promise-any.md new file mode 100644 index 000000000000..de033a922cf8 --- /dev/null +++ b/docs/features/proposals/promise-any.md @@ -0,0 +1,16 @@ +# [`Promise.any`](https://github.com/tc39/proposal-promise-any) +```ts +class AggregateError { + constructor(errors: Iterable, message: string): AggregateError; + errors: Array; + message: string; +} + +class Promise { + static any(promises: Iterable): Promise; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/promise-any +``` diff --git a/docs/features/proposals/promise-finally.md b/docs/features/proposals/promise-finally.md new file mode 100644 index 000000000000..850a6daf5854 --- /dev/null +++ b/docs/features/proposals/promise-finally.md @@ -0,0 +1,10 @@ +# [`Promise.prototype.finally`](https://github.com/tc39/proposal-promise-finally) +```ts +class Promise { + finally(onFinally: Function): Promise; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/promise-finally +``` diff --git a/docs/features/proposals/promise-try.md b/docs/features/proposals/promise-try.md new file mode 100644 index 000000000000..44d9986241cd --- /dev/null +++ b/docs/features/proposals/promise-try.md @@ -0,0 +1,20 @@ +# [`Promise.try`](https://github.com/tc39/proposal-promise-try) +**This proposal is dead and will be removed from the next major `core-js` version.** + +Module [`esnext.promise.try`](/packages/core-js/modules/esnext.promise.try.js) +```ts +class Promise { + static try(callbackfn: Function): promise; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/promise-try +core-js(-pure)/full/promise/try +``` +[*Examples*](https://goo.gl/k5GGRo): +```js +Promise.try(() => 42).then(it => console.log(`Promise, resolved as ${it}`)); + +Promise.try(() => { throw 42; }).catch(it => console.log(`Promise, rejected as ${it}`)); +``` diff --git a/docs/features/proposals/reflect-metadata.md b/docs/features/proposals/reflect-metadata.md new file mode 100644 index 000000000000..eed6a0c10202 --- /dev/null +++ b/docs/features/proposals/reflect-metadata.md @@ -0,0 +1,36 @@ +# [`Reflect` metadata](https://github.com/rbuckton/reflect-metadata) +Modules [`esnext.reflect.define-metadata`](/packages/core-js/modules/esnext.reflect.define-metadata.js), [`esnext.reflect.delete-metadata`](/packages/core-js/modules/esnext.reflect.delete-metadata.js), [`esnext.reflect.get-metadata`](/packages/core-js/modules/esnext.reflect.get-metadata.js), [`esnext.reflect.get-metadata-keys`](/packages/core-js/modules/esnext.reflect.get-metadata-keys.js), [`esnext.reflect.get-own-metadata`](/packages/core-js/modules/esnext.reflect.get-own-metadata.js), [`esnext.reflect.get-own-metadata-keys`](/packages/core-js/modules/esnext.reflect.get-own-metadata-keys.js), [`esnext.reflect.has-metadata`](/packages/core-js/modules/esnext.reflect.has-metadata.js), [`esnext.reflect.has-own-metadata`](/packages/core-js/modules/esnext.reflect.has-own-metadata.js) and [`esnext.reflect.metadata`](/packages/core-js/modules/esnext.reflect.metadata.js). +```ts +namespace Reflect { + defineMetadata(metadataKey: any, metadataValue: any, target: Object, propertyKey?: PropertyKey): void; + getMetadata(metadataKey: any, target: Object, propertyKey?: PropertyKey): any; + getOwnMetadata(metadataKey: any, target: Object, propertyKey?: PropertyKey): any; + hasMetadata(metadataKey: any, target: Object, propertyKey?: PropertyKey): boolean; + hasOwnMetadata(metadataKey: any, target: Object, propertyKey?: PropertyKey): boolean; + deleteMetadata(metadataKey: any, target: Object, propertyKey?: PropertyKey): boolean; + getMetadataKeys(target: Object, propertyKey?: PropertyKey): Array; + getOwnMetadataKeys(target: Object, propertyKey?: PropertyKey): Array; + metadata(metadataKey: any, metadataValue: any): decorator(target: Object, targetKey?: PropertyKey) => void; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/reflect-metadata +core-js(-pure)/full/reflect/define-metadata +core-js(-pure)/full/reflect/delete-metadata +core-js(-pure)/full/reflect/get-metadata +core-js(-pure)/full/reflect/get-metadata-keys +core-js(-pure)/full/reflect/get-own-metadata +core-js(-pure)/full/reflect/get-own-metadata-keys +core-js(-pure)/full/reflect/has-metadata +core-js(-pure)/full/reflect/has-own-metadata +core-js(-pure)/full/reflect/metadata +``` +[*Examples*](https://goo.gl/KCo3PS): +```js +let object = {}; +Reflect.defineMetadata('foo', 'bar', object); +Reflect.ownKeys(object); // => [] +Reflect.getOwnMetadataKeys(object); // => ['foo'] +Reflect.getOwnMetadata('foo', object); // => 'bar' +``` diff --git a/docs/features/proposals/regexp-dotall-flag.md b/docs/features/proposals/regexp-dotall-flag.md new file mode 100644 index 000000000000..87988d1eaef8 --- /dev/null +++ b/docs/features/proposals/regexp-dotall-flag.md @@ -0,0 +1,14 @@ +# [`RegExp` `s` (`dotAll`) flag](https://github.com/tc39/proposal-regexp-dotall-flag) +```ts +// patched for support `RegExp` dotAll (`s`) flag: +class RegExp { + constructor(pattern: RegExp | string, flags?: string): RegExp; + exec(): Array | null; + readonly attribute dotAll: boolean; + readonly attribute flags: string; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/regexp-dotall-flag +``` diff --git a/docs/features/proposals/regexp-named-groups.md b/docs/features/proposals/regexp-named-groups.md new file mode 100644 index 000000000000..7e4d19fda99e --- /dev/null +++ b/docs/features/proposals/regexp-named-groups.md @@ -0,0 +1,13 @@ +# [`RegExp` named capture groups](https://github.com/tc39/proposal-regexp-named-groups) +```ts +// patched for support `RegExp` named capture groups: +class RegExp { + constructor(pattern: RegExp | string, flags?: string): RegExp; + exec(): Array | null; + @@replace(string: string, replaceValue: Function | string): string; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/regexp-named-groups +``` diff --git a/docs/features/proposals/relative-indexing-method.md b/docs/features/proposals/relative-indexing-method.md new file mode 100644 index 000000000000..3579b6531b20 --- /dev/null +++ b/docs/features/proposals/relative-indexing-method.md @@ -0,0 +1,18 @@ +# [ES Relative indexing method](https://github.com/tc39/proposal-relative-indexing-method) +```ts +class Array { + at(index: int): any; +} + +class String { + at(index: int): string; +} + +class %TypedArray% { + at(index: int): number; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/relative-indexing-method +``` diff --git a/docs/features/proposals/seeded-random.md b/docs/features/proposals/seeded-random.md new file mode 100644 index 000000000000..cbfa5b8ae03f --- /dev/null +++ b/docs/features/proposals/seeded-random.md @@ -0,0 +1,21 @@ +# [Seeded pseudo-random numbers](https://github.com/tc39/proposal-seeded-random) +**API of this proposal has been changed. This proposal will be removed from the next major `core-js` version and will be added back after adding and stabilization of the spec text.** + +Module [`esnext.math.seeded-prng`](/packages/core-js/modules/esnext.math.seeded-prng.js) +```ts +class Math { + seededPRNG({ seed: number }): Iterator; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/seeded-random +core-js(-pure)/full/math/seeded-prng +``` +[*Example*](https://goo.gl/oj3WgQ): +```js +for (let x of Math.seededPRNG({ seed: 42 })) { + console.log(x); // => 0.16461519912315087, 0.2203933906000046, 0.8249682894209105 + if (x > .8) break; +} +``` diff --git a/docs/features/proposals/set-methods.md b/docs/features/proposals/set-methods.md new file mode 100644 index 000000000000..ad90972987f9 --- /dev/null +++ b/docs/features/proposals/set-methods.md @@ -0,0 +1,35 @@ +# [New `Set` methods](https://github.com/tc39/proposal-set-methods) +Modules [`esnext.set.difference`](/packages/core-js/modules/esnext.set.difference.js), [`esnext.set.intersection`](/packages/core-js/modules/esnext.set.intersection.js), [`esnext.set.is-disjoint-from`](/packages/core-js/modules/esnext.set.is-disjoint-from.js), [`esnext.set.is-subset-of`](/packages/core-js/modules/esnext.set.is-subset-of.js), [`esnext.set.is-superset-of`](/packages/core-js/modules/esnext.set.is-superset-of.js), [`esnext.set.symmetric-difference`](/packages/core-js/modules/esnext.set.symmetric-difference.js), [`esnext.set.union`](/packages/core-js/modules/esnext.set.union.js) +```ts +class Set { + difference(iterable: Iterable): Set; + intersection(iterable: Iterable): Set; + isDisjointFrom(iterable: Iterable): boolean; + isSubsetOf(iterable: Iterable): boolean; + isSupersetOf(iterable: Iterable): boolean; + symmetricDifference(iterable: Iterable): Set; + union(iterable: Iterable): Set; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/set-methods +core-js(-pure)/full/set/difference +core-js(-pure)/full/set/intersection +core-js(-pure)/full/set/is-disjoint-from +core-js(-pure)/full/set/is-subset-of +core-js(-pure)/full/set/is-superset-of +core-js(-pure)/full/set/symmetric-difference +core-js(-pure)/full/set/union +``` +[*Examples*](https://goo.gl/QMQdaJ): +```js +new Set([1, 2, 3]).union([3, 4, 5]); // => Set {1, 2, 3, 4, 5} +new Set([1, 2, 3]).intersection([3, 4, 5]); // => Set {3} +new Set([1, 2, 3]).difference([3, 4, 5]); // => Set {1, 2} +new Set([1, 2, 3]).symmetricDifference([3, 4, 5]); // => Set {1, 2, 4, 5} + +new Set([1, 2, 3]).isDisjointFrom([4, 5, 6]); // => true +new Set([1, 2, 3]).isSubsetOf([5, 4, 3, 2, 1]); // => true +new Set([5, 4, 3, 2, 1]).isSupersetOf([1, 2, 3]); // => true +``` diff --git a/docs/features/proposals/string-at.md b/docs/features/proposals/string-at.md new file mode 100644 index 000000000000..17cfd313172b --- /dev/null +++ b/docs/features/proposals/string-at.md @@ -0,0 +1,20 @@ +# [`String#at`](https://github.com/mathiasbynens/String.prototype.at) +**This proposal has been withdrawn and will be removed from the next major `core-js` version.** + +Module [`esnext.string.at`](/packages/core-js/modules/esnext.string.at.js) +```ts +class String { + at(index: number): string; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/string-at +core-js(-pure)/full/string/at +core-js(-pure)/full/string/virtual/at +``` +[*Examples*](https://goo.gl/XluXI8): +```js +'a𠮷b'.at(1); // => '𠮷' +'a𠮷b'.at(1).length; // => 2 +``` diff --git a/docs/features/proposals/string-code-points.md b/docs/features/proposals/string-code-points.md new file mode 100644 index 000000000000..1525e7169a55 --- /dev/null +++ b/docs/features/proposals/string-code-points.md @@ -0,0 +1,19 @@ +# [`String.prototype.codePoints`](https://github.com/tc39/proposal-string-prototype-codepoints) +Module [`esnext.string.code-points`](/packages/core-js/modules/esnext.string.code-points.js) +```ts +class String { + codePoints(): Iterator<{ codePoint, position }>; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/string-code-points +core-js(-pure)/full/string/code-points +``` +[*Example*](https://goo.gl/Jt7SsD): +```js +for (let { codePoint, position } of 'qwe'.codePoints()) { + console.log(codePoint); // => 113, 119, 101 + console.log(position); // => 0, 1, 2 +} +``` diff --git a/docs/features/proposals/string-cooked.md b/docs/features/proposals/string-cooked.md new file mode 100644 index 000000000000..7a5c6dee777a --- /dev/null +++ b/docs/features/proposals/string-cooked.md @@ -0,0 +1,22 @@ +# [`String.cooked`](https://github.com/tc39/proposal-string-cooked) +Module [`esnext.string.cooked`](/packages/core-js/modules/esnext.string.cooked.js) +```ts +class String { + static cooked(template: Array, ...substitutions: Array): string; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/string-cooked +core-js(-pure)/full/string/cooked +``` +[*Example*](https://is.gd/7QPnss): +```js +function safePath(strings, ...subs) { + return String.cooked(strings, ...subs.map(sub => encodeURIComponent(sub))); +} + +let id = 'spottie?'; + +safePath`/cats/${ id }`; // => /cats/spottie%3F +``` diff --git a/docs/features/proposals/string-left-right-trim.md b/docs/features/proposals/string-left-right-trim.md new file mode 100644 index 000000000000..7f2b3522f700 --- /dev/null +++ b/docs/features/proposals/string-left-right-trim.md @@ -0,0 +1,13 @@ +# [`String.prototype.trimStart` / `String.prototype.trimEnd`](https://github.com/tc39/proposal-string-left-right-trim) +```ts +class String { + trimLeft(): string; + trimRight(): string; + trimStart(): string; + trimEnd(): string; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/string-left-right-trim +``` diff --git a/docs/features/proposals/string-match-all.md b/docs/features/proposals/string-match-all.md new file mode 100644 index 000000000000..2b37b2949c4c --- /dev/null +++ b/docs/features/proposals/string-match-all.md @@ -0,0 +1,10 @@ +# [`String#matchAll`](https://github.com/tc39/proposal-string-matchall). +```ts +class String { + matchAll(regexp: RegExp): Iterator; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/string-match-all +``` diff --git a/docs/features/proposals/string-padding.md b/docs/features/proposals/string-padding.md new file mode 100644 index 000000000000..9b19befda8dd --- /dev/null +++ b/docs/features/proposals/string-padding.md @@ -0,0 +1,12 @@ +# [`String` padding](https://github.com/tc39/proposal-string-pad-start-end) +```ts +class String { + padStart(length: number, fillStr?: string = ' '): string; + padEnd(length: number, fillStr?: string = ' '): string; +} + +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/string-padding +``` diff --git a/docs/features/proposals/string-replace-all.md b/docs/features/proposals/string-replace-all.md new file mode 100644 index 000000000000..41af409de8b7 --- /dev/null +++ b/docs/features/proposals/string-replace-all.md @@ -0,0 +1,10 @@ +# [`String#replaceAll`](https://github.com/tc39/proposal-string-replace-all) +```ts +class String { + replaceAll(searchValue: string | RegExp, replaceString: string | (searchValue, index, this) => string): string; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/string-replace-all-stage-4 +``` diff --git a/docs/features/proposals/symbol-description.md b/docs/features/proposals/symbol-description.md new file mode 100644 index 000000000000..66b0fba85f8f --- /dev/null +++ b/docs/features/proposals/symbol-description.md @@ -0,0 +1,10 @@ +# [`Symbol.prototype.description`](https://github.com/tc39/proposal-Symbol-description) +```ts +class Symbol { + readonly attribute description: string | void; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/symbol-description +``` diff --git a/docs/features/proposals/url.md b/docs/features/proposals/url.md new file mode 100644 index 000000000000..55533ef35368 --- /dev/null +++ b/docs/features/proposals/url.md @@ -0,0 +1,2 @@ +# [`URL`](https://github.com/jasnell/proposal-url) +See more info [in web standards namespace](/docs/features/web-standards.md#url-and-urlsearchparams) diff --git a/docs/features/proposals/using-statement.md b/docs/features/proposals/using-statement.md new file mode 100644 index 000000000000..190db9e12765 --- /dev/null +++ b/docs/features/proposals/using-statement.md @@ -0,0 +1,14 @@ +# [`Symbol.{ asyncDispose, dispose }` for `using` statement](https://github.com/tc39/proposal-using-statement) +Modules [`esnext.symbol.dispose`](/packages/core-js/modules/esnext.symbol.dispose.js) and [`esnext.symbol.async-dispose`](/packages/core-js/modules/esnext.symbol.async-dispose.js). +```ts +class Symbol { + static asyncDispose: @@asyncDispose; + static dispose: @@dispose; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/using-statement +core-js(-pure)/full/symbol/async-dispose +core-js(-pure)/full/symbol/dispose +``` diff --git a/docs/features/proposals/well-formed-stringify.md b/docs/features/proposals/well-formed-stringify.md new file mode 100644 index 000000000000..ad376b6375dd --- /dev/null +++ b/docs/features/proposals/well-formed-stringify.md @@ -0,0 +1,10 @@ +# [Well-formed `JSON.stringify`](https://github.com/tc39/proposal-well-formed-stringify) +```ts +namespace JSON { + stringify(target: any, replacer?: Function | Array, space?: string | number): string | void; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/well-formed-stringify +``` diff --git a/docs/features/web-standards/README.md b/docs/features/web-standards/README.md new file mode 100644 index 000000000000..a9c5088e66bf --- /dev/null +++ b/docs/features/web-standards/README.md @@ -0,0 +1,12 @@ +# Web standards +APIs that aren't part of ES, but are provided by browsers and available to JS code. + +## Index +- [`structuredClone`](structured-clone.md) +- [Base64 utility methods](base64-utility-methods.md) +- [`setTimeout` and `setInterval`](set-timeout%20and%20set-interval.md) +- [`setImmediate`](set-immediate.md) +- [`queueMicrotask`](queue-microtask.md) +- [`URL` and `URLSearchParams`](url.md) +- [`DOMException`](dom-exception.md) +- [Iterable DOM collections](Iterable%20DOM%20collections.md) diff --git a/docs/features/web-standards/base64-utility-methods.md b/docs/features/web-standards/base64-utility-methods.md new file mode 100644 index 000000000000..c7a91a3e61ef --- /dev/null +++ b/docs/features/web-standards/base64-utility-methods.md @@ -0,0 +1,16 @@ +# Base64 utility methods +[Specification](https://html.spec.whatwg.org/multipage/webappapis.html#atob), [MDN](https://developer.mozilla.org/en-US/docs/Glossary/Base64). Modules [`web.atob`](/packages/core-js/modules/web.atob.js), [`web.btoa`](/packages/core-js/modules/web.btoa.js). +```ts +function atob(data: string): string; +function btoa(data: string): string; +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/stable|actual|full/atob +core-js(-pure)/stable|actual|full/btoa +``` +[*Examples*](https://is.gd/4Nxmzn): +```js +btoa('hi, core-js'); // => 'aGksIGNvcmUtanM=' +atob('aGksIGNvcmUtanM='); // => 'hi, core-js' +``` \ No newline at end of file diff --git a/docs/features/web-standards/dom-collections.md b/docs/features/web-standards/dom-collections.md new file mode 100644 index 000000000000..303b1dd79661 --- /dev/null +++ b/docs/features/web-standards/dom-collections.md @@ -0,0 +1,62 @@ +# Iterable DOM collections +Some DOM collections should have [iterable interface](https://heycam.github.io/webidl/#idl-iterable) or should be [inherited from `Array`](https://heycam.github.io/webidl/#LegacyArrayClass). That means they should have `forEach`, `keys`, `values`, `entries` and `@@iterator` methods for iteration. So add them. Modules [`web.dom-collections.iterator`](/packages/core-js/modules/web.dom-collections.iterator.js) and [`web.dom-collections.for-each`](/packages/core-js/modules/web.dom-collections.for-each.js). +```ts +class [ + CSSRuleList, + CSSStyleDeclaration, + CSSValueList, + ClientRectList, + DOMRectList, + DOMStringList, + DataTransferItemList, + FileList, + HTMLAllCollection, + HTMLCollection, + HTMLFormElement, + HTMLSelectElement, + MediaList, + MimeTypeArray, + NamedNodeMap, + PaintRequestList, + Plugin, + PluginArray, + SVGLengthList, + SVGNumberList, + SVGPathSegList, + SVGPointList, + SVGStringList, + SVGTransformList, + SourceBufferList, + StyleSheetList, + TextTrackCueList, + TextTrackList, + TouchList, +] { + @@iterator(): Iterator; +} + +class [DOMTokenList, NodeList] { + forEach(callbackfn: (value: any, index: number, target: any) => void, thisArg: any): void; + entries(): Iterator<[key, value]>; + keys(): Iterator; + values(): Iterator; + @@iterator(): Iterator; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/stable|actual|full/dom-collections/iterator +core-js/stable|actual|full/dom-collections/for-each +``` +[*Examples*](https://goo.gl/lfXVFl): +```js +for (let { id } of document.querySelectorAll('*')) { + if (id) console.log(id); +} + +for (let [index, { id }] of document.querySelectorAll('*').entries()) { + if (id) console.log(index, id); +} + +document.querySelectorAll('*').forEach(it => console.log(it.id)); +``` diff --git a/docs/features/web-standards/dom-exception.md b/docs/features/web-standards/dom-exception.md new file mode 100644 index 000000000000..ac8edeee2fcf --- /dev/null +++ b/docs/features/web-standards/dom-exception.md @@ -0,0 +1,30 @@ +# `DOMException`: +[The specification.](https://webidl.spec.whatwg.org/#idl-DOMException) Modules [`web.dom-exception.constructor`](/packages/core-js/modules/web.dom-exception.constructor.js), [`web.dom-exception.stack`](/packages/core-js/modules/web.dom-exception.stack.js), [`web.dom-exception.to-string-tag`](/packages/core-js/modules/web.dom-exception.to-string-tag.js). +```ts +class DOMException { + constructor(message: string, name?: string); + readonly attribute name: string; + readonly attribute message: string; + readonly attribute code: string; + attribute stack: string; // in engines that should have it + @@toStringTag: 'DOMException'; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/stable|actual|full/dom-exception +core-js(-pure)/stable|actual|full/dom-exception/constructor +core-js/stable|actual|full/dom-exception/to-string-tag +``` +[*Examples*](https://is.gd/pI6oTN): +```js +const exception = new DOMException('error', 'DataCloneError'); +console.log(exception.name); // => 'DataCloneError' +console.log(exception.message); // => 'error' +console.log(exception.code); // => 25 +console.log(typeof exception.stack); // => 'string' +console.log(exception instanceof DOMException); // => true +console.log(exception instanceof Error); // => true +console.log(exception.toString()); // => 'DataCloneError: error' +console.log(Object.prototype.toString.call(exception)); // => '[object DOMException]' +``` \ No newline at end of file diff --git a/docs/features/web-standards/queue-microtask.md b/docs/features/web-standards/queue-microtask.md new file mode 100644 index 000000000000..ac1280b1d971 --- /dev/null +++ b/docs/features/web-standards/queue-microtask.md @@ -0,0 +1,13 @@ +# `queueMicrotask` +[Spec](https://html.spec.whatwg.org/multipage/timers-and-user-prompts.html#dom-queuemicrotask), module [`web.queue-microtask`](/packages/core-js/modules/web.queue-microtask.js) +```ts +function queueMicrotask(fn: Function): void; +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/stable|actual|full/queue-microtask +``` +[*Examples*](https://goo.gl/nsW8P9): +```js +queueMicrotask(() => console.log('called as microtask')); +``` \ No newline at end of file diff --git a/docs/features/web-standards/set-immediate.md b/docs/features/web-standards/set-immediate.md new file mode 100644 index 000000000000..afddf578254b --- /dev/null +++ b/docs/features/web-standards/set-immediate.md @@ -0,0 +1,21 @@ +# `setImmediate` +Module [`web.immediate`](/packages/core-js/modules/web.immediate.js). [`setImmediate`](https://w3c.github.io/setImmediate/) polyfill. +```ts +function setImmediate(callback: any, ...args: Array): number; +function clearImmediate(id: number): void; +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/stable|actual|full/set-immediate +core-js(-pure)/stable|actual|full/clear-immediate +``` +[*Examples*](https://goo.gl/6nXGrx): +```js +setImmediate((arg1, arg2) => { + console.log(arg1, arg2); // => Message will be displayed with minimum delay +}, 'Message will be displayed', 'with minimum delay'); + +clearImmediate(setImmediate(() => { + console.log('Message will not be displayed'); +})); +``` \ No newline at end of file diff --git a/docs/features/web-standards/set-timeout and set-interval.md b/docs/features/web-standards/set-timeout and set-interval.md new file mode 100644 index 000000000000..12ca7b75a18e --- /dev/null +++ b/docs/features/web-standards/set-timeout and set-interval.md @@ -0,0 +1,17 @@ +# `setTimeout` and `setInterval` +Module [`web.timers`](/packages/core-js/modules/web.timers.js). Additional arguments fix for IE9-. +```ts +function setTimeout(callback: any, time: any, ...args: Array): number; +function setInterval(callback: any, time: any, ...args: Array): number; +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/stable|actual|full/set-timeout +core-js(-pure)/stable|actual|full/set-interval +``` +```js +// Before: +setTimeout(log.bind(null, 42), 1000); +// After: +setTimeout(log, 1000, 42); +``` \ No newline at end of file diff --git a/docs/features/web-standards/structured-clone.md b/docs/features/web-standards/structured-clone.md new file mode 100644 index 000000000000..58a38c8515f5 --- /dev/null +++ b/docs/features/web-standards/structured-clone.md @@ -0,0 +1,43 @@ +# `structuredClone` +[Spec](https://html.spec.whatwg.org/multipage/structured-data.html#dom-structuredclone), module [`web.structured-clone`](/packages/core-js/modules/web.structured-clone.js) +```ts +function structuredClone(value: Serializable, { transfer?: Sequence }): any; +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js(-pure)/stable|actual|full/structured-clone +``` +[*Examples*](https://is.gd/RhK7TW): +```js +const structured = [{ a: 42 }]; +const sclone = structuredClone(structured); +console.log(sclone); // => [{ a: 42 }] +console.log(structured !== sclone); // => true +console.log(structured[0] !== sclone[0]); // => true + +const circular = {}; +circular.circular = circular; +const cclone = structuredClone(circular); +console.log(cclone.circular === cclone); // => true + +structuredClone(42); // => 42 +structuredClone({ x: 42 }); // => { x: 42 } +structuredClone([1, 2, 3]); // => [1, 2, 3] +structuredClone(new Set([1, 2, 3])); // => Set{ 1, 2, 3 } +structuredClone(new Map([['a', 1], ['b', 2]])); // => Map{ a: 1, b: 2 } +structuredClone(new Int8Array([1, 2, 3])); // => new Int8Array([1, 2, 3]) +structuredClone(new AggregateError([1, 2, 3], 'message')); // => new AggregateError([1, 2, 3], 'message')) +structuredClone(new TypeError('message', { cause: 42 })); // => new TypeError('message', { cause: 42 }) +structuredClone(new DOMException('message', 'DataCloneError')); // => new DOMException('message', 'DataCloneError') +structuredClone(document.getElementById('myfileinput')); // => new FileList +structuredClone(new DOMPoint(1, 2, 3, 4)); // => new DOMPoint(1, 2, 3, 4) +structuredClone(new Blob(['test'])); // => new Blob(['test']) +structuredClone(new ImageData(8, 8)); // => new ImageData(8, 8) +// etc. + +structuredClone(new WeakMap()); // => DataCloneError on non-serializable types +``` +## Caveats when using `structuredClone` polyfill:[⬆](#index) + +* `ArrayBuffer` instances and many platform types cannot be transferred in most engines since we have no way to polyfill this behavior, however `.transfer` option works for some platform types. I recommend avoiding this option. +* Some specific platform types can't be cloned in old engines. Mainly it's very specific types or very old engines, but here are some exceptions. For example, we have no sync way to clone `ImageBitmap` in Safari 14.0- or Firefox 83-, so it's recommended to look to the [polyfill source](/packages/core-js/modules/web.structured-clone.js) if you wanna clone something specific. \ No newline at end of file diff --git a/docs/features/web-standards/url.md b/docs/features/web-standards/url.md new file mode 100644 index 000000000000..59763ac0d38f --- /dev/null +++ b/docs/features/web-standards/url.md @@ -0,0 +1,92 @@ +# `URL` and `URLSearchParams` +[`URL` standard](https://url.spec.whatwg.org/) implementation. Modules [`web.url`](/packages/core-js/modules/web.url.js), [`web.url.to-json`](/packages/core-js/modules/web.url.to-json.js), [`web.url-search-params`](/packages/core-js/modules/web.url-search-params.js). +```ts +class URL { + constructor(url: string, base?: string); + attribute href: string; + readonly attribute origin: string; + attribute protocol: string; + attribute username: string; + attribute password: string; + attribute host: string; + attribute hostname: string; + attribute port: string; + attribute pathname: string; + attribute search: string; + readonly attribute searchParams: URLSearchParams; + attribute hash: string; + toJSON(): string; + toString(): string; +} + +class URLSearchParams { + constructor(params?: string | Iterable<[key, value]> | Object); + append(name: string, value: string): void; + delete(name: string): void; + get(name: string): string | void; + getAll(name: string): Array; + has(name: string): boolean; + set(name: string, value: string): void; + sort(): void; + toString(): string; + forEach(callbackfn: (value: any, index: number, target: any) => void, thisArg: any): void; + entries(): Iterator<[key, value]>; + keys(): Iterator; + values(): Iterator; + @@iterator(): Iterator<[key, value]>; +} +``` +[*CommonJS entry points:*](/docs/usage.md#commonjs-api) +``` +core-js/proposals/url +core-js(-pure)/stable|actual|full/url +core-js/stable|actual|full/url/to-json +core-js(-pure)/stable|actual|full/url-search-params +``` +[*Examples*](https://is.gd/AfIwve): +```js +const url = new URL('https://login:password@example.com:8080/foo/bar?a=1&b=2&a=3#fragment'); + +console.log(url.href); // => 'https://login:password@example.com:8080/foo/bar?a=1&b=2&a=3#fragment' +console.log(url.origin); // => 'https://example.com:8080' +console.log(url.protocol); // => 'https:' +console.log(url.username); // => 'login' +console.log(url.password); // => 'password' +console.log(url.host); // => 'example.com:8080' +console.log(url.hostname); // => 'example.com' +console.log(url.port); // => '8080' +console.log(url.pathname); // => '/foo/bar' +console.log(url.search); // => '?a=1&b=2&a=3' +console.log(url.hash); // => '#fragment' +console.log(url.toJSON()); // => 'https://login:password@example.com:8080/foo/bar?a=1&b=2&a=3#fragment' +console.log(url.toString()); // => 'https://login:password@example.com:8080/foo/bar?a=1&b=2&a=3#fragment' + +for (let [key, value] of url.searchParams) { + console.log(key); // => 'a', 'b', 'a' + console.log(value); // => '1', '2', '3' +} + +url.pathname = ''; +url.searchParams.append('c', 4); + +console.log(url.search); // => '?a=1&b=2&a=3&c=4' +console.log(url.href); // => 'https://login:password@example.com:8080/?a=1&b=2&a=3&c=4#fragment' + +const params = new URLSearchParams('?a=1&b=2&a=3'); + +params.append('c', 4); +params.append('a', 2); +params.sort(); + +for (let [key, value] of params) { + console.log(key); // => 'a', 'a', 'a', 'b', 'c' + console.log(value); // => '1', '3', '2', '2', '4' +} + +console.log(params.toString()); // => 'a=1&a=3&a=2&b=2&c=4' +``` + +## Caveats when using `URL` and `URLSearchParams`: +- IE8 does not support setters, so they do not work on `URL` instances. However, `URL` constructor can be used for basic `URL` parsing. +- Legacy encodings in a search query are not supported. Also, `core-js` implementation has some other encoding-related issues. +- `URL` implementations from all of the popular browsers have much more problems than `core-js`, however, replacing all of them does not looks like a good idea. You can customize the aggressiveness of polyfill [by your requirements](#configurable-level-of-aggressiveness). \ No newline at end of file diff --git a/docs/missing-polyfills.md b/docs/missing-polyfills.md new file mode 100644 index 000000000000..f816e21f0c1b --- /dev/null +++ b/docs/missing-polyfills.md @@ -0,0 +1,5 @@ +- ES `BigInt` can't be polyfilled since it requires changes in the behavior of operators, you could find more info [here](https://github.com/zloirock/core-js/issues/381). You could try to use [`JSBI`](https://github.com/GoogleChromeLabs/jsbi). +- ES `Proxy` can't be polyfilled, you can try to use [`proxy-polyfill`](https://github.com/GoogleChrome/proxy-polyfill) which provides a very little subset of features. +- ES `String#normalize` is not a very useful feature, but this polyfill will be very large. If you need it, you can use [unorm](https://github.com/walling/unorm/). +- ECMA-402 `Intl` is missed because of the size. You can use [those polyfills](https://formatjs.io/docs/polyfills). +- `window.fetch` is not a cross-platform feature, in some environments, it makes no sense. For this reason, I don't think it should be in `core-js`. Looking at a large number of requests it *might be* added in the future. Now you can use, for example, [this polyfill](https://github.com/github/fetch). diff --git a/docs/usage.md b/docs/usage.md new file mode 100644 index 000000000000..cea3b55540bd --- /dev/null +++ b/docs/usage.md @@ -0,0 +1,240 @@ +# Index +- [Installation](#installation) +- [`postinstall` message](#postinstall-message) +- [CommonJS API](#commonjs-api) +- [Babel](#babel) + - [`@babel/polyfill`](#babelpolyfill) + - [`@babel/preset-env`](#babelpreset-env) + - [`@babel/runtime`](#babelruntime) +- [swc](#swc) +- [Configurable level of aggressiveness](#configurable-level-of-aggressiveness) +- [Custom build](#custom-build) + +# Installation:[⬆](#index) +``` +// global version +npm install --save core-js@3.25.1 +// version without global namespace pollution +npm install --save core-js-pure@3.25.1 +// bundled global version +npm install --save core-js-bundle@3.25.1 +``` + +Or you can use `core-js` [from CDN](https://www.jsdelivr.com/package/npm/core-js-bundle). + +# `postinstall` message[⬆](#index) +The `core-js` project needs your help, so the package shows a message about it after installation. If it causes problems for you, you can disable it: +``` +ADBLOCK=true npm install +// or +DISABLE_OPENCOLLECTIVE=true npm install +// or +npm install --loglevel silent +``` + +# CommonJS API[⬆](#index) +You can import only-required-for-you polyfills, like in examples at the top of `README.md`. Available CommonJS entry points for all polyfilled methods / constructors and namespaces. Just some examples: + +```js +// polyfill all `core-js` features, including early-stage proposals: +import "core-js"; +// or: +import "core-js/full"; +// polyfill all actual features - stable ES, web standards and stage 3 ES proposals: +import "core-js/actual"; +// polyfill only stable features - ES and web standards: +import "core-js/stable"; +// polyfill only stable ES features: +import "core-js/es"; + +// if you want to polyfill `Set`: +// all `Set`-related features, with early-stage ES proposals: +import "core-js/full/set"; +// stable required for `Set` ES features, features from web standards and stage 3 ES proposals: +import "core-js/actual/set"; +// stable required for `Set` ES features and features from web standards +// (DOM collections iterator in this case): +import "core-js/stable/set"; +// only stable ES features required for `Set`: +import "core-js/es/set"; +// the same without global namespace pollution: +import Set from "core-js-pure/full/set"; +import Set from "core-js-pure/actual/set"; +import Set from "core-js-pure/stable/set"; +import Set from "core-js-pure/es/set"; + +// if you want to polyfill just required methods: +import "core-js/full/set/intersection"; +import "core-js/actual/array/find-last"; +import "core-js/stable/queue-microtask"; +import "core-js/es/array/from"; + +// polyfill iterator helpers proposal: +import "core-js/proposals/iterator-helpers"; +// polyfill all stage 2+ proposals: +import "core-js/stage/2"; +``` + +**Note: The usage of the `/actual/` namespace is recommended since it includes all actual JavaScript features and does not include unstable early-stage proposals that are available mainly for experiments.** + +### Caveats when using CommonJS API:[⬆](#index) +* `modules` path is an internal API, does not inject all required dependencies and can be changed in minor or patch releases. Use it only for a custom build and/or if you know what are you doing. +* If you use `core-js` with the extension of native objects, recommended load all `core-js` modules at the top of the entry point of your application, otherwise, you can have conflicts. + * For example, Google Maps use their own `Symbol.iterator`, conflicting with `Array.from`, `URLSearchParams` and/or something else from `core-js`, see [related issues](https://github.com/zloirock/core-js/search?q=Google+Maps&type=Issues). + * Such conflicts also resolvable by discovering and manual adding each conflicting entry from `core-js`. +* `core-js` is extremely modular and uses a lot of very tiny modules, because of that for usage in browsers bundle up `core-js` instead of usage loader for each file, otherwise, you will have hundreds of requests. + +## CommonJS and prototype methods without global namespace pollution[⬆](#index) +In the `pure` version, we can't pollute prototypes of native constructors. Because of that, prototype methods transformed into static methods like in examples above. But with transpilers, we can use one more trick - [bind operator and virtual methods](https://github.com/tc39/proposal-bind-operator). Special for that, available `/virtual/` entry points. Example: +```js +import fill from 'core-js-pure/actual/array/virtual/fill'; +import findIndex from 'core-js-pure/actual/array/virtual/find-index'; + +Array(10)::fill(0).map((a, b) => b * b)::findIndex(it => it && !(it % 8)); // => 4 +``` + +> **Warning!** The bind operator is an early-stage ECMAScript proposal and usage of this syntax can be dangerous. + +# Babel[⬆](#index) + +`core-js` is integrated with `babel` and is the base for polyfilling-related `babel` features: + +## `@babel/polyfill`[⬆](#index) + +[`@babel/polyfill`](https://babeljs.io/docs/usage/polyfill) [**IS** just the import of stable `core-js` features and `regenerator-runtime`](https://github.com/babel/babel/blob/c8bb4500326700e7dc68ce8c4b90b6482c48d82f/packages/babel-polyfill/src/index.js) for generators and async functions, so if you load `@babel/polyfill` - you load the global version of `core-js` without ES proposals. + +Now it's deprecated in favour of separate inclusion of required parts of `core-js` and `regenerator-runtime` and, for preventing breaking changes, left on `core-js@2`. + +As a full equal of `@babel/polyfill`, you can use this: +```js +import 'core-js/stable'; +import 'regenerator-runtime/runtime'; +``` + +## `@babel/preset-env`[⬆](#index) + +[`@babel/preset-env`](https://github.com/babel/babel/tree/master/packages/babel-preset-env) has `useBuiltIns` option, which optimizes working with global version of `core-js`. With `useBuiltIns` option, you should also set `corejs` option to used version of `core-js`, like `corejs: '3.25'`. + +> **Warning!** Recommended to specify used minor `core-js` version, like `corejs: '3.25'`, instead of `corejs: 3`, since with `corejs: 3` will not be injected modules which were added in minor `core-js` releases. + +- `useBuiltIns: 'entry'` replaces imports of `core-js` to import only required for a target environment modules. So, for example, +```js +import 'core-js/stable'; +``` +with `chrome 71` target will be replaced just to: +```js +import "core-js/modules/es.array.unscopables.flat"; +import "core-js/modules/es.array.unscopables.flat-map"; +import "core-js/modules/es.object.from-entries"; +import "core-js/modules/web.immediate"; +``` +It works for all entry points of global version of `core-js` and their combinations, for example for +```js +import 'core-js/es'; +import 'core-js/proposals/set-methods'; +import 'core-js/full/set/map'; +``` +with `chrome 71` target you will have as a result: +```js +import "core-js/modules/es.array.unscopables.flat"; +import "core-js/modules/es.array.unscopables.flat-map"; +import "core-js/modules/es.object.from-entries"; +import "core-js/modules/esnext.set.difference"; +import "core-js/modules/esnext.set.intersection"; +import "core-js/modules/esnext.set.is-disjoint-from"; +import "core-js/modules/esnext.set.is-subset-of"; +import "core-js/modules/esnext.set.is-superset-of"; +import "core-js/modules/esnext.set.map"; +import "core-js/modules/esnext.set.symmetric-difference"; +import "core-js/modules/esnext.set.union"; +``` + +- `useBuiltIns: 'usage'` adds to the top of each file import of polyfills for features used in this file and not supported by target environments, so for: +```js +// first file: +var set = new Set([1, 2, 3]); + +// second file: +var array = Array.of(1, 2, 3); +``` +if target contains an old environment like `IE 11` we will have something like: +```js +// first file: +import 'core-js/modules/es.array.iterator'; +import 'core-js/modules/es.object.to-string'; +import 'core-js/modules/es.set'; +var set = new Set([1, 2, 3]); + +// second file: +import 'core-js/modules/es.array.of'; +var array = Array.of(1, 2, 3); +``` + +By default, `@babel/preset-env` with `useBuiltIns: 'usage'` option only polyfills stable features, but you can enable polyfilling of proposals by `proposals` option, as `corejs: { version: '3.25', proposals: true }`. + +> **Warning!** In the case of `useBuiltIns: 'usage'`, you should not add `core-js` imports by yourself, they will be added automatically. + +## `@babel/runtime`[⬆](#index) + +[`@babel/runtime`](https://babeljs.io/docs/plugins/transform-runtime/) with `corejs: 3` option simplifies work with `core-js-pure`. It automatically replaces usage of modern features from JS standard library to imports from the version of `core-js` without global namespace pollution, so instead of: +```js +import from from 'core-js-pure/stable/array/from'; +import flat from 'core-js-pure/stable/array/flat'; +import Set from 'core-js-pure/stable/set'; +import Promise from 'core-js-pure/stable/promise'; + +from(new Set([1, 2, 3, 2, 1])); +flat([1, [2, 3], [4, [5]]], 2); +Promise.resolve(32).then(x => console.log(x)); +``` +you can write just: +```js +Array.from(new Set([1, 2, 3, 2, 1])); +[1, [2, 3], [4, [5]]].flat(2); +Promise.resolve(32).then(x => console.log(x)); +``` + +By default, `@babel/runtime` only polyfills stable features, but like in `@babel/preset-env`, you can enable polyfilling of proposals by `proposals` option, as `corejs: { version: 3, proposals: true }`. + +> **Warning!** If you use `@babel/preset-env` and `@babel/runtime` together, use `corejs` option only in one place since it's duplicate functionality and will cause conflicts. + +# swc[⬆](#index) + +Fast JavaScript transpiler `swc` [contains integration with `core-js`](https://swc.rs/docs/configuration/supported-browsers), that optimizes work with the global version of `core-js`. [Like `@babel/preset-env`](#babelpreset-env), it has 2 modes: `usage` and `entry`, but `usage` mode still works not so good like in `babel`. Example of configuration in `.swcrc`: +```json +{ + "env": { + "targets": "> 0.25%, not dead", + "mode": "entry", + "coreJs": "3.25" + } +} +``` + +# Configurable level of aggressiveness[⬆](#index) + +By default, `core-js` sets polyfills only when they are required. That means that `core-js` checks if a feature is available and works correctly or not and if it has no problems, `core-js` use native implementation. + +But sometimes `core-js` feature detection could be too strict for your case. For example, `Promise` constructor requires the support of unhandled rejection tracking and `@@species`. + +Sometimes we could have inverse problem - knowingly broken environment with problems not covered by `core-js` feature detection. + +For those cases, we could redefine this behaviour for certain polyfills: + +```js +const configurator = require('core-js/configurator'); + +configurator({ + useNative: ['Promise'], // polyfills will be used only if natives completely unavailable + usePolyfill: ['Array.from', 'String.prototype.padEnd'], // polyfills will be used anyway + useFeatureDetection: ['Map', 'Set'], // default behaviour +}); + +require('core-js/actual'); +``` + +It does not work with some features. Also, if you change the default behaviour, even `core-js` internals may not work correctly. + +# Custom build[⬆](#index) + +For some cases could be useful to exclude some `core-js` features or generate a polyfill for target engines. You could use [`core-js-builder`](/packages/core-js-builder) package for that. diff --git a/docs/zh_CN/2019-03-19-core-js-3-babel-and-a-look-into-the-future.md b/docs/zh_CN/2019-03-19-core-js-3-babel-and-a-look-into-the-future.md index cc7cf78fd788..57bff18233e4 100644 --- a/docs/zh_CN/2019-03-19-core-js-3-babel-and-a-look-into-the-future.md +++ b/docs/zh_CN/2019-03-19-core-js-3-babel-and-a-look-into-the-future.md @@ -218,7 +218,7 @@ import "regenerator-runtime/runtime"; 别忘记直接安装这两个依赖！ -```js +```sh npm i --save core-js regenerator-runtime ```