関数の概要
assert.ifErrorとは、Node.jsのアサーションモジュール(assert)に含まれる関数の1つです。この関数は、引数が真偽値として評価されるかどうかをチェックし、エラーがあればそれをthrowします。主な目的は、非同期処理でのエラーハンドリングに使用されます。
パラメータの説明
パラメータ | 型 | 用途 |
---|---|---|
err | Errorオブジェクト | チェックするエラーオブジェクト |
戻り値
assert.ifErrorは、引数がnullまたはundefinedでない場合にエラーをthrowします。戻り値は定義されておらず、同期的にエラーチェックを行います。
使用例
以下に、assert.ifErrorの使用例を示します。
const assert = require('assert');
let err = new Error('エラーメッセージ');
assert.ifError(err); // エラーが発生し、throwされる
関連する関数
assertモジュールには、同様の目的で使われる関数としてassert.okやassert.strictEqualなどがあります。
まとめ
assert.ifErrorは、エラーハンドリングを行う際に便利な関数です。引数がnullまたはundefinedでない場合にエラーを発生させるため、エラーが想定外の場合に即座に通知することができます。