【Node.js24.x】ok::equal()メソッドの使い方
equalメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
equalメソッドは、Node.jsのassertモジュールが提供するアサーションメソッドの一つで、主にプログラムのテストにおいて、2つの値が等しいかどうかを検証するために使用されるメソッドです。
このメソッドは、第一引数に実際の結果（actual）を、第二引数に期待される結果（expected）を受け取ります。内部的には、JavaScriptの緩やかな等価演算子（==）を用いてこれら2つの値を比較します。例えば、数値の1と文字列の'1'は、この演算子では等しいと判断されます。
もし比較の結果、actualとexpectedが等しくないと判断された場合、equalメソッドはAssertionErrorと呼ばれるエラーをスローし、プログラムの実行を中断します。これにより、テストが失敗したことを明確に示します。
さらに、このメソッドはオプションとして第三引数にメッセージを受け取ることができます。このメッセージは、アサーションが失敗してエラーがスローされた際に、エラー情報の一部として出力されます。これにより、テストがなぜ失敗したのか、より詳細な情報を提供することが可能になり、問題の特定とデバッグを効率化できます。
値の型を変換してでも比較したい場合に便利ですが、値と型の両方が厳密に一致することを検証したい場合には、assert.strictEqual()メソッドの使用が推奨されます。
構文(syntax)
1const assert = require('node:assert'); 2 3assert.equal(actual, expected[, message]);
引数(parameters)
actual, expected, message
- actual: any: 比較対象となる実際の値
- expected: any: 比較対象となる期待される値
- message: string: アサーションが失敗した場合に表示されるオプションのエラーメッセージ
戻り値(return)
戻り値なし
戻り値はありません