assert.rejects

関数の概要

assert.rejectsは、Node.jsのアサーションライブラリであるassertモジュールに含まれる関数の一つです。この関数は、非同期関数がPromise.rejectを返すことを検証するために使用されます。Promise.rejectを返すことが期待される非同期関数をテストする際に便利です。

パラメータの説明

パラメータ 型 用途
asyncFn Function テスト対象の非同期関数
error RegExp/Error 期待されるエラーメッセージまたはエラーオブジェクト

戻り値

assert.rejectsはPromiseを返し、非同期的にテストを実行します。テストが失敗した場合はエラーをスローします。

使用例

例1：エラーメッセージを検証する


assert.rejects(
  async () => {
    throw new Error('error');
  },
  { message: 'error' }
);

例2：特定のエラーオブジェクトを検証する


assert.rejects(
  async () => {
    throw new TypeError('Type Error');
  },
  TypeError
);

関連する関数

assert.doesNotReject: Promise.resolveを返すことを検証する関数。エラーがスローされないことを確認します。

まとめ

assert.rejectsは、非同期関数がPromise.rejectを返すことを検証する際に使用されます。適切なエラーメッセージやエラーオブジェクトが返されることを確認することができます。テストの際に注意深く使用することで、エラーハンドリングの正確性を確保できます。

スポンサーリンク