関数の概要
assert.equalは、Node.jsに組み込まれているアサーション関数の1つです。この関数は、2つの値を比較して等しいかどうかをテストするために使用されます。主にテストコードやデバッグ時に、期待される値と実際の値を比較する際に利用されます。
パラメータの説明
| 引数 | 型 | 用途 |
|---|---|---|
| actual | 任意の型 | 実際の値 |
| expected | 任意の型 | 期待する値 |
戻り値
assert.equalは、比較した結果に応じてエラーをスローするかどうかを決定します。返り値自体は特になく、同期的に処理されます。
使用例
以下に、assert.equalの使用例を示します。
const assert = require('assert');
assert.equal(1 + 2, 3, '1 + 2 should equal 3');
assert.equal('hello', 'world', 'This will throw an error');
関連する関数
Node.jsのアサーション関数には、他にもassert.strictEqualやassert.deepStrictEqualなどがあります。これらも値の比較やテストに利用されます。
まとめ
assert.equalは、値の比較を行い、等しい場合には何も起こらず、異なる場合にはエラーをスローします。テストコードを書く際やデバッグ時に、期待値と実際の値を比較して正しく動作しているか確認するのに役立ちます。
