【Node.js24.x】ok::doesNotReject()メソッドの使い方
doesNotRejectメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
doesNotRejectメソッドは、非同期処理がエラーによって拒否(reject)されないことを検証するメソッドです。
このメソッドはNode.jsのassertモジュールが提供する機能の一つで、主にテストコードにおいて、特定の非同期処理が期待通りに成功し、エラーで終了しないことを保証するために使用されます。具体的には、Promiseを返す関数、またはPromiseオブジェクトを引数として受け取ります。doesNotRejectメソッドは、この非同期処理が解決(resolve)されることを待ちます。もし非同期処理が正常に完了し、拒否されなかった場合、メソッドは何事もなく終了し、処理は継続されます。
しかし、もし指定された非同期処理が何らかのエラーによって拒否された場合、このメソッドはAssertionErrorをスローします。これにより、非同期処理が期待に反して失敗したことが明確に通知され、テストの失敗やプログラムの異常終了として扱われます。引数としては、検証対象の非同期処理の他に、オプションで検証失敗時に表示されるカスタムメッセージを指定することができます。非同期処理の安定性と信頼性を確保するために不可欠な検証ツールです。
構文(syntax)
1const assert = require('node:assert'); 2 3async function examplePromiseFunction() { 4 return Promise.resolve('Operation completed successfully.'); 5} 6 7(async () => { 8 await assert.doesNotReject(examplePromiseFunction); 9})();
引数(parameters)
asyncFn, error, message
- asyncFn: Function: 実行する非同期関数
- error: Error: 発生することが期待されるエラーオブジェクト
- message: string: エラー発生時に表示されるメッセージ
戻り値(return)
Promise
指定された非同期処理が、エラーを投げずに成功した場合に解決されるPromiseを返します。