Skip to content

Commit

Permalink
doc: remove SameValue comparison reference
Browse files Browse the repository at this point in the history
Referring to `Object.is()` will be more clear and direct. The
`Object.is()` reference in turn refers to `SameValue` so people can dig
deeper there if they want or need to.

PR-URL: nodejs#41460
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
  • Loading branch information
Trott authored and mawaregetsuka committed Jan 17, 2022
1 parent 1406726 commit 9a6fd84
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions doc/api/assert.md
Expand Up @@ -686,8 +686,7 @@ are recursively evaluated also by the following rules.

### Comparison details

* Primitive values are compared using the [SameValue Comparison][], used by
[`Object.is()`][].
* Primitive values are compared using [`Object.is()`][].
* [Type tags][Object.prototype.toString()] of objects should be the same.
* [`[[Prototype]]`][prototype-spec] of objects are compared using
the [`===` operator][].
Expand Down Expand Up @@ -741,7 +740,7 @@ assert.deepStrictEqual(date, fakeDate);
// - Date {}

assert.deepStrictEqual(NaN, NaN);
// OK, because of the SameValue comparison
// OK because Object.is(NaN, NaN) is true.

// Different unwrapped numbers:
assert.deepStrictEqual(new Number(1), new Number(2));
Expand All @@ -757,7 +756,7 @@ assert.deepStrictEqual(new String('foo'), Object('foo'));
assert.deepStrictEqual(-0, -0);
// OK

// Different zeros using the SameValue Comparison:
// Different zeros:
assert.deepStrictEqual(0, -0);
// AssertionError: Expected inputs to be strictly deep-equal:
// + actual - expected
Expand Down Expand Up @@ -833,7 +832,7 @@ assert.deepStrictEqual(date, fakeDate);
// - Date {}

assert.deepStrictEqual(NaN, NaN);
// OK, because of the SameValue comparison
// OK because Object.is(NaN, NaN) is true.

// Different unwrapped numbers:
assert.deepStrictEqual(new Number(1), new Number(2));
Expand All @@ -849,7 +848,7 @@ assert.deepStrictEqual(new String('foo'), Object('foo'));
assert.deepStrictEqual(-0, -0);
// OK

// Different zeros using the SameValue Comparison:
// Different zeros:
assert.deepStrictEqual(0, -0);
// AssertionError: Expected inputs to be strictly deep-equal:
// + actual - expected
Expand Down Expand Up @@ -1734,7 +1733,7 @@ changes:
* `message` {string|Error}

Tests strict inequality between the `actual` and `expected` parameters as
determined by the [SameValue Comparison][].
determined by [`Object.is()`][].

```mjs
import assert from 'assert/strict';
Expand Down Expand Up @@ -2026,7 +2025,7 @@ changes:
* `message` {string|Error}

Tests strict equality between the `actual` and `expected` parameters as
determined by the [SameValue Comparison][].
determined by [`Object.is()`][].

```mjs
import assert from 'assert/strict';
Expand Down Expand Up @@ -2446,7 +2445,6 @@ argument.

[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
[`!=` operator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Inequality
[`===` operator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Strict_equality
[`==` operator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Equality
Expand Down

0 comments on commit 9a6fd84

Please sign in to comment.