【Node.js24.x】ok::rejects()メソッドの使い方
rejectsメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
rejectsメソッドは、非同期処理が期待通りに失敗（拒否）することを検証するメソッドです。これは主に、Promiseを返す非同期コードの単体テストにおいて、エラーハンドリングが正しく機能しているかを確認するために利用されます。
このメソッドは、Node.jsのassertモジュールの一部として提供されており、Promiseを返す関数、またはPromiseオブジェクト自体を最初の引数として受け取ります。rejectsメソッドは、そのPromiseが最終的に拒否された場合にテストを成功と判断します。もしPromiseが成功裏に解決された場合や、全く拒否されなかった場合は、テストが失敗したとみなされます。
さらに、2番目の引数として、期待されるエラーの型（コンストラクタ）、正規表現、またはカスタム検証関数を指定することで、単に失敗しただけでなく、特定の原因や内容のエラーで拒否されたかを詳細に検証することも可能です。これにより、アプリケーションが予期せぬエラーではなく、設計通りのエラー処理を行っていることを保証できます。非同期処理の信頼性を高め、堅牢なシステムを構築する上で不可欠なツールです。
構文(syntax)
ok.rejects(asyncFnOrPromise, expectedError?, failureMessage?);
引数(parameters)
asyncFn, error, message
- asyncFn: Function: 非同期関数
- error: Error: 期待されるエラーオブジェクト
- message: string: エラーメッセージ
戻り値(return)
Promise<void>
このメソッドは、指定された条件が満たされない場合に Promise を拒否（reject）します。Promise が正常に完了した場合、値は返されません。