Assert
Stability: 2 - Stable 穩定
Assert - Node.js 的斷言庫
在 Node.js 的開發過程中，Assert 絕對是必不可少的模塊，本文將會結合官方文檔系統地為您介紹一些實用的 API。
assert(value[, message])、assert.ok(value[, message])
這兩個 API 的功能是一樣的，判斷 value 是否為真，如果不為真，則會拋出 AssertionError 類型的錯誤
const assert = require('assert');
assert.ok(true);
// OK
assert.ok(1);
// OK
assert.ok(false);
// throws "AssertionError: false == true"
assert.ok(0);
// throws "AssertionError: 0 == true"
assert.ok(false, 'it\'s false');
// throws "AssertionError: it's false"
// assert.ok() 可以替換成 assert()
assert.equal(actual, expected[, message])
- assert.notEqual(actual, expected[, message]) 如果
actual != expected為真，則不會拋出錯誤，否則拋出AssertionError類型的錯誤
assert.notEqual(actual, expected[, message])
- assert.notEqual(actual, expected[, message]) 如果
actual != expected為真，則不會拋出錯誤，否則拋出AssertionError類型的錯誤
assert.strictEqual(actual, expected[, message])
- assert.strictEqual(actual, expected[, message]) 如果
actual === expected為真，則不會拋出錯誤，否則拋出AssertionError類型的錯誤
assert.notStrictEqual(actual, expected[, message])
- assert.notStrictEqual(actual, expected[, message]) 如果
actual !== expected為真，則不會拋出錯誤，否則拋出AssertionError類型的錯誤
注意：上面這4個 API 只能判斷基本數據類型（數字，字符串等），不能判斷復雜數據類型（對象，數組等），否則會得到非預期的結果
const assert = require('assert');
assert.equal(1, 1);
// OK, 1 == 1
assert.equal(1, '1');
// OK, 1 == '1'
assert.equal(1, 2);
// AssertionError: 1 == 2
assert.equal({a: {b: 1}}, {a: {b: 1}});
// AssertionError: { a: { b: 1 } } == { a: { b: 1 } } 復雜數據類型無法判斷出預期的結果
assert.ifError(value)
如果 value 是真，則拋出 value，這個方法經常用作判斷回調函數的 error 參數
const fs = require('fs')
const assert = require('assert')
fs.readFile('/etc/passwd', (err, data) => {
assert.ifError(err)
// todo
});
assert.fail(actual, expected, message, operator)
拋出一個 AssertionError 錯誤，如果 message 是真，則錯誤信息是 message，否則錯誤信息是 actual， operator，expected 連接的字符串
const assert = require('assert');
assert.fail(1, 2, undefined, '>');
// AssertionError: 1 > 2
assert.fail(1, 2, 'whoops', '>');
// AssertionError: whoops
assert.throws(block[, error][, message])
該 API 通過參數 block 拋出一個錯誤，用 error 參數進行驗證拋出的錯誤是否符合預期，如果不符合，則會拋出錯誤，如果拋出錯誤失敗，且指定了參數 message，則會拋出一個錯誤，錯誤信息是 message。error 參數可以是構造函數，正則表達式，和自定義的函數，不能是字符串，否則會出現非預期的結果
const assert = require('assert')
assert.throws(
() => {
throw new Error();
},
Error
);
assert.throws(
() => {
throw new Error('Wrong value');
},
/value/
);
assert.throws(
() => {
throw new Error('Wrong value');
},
function(err) {
if ((err instanceof Error) && /value/.test(err)) {
return true;
}
},
'unexpected error'
);
// 沒有拋出錯誤，則會顯示 message
assert.throws(
() => {},
/test/,
'throw error failed'
);
assert.doesNotThrow(block[, error][, message])
該 API 是驗證參數 block 沒有拋出錯誤的情況，如果拋出了錯誤，且拋出錯誤的類型與參數 error 一致，則拋出 AssertionError 錯誤；如果不一致，則直接把 block 的錯誤拋出
const assert = require('assert')
// 類型不一樣，直接拋出TypeError
assert.doesNotThrow(
() => {
throw new TypeError('Wrong value');
},
SyntaxError
);
// 類型一樣，拋出 AssertionError
assert.doesNotThrow(
() => {
throw new TypeError('Wrong value');
},
TypeError
);
// 拋出的 AssertionError 帶有 message 信息
assert.doesNotThrow(
() => {
throw new TypeError('Wrong value');
},
TypeError,
'Whoops'
);
// Throws: AssertionError: Got unwanted exception (TypeError). Whoops
// 不會拋出錯誤
assert.doesNotThrow(
() => {},
TypeError
);
assert.deepEqual(actual, expected[, message])、assert.notDeepEqual(actual, expected[, message])
assert.deepEqual(actual, expected[, message]) 使用 == 比較參數 actual 和 expected 的屬性值，如果為真，則不會拋出錯誤，否則，拋出 AssertionError 錯誤。其功能與 assert.notDeepEqual(actual, expected[, message]) 相反
assert.deepStrictEqual(actual, expected[, message])、assert.notDeepStrictEqual(actual, expected[, message])
assert.deepStrictEqual(actual, expected[, message]) 使用 === 比較參數 actual 和 expected 的屬性值，如果為真，則不會拋出錯誤，否則，拋出 AssertionError 錯誤。其功能與 assert.notDeepEqual(actual, expected[, message]) 相反
注意：上面4個 API 只會判定可枚舉屬性，對象的原型 prototypes, 符號attached symbols，和不可枚舉屬性無法判定
const assert = require('assert');
// Error的屬性是不可枚舉的，所以不會拋出錯誤
assert.deepEqual(Error('a'), Error('b'));
const obj1 = {
a: {
b: 1
}
};
const obj2 = {
a: {
b: 2
}
};
const obj3 = {
a: {
b: 1
}
};
const obj4 = Object.create(obj1);
assert.deepEqual(obj1, obj1);
// OK, object is equal to itself
assert.deepEqual(obj1, obj2);
// AssertionError: { a: { b: 1 } } deepEqual { a: { b: 2 } }
// values of b are different
assert.deepEqual(obj1, obj3);
// OK, objects are equal
assert.deepEqual(obj1, obj4);
// AssertionError: { a: { b: 1 } } deepEqual {}
// Prototypes are ignored
- Node.js Assertion Testing 官方文檔。
- Node.js 文檔版本為： v6.11.3
簡書作者 小菜荔枝原創 轉載請聯系作者獲得授權
