update docs

zloirock · Dec 2, 2021 · fe7d4c0 · fe7d4c0
1 parent 7391801
commit fe7d4c0
Show file tree

Hide file tree

Showing 2 changed files with 72 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 ## Changelog
 ##### Unreleased
+- Added `DOMException` polyfill, [the Web IDL spec](https://webidl.spec.whatwg.org/#idl-DOMException), [see MDN](https://developer.mozilla.org/en-US/docs/Web/API/DOMException)
+  - Includes `DOMException` and its attributes polyfills with fixes of many different engines bugs
+  - Includes `DOMException#stack` property polyfill in engines that should have it
+  - Reuses native `DOMException` implementations where it's possible (for example, in old NodeJS where it's not exposed as global)
+- Added `Error.prototype.toString` polyfill with many different engines bugs fixes
 - Added NodeJS 17.2 compat data mapping
 
 ##### 3.19.2 - 2021.11.29

diff --git a/README.md b/README.md
@@ -81,6 +81,7 @@ Promise.resolve(32).then(x => console.log(x)); // => 32
   - [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)
@@ -129,6 +130,7 @@ Promise.resolve(32).then(x => console.log(x)); // => 32
     - [`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)
@@ -532,8 +534,8 @@ class Function {
 core-js/es|stable|features/function
 core-js/es|stable|features/function/name
 core-js/es|stable|features/function/has-instance
-core-js/es|stable|features/function/bind
-core-js/es|stable|features/function/virtual/bind
+core-js(-pure)/es|stable|features/function/bind
+core-js(-pure)/es|stable|features/function/virtual/bind
 ```
 [*Example*](http://goo.gl/zqu3Wp):
 ```js
@@ -542,6 +544,36 @@ core-js/es|stable|features/function/virtual/bind
 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.error.to-string`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.error.to-string.js).
+```js
+class AggregateError {
+  constructor(errors: Iterable, message: string, { cause: any }): AggregateError;
+  errors: Array<any>;
+  message: string;
+}
+
+class Error {
+  toString(): string; // different fixes
+}
+```
+[*CommonJS entry points:*](#commonjs-api)
+```
+core-js(-pure)/es|stable|features/aggregate-error
+core-js/es|stable|features/error
+core-js/es|stable|features/error/to-string
+```
+[*Example*](is.gd/bS2xte):
+```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
+
+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.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.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.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
@@ -1006,14 +1038,8 @@ core-js(-pure)/es|stable|features/date/to-primitive
 new Date(NaN).toString(); // => 'Invalid Date'
 ```
 #### ECMAScript: Promise[⬆](#index)
-Modules [`es.aggregate-error`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.aggregate-error.js), [`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).
+Modules [`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 AggregateError {
-  constructor(errors: Iterable, message: string): AggregateError;
-  errors: Array<any>;
-  message: string;
-}
-
 class Promise {
   constructor(executor: (resolve: Function, reject: Function) => void): Promise;
   then(onFulfilled: Function, onRejected: Function): Promise;
@@ -1029,7 +1055,6 @@ class Promise {
 ```
 [*CommonJS entry points:*](#commonjs-api)
 ```
-core-js(-pure)/es|stable|features/aggregate-error
 core-js(-pure)/es|stable|features/promise
 core-js(-pure)/es|stable|features/promise/all-settled
 core-js(-pure)/es|stable|features/promise/any
@@ -2848,6 +2873,38 @@ console.log(params.toString()); // => 'a=1&a=3&a=2&b=2&c=4'
 - 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|features/dom-exception
+core-js(-pure)/stable|features/dom-exception/constructor
+core-js/stable|features/dom-exception/to-string-tag
+```
+[*Examples*](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