summaryrefslogtreecommitdiff
path: root/doc/api/assert.md
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2022-01-05 12:35:02 -0800
committerGitHub <noreply@github.com>2022-01-05 20:35:02 +0000
commit51a28c01951d3848c39be98f12bd93349bbf50cb (patch)
treedab6ca5c662ec04c276694083df6a10e40ddf949 /doc/api/assert.md
parent59558807ceeb84eef6f2f736a440caec5d4a8eee (diff)
downloadnode-new-51a28c01951d3848c39be98f12bd93349bbf50cb.tar.gz
doc: update Abstract Equality Comparison text in assert.md
* Remove link to ECMAScript specification because the term Abstract Equality Comparison is no longer used there. * Edit surprising-results material * Other minor edits PR-URL: https://github.com/nodejs/node/pull/41375 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'doc/api/assert.md')
-rw-r--r--doc/api/assert.md35
1 files changed, 15 insertions, 20 deletions
diff --git a/doc/api/assert.md b/doc/api/assert.md
index c7e679ef81..1295f3b160 100644
--- a/doc/api/assert.md
+++ b/doc/api/assert.md
@@ -104,7 +104,7 @@ more on color support in terminal environments, read the tty
## Legacy assertion mode
-Legacy assertion mode uses the [Abstract Equality Comparison][] in:
+Legacy assertion mode uses the `==` operator in:
* [`assert.deepEqual()`][]
* [`assert.equal()`][]
@@ -121,13 +121,11 @@ import assert from 'assert';
const assert = require('assert');
```
-Whenever possible, use the [strict assertion mode][] instead. Otherwise, the
-[Abstract Equality Comparison][] may cause surprising results. This is
-especially true for [`assert.deepEqual()`][], where the comparison rules are
-lax:
+Legacy assertion mode may have surprising results, especially when using
+[`assert.deepEqual()`][]:
```cjs
-// WARNING: This does not throw an AssertionError!
+// WARNING: This does not throw an AssertionError in legacy assertion mode!
assert.deepEqual(/a/gi, new Date());
```
@@ -476,7 +474,7 @@ changes:
Legacy.
- version: v14.0.0
pr-url: https://github.com/nodejs/node/pull/30766
- description: NaN is now treated as being identical in case both sides are
+ description: NaN is now treated as being identical if both sides are
NaN.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/25008
@@ -526,8 +524,8 @@ are also recursively evaluated by the following rules.
### Comparison details
-* Primitive values are compared with the [Abstract Equality Comparison][]
- ( `==` ) with the exception of `NaN`. It is treated as being identical in case
+* Primitive values are compared with the `==` operator,
+ with the exception of `NaN`. It is treated as being identical in case
both sides are `NaN`.
* [Type tags][Object.prototype.toString()] of objects should be the same.
* Only [enumerable "own" properties][] are considered.
@@ -546,8 +544,7 @@ are also recursively evaluated by the following rules.
are not enumerable properties.
The following example does not throw an [`AssertionError`][] because the
-primitives are considered equal by the [Abstract Equality Comparison][]
-( `==` ).
+primitives are compared using the `==` operator.
```mjs
import assert from 'assert';
@@ -1152,7 +1149,7 @@ changes:
Legacy.
- version: v14.0.0
pr-url: https://github.com/nodejs/node/pull/30766
- description: NaN is now treated as being identical in case both sides are
+ description: NaN is now treated as being identical if both sides are
NaN.
-->
@@ -1169,8 +1166,8 @@ An alias of [`assert.strictEqual()`][].
> Stability: 3 - Legacy: Use [`assert.strictEqual()`][] instead.
Tests shallow, coercive equality between the `actual` and `expected` parameters
-using the [Abstract Equality Comparison][] ( `==` ). `NaN` is special handled
-and treated as being identical in case both sides are `NaN`.
+using the `==` operator. `NaN` is specially handled
+and treated as being identical if both sides are `NaN`.
```mjs
import assert from 'assert';
@@ -1487,7 +1484,7 @@ changes:
Legacy.
- version: v14.0.0
pr-url: https://github.com/nodejs/node/pull/30766
- description: NaN is now treated as being identical in case both sides are
+ description: NaN is now treated as being identical if both sides are
NaN.
- version: v9.0.0
pr-url: https://github.com/nodejs/node/pull/15001
@@ -1671,7 +1668,7 @@ changes:
Legacy.
- version: v14.0.0
pr-url: https://github.com/nodejs/node/pull/30766
- description: NaN is now treated as being identical in case both sides are
+ description: NaN is now treated as being identical if both sides are
NaN.
-->
@@ -1687,8 +1684,8 @@ An alias of [`assert.notStrictEqual()`][].
> Stability: 3 - Legacy: Use [`assert.notStrictEqual()`][] instead.
-Tests shallow, coercive inequality with the [Abstract Equality Comparison][]
-(`!=` ). `NaN` is special handled and treated as being identical in case both
+Tests shallow, coercive inequality with the
+`!=` operator. `NaN` is specially handled and treated as being identical if
sides are `NaN`.
```mjs
@@ -2448,7 +2445,6 @@ assert.throws(throwingFirst, /Second$/);
Due to the confusing error-prone notation, avoid a string as the second
argument.
-[Abstract Equality Comparison]: https://tc39.github.io/ecma262/#sec-abstract-equality-comparison
[Object wrappers]: https://developer.mozilla.org/en-US/docs/Glossary/Primitive#Primitive_wrapper_objects_in_JavaScript
[Object.prototype.toString()]: https://tc39.github.io/ecma262/#sec-object.prototype.tostring
[SameValue Comparison]: https://tc39.github.io/ecma262/#sec-samevalue
@@ -2484,4 +2480,3 @@ argument.
[`tracker.verify()`]: #trackerverify
[enumerable "own" properties]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Enumerability_and_ownership_of_properties
[prototype-spec]: https://tc39.github.io/ecma262/#sec-ordinary-object-internal-methods-and-internal-slots
-[strict assertion mode]: #strict-assertion-mode