Node.js assert 模塊

2021-09-15 16:32 更新

assert模塊是Node的內(nèi)置模塊,主要用于斷言。如果表達(dá)式不符合預(yù)期,就拋出一個(gè)錯(cuò)誤。該模塊提供11個(gè)方法,但只有少數(shù)幾個(gè)是常用的。

assert()

assert方法接受兩個(gè)參數(shù),當(dāng)?shù)谝粋€(gè)參數(shù)對(duì)應(yīng)的布爾值為true時(shí),不會(huì)有任何提示,返回undefined。當(dāng)?shù)谝粋€(gè)參數(shù)對(duì)應(yīng)的布爾值為false時(shí),會(huì)拋出一個(gè)錯(cuò)誤,該錯(cuò)誤的提示信息就是第二個(gè)參數(shù)設(shè)定的字符串。

// 格式
assert(value, message)

// 例子
var assert = require('assert');

function add (a, b) {
  return a + b;
}

var expected = add(1,2);
assert( expected === 3, '預(yù)期1加2等于3');

上面代碼不會(huì)有任何輸出,因?yàn)閍ssert方法的第一個(gè)參數(shù)是true。

assert( expected === 4, '預(yù)期1加2等于3')
// AssertionError: 預(yù)期1加2等于3

上面代碼會(huì)拋出一個(gè)錯(cuò)誤,因?yàn)閍ssert方法的第一個(gè)參數(shù)是false。

assert.ok()

ok是assert方法的另一個(gè)名字,與assert方法完全一樣。

assert.equal()

equal方法接受三個(gè)參數(shù),第一個(gè)參數(shù)是實(shí)際值,第二個(gè)是預(yù)期值,第三個(gè)是錯(cuò)誤的提示信息。

// 格式
assert.equal(actual, expected, [message])

assert.equal(true, value, message);
// 等同于
assert(value, message);

// 例子
var assert = require('assert');

function add (a, b) {
  return a + b;
}

var expected = add(1,2);

// 以下三句效果相同
assert(expected == 3, '預(yù)期1+2等于3');
assert.ok(expected == 3, '預(yù)期1+2等于3');
assert.equal(expected, 3, '預(yù)期1+2等于3');

equal方法內(nèi)部使用的是相等運(yùn)算符(==),而不是嚴(yán)格運(yùn)算符(===),進(jìn)行比較運(yùn)算。

assert.notEqual()

notEqual方法的用法與equal方法類(lèi)似,但只有在實(shí)際值等于預(yù)期值時(shí),才會(huì)拋出錯(cuò)誤。

// 格式
assert.notEqual(actual, expected, [message])

// 用法
var assert = require('assert');

function add (a, b) {
  return a + b;
}

var expected = add(1,2);

// 以下三種寫(xiě)法效果相同
assert(expected != 4, '預(yù)期不等于4');
assert.ok(expected != 4, '預(yù)期不等于4');
assert.notEqual(expected, 4, '預(yù)期不等于4');

notEqual方法內(nèi)部使用不相等運(yùn)算符(!=),而不是嚴(yán)格不相等運(yùn)算符(!==),進(jìn)行比較運(yùn)算。

assert.deepEqual()

deepEqual方法用來(lái)比較兩個(gè)對(duì)象。只要它們的屬性一一對(duì)應(yīng),且值都相等,就認(rèn)為兩個(gè)對(duì)象相等,否則拋出一個(gè)錯(cuò)誤。

// 格式
assert.deepEqual(actual, expected, [message])

// 例子
var assert = require('assert');

var list1 = [1, 2, 3, 4, 5];
var list2 = [1, 2, 3, 4, 5];

assert.deepEqual(list1, list2, '預(yù)期兩個(gè)數(shù)組應(yīng)該有相同的屬性');

var person1 = { "name":"john", "age":"21" };
var person2 = { "name":"john", "age":"21" };

assert.deepEqual(person1, person2, '預(yù)期兩個(gè)對(duì)象應(yīng)該有相同的屬性');

assert.notDeepEqual()

notDeepEqual方法與deepEqual方法正好相反,用來(lái)斷言兩個(gè)對(duì)象是否不相等。

// 格式
assert.notDeepEqual(actual, expected, [message])

// 例子
var assert = require('assert');

var list1 = [1, 2, ,3, 4, 5];
var list2 = [1, 2, 3, 4, 5];

assert.notDeepEqual(list1, list2, '預(yù)期兩個(gè)對(duì)象不相等');

var person1 = { "name":"john", "age":"21" };
var person2 = { "name":"jane", "age":"19" };

// deepEqual checks the elements in the objects are identical
assert.notDeepEqual(person1, person2, '預(yù)期兩個(gè)對(duì)象不相等');

assert.strictEqual()

strictEqual方法使用嚴(yán)格相等運(yùn)算符(===),比較兩個(gè)表達(dá)式。

// 格式
assert.strictEqual(actual, expected, [message])

// 例子
var assert = require('assert');

assert.strictEqual(1, '1', '預(yù)期嚴(yán)格相等');
// AssertionError: 預(yù)期嚴(yán)格相等

assert.notStrictEqual()

assert.notStrictEqual方法使用嚴(yán)格不相等運(yùn)算符(!==),比較兩個(gè)表達(dá)式。

// 格式
assert.notStrictEqual(actual, expected, [message])

// 例子
var assert = require('assert');

assert.notStrictEqual(1, true, '預(yù)期嚴(yán)格不相等');

assert.throws()

throws方法預(yù)期某個(gè)代碼塊會(huì)拋出一個(gè)錯(cuò)誤,且拋出的錯(cuò)誤符合指定的條件。

// 格式
assert.throws(block, [error], [message])

// 例一,拋出的錯(cuò)誤符合某個(gè)構(gòu)造函數(shù)
assert.throws(
  function() {
    throw new Error("Wrong value");
  },
  Error,
  '不符合預(yù)期的錯(cuò)誤類(lèi)型'
);

// 例二、拋出錯(cuò)誤的提示信息符合正則表達(dá)式
assert.throws(
  function() {
    throw new Error("Wrong value");
  },
  /value/,
  '不符合預(yù)期的錯(cuò)誤類(lèi)型'
);

// 例三、拋出的錯(cuò)誤符合自定義函數(shù)的校驗(yàn)
assert.throws(
  function() {
    throw new Error("Wrong value");
  },
  function(err) {
    if ( (err instanceof Error) && /value/.test(err) ) {
      return true;
    }
  },
  '不符合預(yù)期的錯(cuò)誤類(lèi)型'
);

assert.doesNotThrow()

doesNotThrow方法與throws方法正好相反,預(yù)期某個(gè)代碼塊不拋出錯(cuò)誤。

// 格式
assert.doesNotThrow(block, [message])

// 用法
assert.doesNotThrow(
  function() {
    console.log("Nothing to see here");
  },
  '預(yù)期不拋出錯(cuò)誤'
);

assert.ifError()

ifError方法斷言某個(gè)表達(dá)式是否false,如果該表達(dá)式對(duì)應(yīng)的布爾值等于true,就拋出一個(gè)錯(cuò)誤。它對(duì)于驗(yàn)證回調(diào)函數(shù)的第一個(gè)參數(shù)十分有用,如果該參數(shù)為true,就表示有錯(cuò)誤。

// 格式
assert.ifError(value)

// 用法
function sayHello(name, callback) {
  var error = false;
  var str   = "Hello "+name;
  callback(error, str);
}

// use the function
sayHello('World', function(err, value){
  assert.ifError(err);
  // ...
})

assert.fail()

fail方法用于拋出一個(gè)錯(cuò)誤。

// 格式
assert.fail(actual, expected, message, operator)

// 例子
var assert = require('assert');

assert.fail(21, 42, 'Test Failed', '###')
// AssertionError: Test Failed
assert.fail(21, 21, 'Test Failed', '###')
// AssertionError: Test Failed
assert.fail(21, 42, undefined, '###')
// AssertionError: 21 ### 42

該方法共有四個(gè)參數(shù),但是不管參數(shù)是什么值,它總是拋出一個(gè)錯(cuò)誤。如果message參數(shù)對(duì)應(yīng)的布爾值不為false,拋出的錯(cuò)誤信息就是message,否則錯(cuò)誤信息就是“實(shí)際值 + 分隔符 + 預(yù)期值”。

以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)