Function strictEqual

  • Tests strict equality between the actual and expected parameters as determined by Object.is().

    import assert from 'assert/strict';

    assert.strictEqual(1, 2);
    // AssertionError [ERR_ASSERTION]: Expected inputs to be strictly equal:
    //
    // 1 !== 2

    assert.strictEqual(1, 1);
    // OK

    assert.strictEqual('Hello foobar', 'Hello World!');
    // AssertionError [ERR_ASSERTION]: Expected inputs to be strictly equal:
    // + actual - expected
    //
    // + 'Hello foobar'
    // - 'Hello World!'
    // ^

    const apples = 1;
    const oranges = 2;
    assert.strictEqual(apples, oranges, `apples ${apples} !== oranges ${oranges}`);
    // AssertionError [ERR_ASSERTION]: apples 1 !== oranges 2

    assert.strictEqual(1, '1', new TypeError('Inputs are not identical'));
    // TypeError: Inputs are not identical

    If the values are not strictly equal, an AssertionError is thrown with amessage property set equal to the value of the message parameter. If themessage parameter is undefined, a default error message is assigned. If themessage parameter is an instance of an Error then it will be thrown instead of the AssertionError.

    Type Parameters

    • T

    Parameters

    • actual: unknown
    • expected: T
    • Optional message: string | Error

    Returns asserts actual is T

Generated using TypeDoc