【Node.js24.x】ok::partialDeepStrictEqual()メソッドの使い方

partialDeepStrictEqualメソッドは、主にプログラムのテストや検証において、2つの値が部分的に、かつ深く厳密に等しいかどうかを比較するメソッドです。このメソッドは、期待される値と実際の値の2つの引数を受け取ります。

ここでいう「深い」比較とは、比較対象がオブジェクトや配列のように内部に他の値を含む複雑なデータ構造である場合、そのネストされたプロパティや要素についても再帰的に確認することを意味します。「厳密な」比較は、値だけでなくデータ型も完全に一致するかどうかを厳格にチェックします。そして、このメソッドの最大の特徴は「部分的」な比較を行う点にあります。

「部分的」な比較とは、期待される値のすべてのプロパティと値が、実際の値にも厳密に存在していれば成功と判断されることです。実際の値が期待される値にない追加プロパティを持っていたとしても、この比較は失敗しません。この特性は、データ構造全体ではなく、特定の重要な部分だけが正しいことを確認したい場合に特に有効です。APIの応答やデータベースから取得したオブジェクトの一部を検証する際に役立ち、システムの柔軟かつ効率的な検証を通じて、質の高いソフトウェア開発に貢献します。

Copy
1const actualObject = { id: 1, name: 'Alice', details: { age: 30, city: 'New York' }, isActive: true };
2const expectedPartial = { name: 'Alice', details: { age: 30 } };
3
4ok.partialDeepStrictEqual(actualObject, expectedPartial, '指定された部分が厳密に一致しませんでした');

actual, expected, message

• actual: any: 比較対象となる値
• expected: any: 比較されるべき期待値
• message: string: アサーションが失敗した場合に表示されるエラーメッセージ

戻り値なし

戻り値はありません