関数の概要
assert.deepEqualは、Node.jsのアサーションモジュールの1つで、2つのオブジェクトが深い等価であるかどうかをテストする関数です。主な目的は、2つのオブジェクトが同じ値を持つかどうかを比較し、テストの結果を返すことです。
パラメータの説明
| 引数 | 型 | 用途 |
|---|---|---|
| actual | 任意の型 | 実際の値 |
| expected | 任意の型 | 期待する値 |
戻り値
assert.deepEqualの戻り値はありません。ただし、引数が等しい場合は何も起こらず、異なる場合はAssertionErrorがスローされます。
使用例
以下にassert.deepEqualの使用例を示します。
const assert = require('assert');
const obj1 = { a: { b: 1 } };
const obj2 = { a: { b: 2 } };
assert.deepEqual(obj1, obj2); // AssertionError関連する関数
- assert.deepStrictEqual: 厳密な等価性をテストする
- assert.equal: 値の等価性をテストする
まとめ
assert.deepEqualは、2つのオブジェクトが深い等価であるかどうかをテストする際に使用されます。オブジェクトのネストした値も比較するため、注意深く使用する必要があります。
