util 是一個(gè)Node.js 核心模塊,提供常用函數(shù)的集合,用于彌補(bǔ)核心 JavaScript 的功能 過(guò)于精簡(jiǎn)的不足。
使用方法如下:
const util = require('util');
util.callbackify(original) 將 async 異步函數(shù)(或者一個(gè)返回值為 Promise 的函數(shù))轉(zhuǎn)換成遵循異常優(yōu)先的回調(diào)風(fēng)格的函數(shù),例如將 (err, value) => ... 回調(diào)作為最后一個(gè)參數(shù)。 在回調(diào)函數(shù)中,第一個(gè)參數(shù)為拒絕的原因(如果 Promise 解決,則為 null),第二個(gè)參數(shù)則是解決的值。
const util = require('util');
async function fn() {
return 'hello world';
}
const callbackFunction = util.callbackify(fn);
callbackFunction((err, ret) => {
if (err) throw err;
console.log(ret);
});
以上代碼輸出結(jié)果為:
hello world
回調(diào)函數(shù)是異步執(zhí)行的,并且有異常堆棧錯(cuò)誤追蹤。 如果回調(diào)函數(shù)拋出一個(gè)異常,進(jìn)程會(huì)觸發(fā)一個(gè) 'uncaughtException' 異常,如果沒(méi)有被捕獲,進(jìn)程將會(huì)退出。
null 在回調(diào)函數(shù)中作為一個(gè)參數(shù)有其特殊的意義,如果回調(diào)函數(shù)的首個(gè)參數(shù)為 Promise 拒絕的原因且?guī)в蟹祷刂?,且值可以轉(zhuǎn)換成布爾值 false,這個(gè)值會(huì)被封裝在 Error 對(duì)象里,可以通過(guò)屬性 reason 獲取。
function fn() {
return Promise.reject(null);
}
const callbackFunction = util.callbackify(fn);
callbackFunction((err, ret) => {
// 當(dāng) Promise 被以 `null` 拒絕時(shí),它被包裝為 Error 并且原始值存儲(chǔ)在 `reason` 中。
err && err.hasOwnProperty('reason') && err.reason === null; // true
});
original 為 async 異步函數(shù)。該函數(shù)返回傳統(tǒng)回調(diào)函數(shù)。
util.inherits(constructor, superConstructor) 是一個(gè)實(shí)現(xiàn)對(duì)象間原型繼承的函數(shù)。
JavaScript 的面向?qū)ο筇匦允腔谠偷?,與常見(jiàn)的基于類的不同。JavaScript 沒(méi)有提供對(duì)象繼承的語(yǔ)言級(jí)別特性,而是通過(guò)原型復(fù)制來(lái)實(shí)現(xiàn)的。
在這里我們只介紹 util.inherits 的用法,示例如下:
var util = require('util');
function Base() {
this.name = 'base';
this.base = 1991;
this.sayHello = function() {
console.log('Hello ' + this.name);
};
}
Base.prototype.showName = function() {
console.log(this.name);
};
function Sub() {
this.name = 'sub';
}
util.inherits(Sub, Base);
var objBase = new Base();
objBase.showName();
objBase.sayHello();
console.log(objBase);
var objSub = new Sub();
objSub.showName();
//objSub.sayHello();
console.log(objSub);
我們定義了一個(gè)基礎(chǔ)對(duì)象 Base 和一個(gè)繼承自 Base 的 Sub,Base 有三個(gè)在構(gòu)造函數(shù)內(nèi)定義的屬性和一個(gè)原型中定義的函數(shù),通過(guò)util.inherits 實(shí)現(xiàn)繼承。運(yùn)行結(jié)果如下:
base
Hello base
{ name: 'base', base: 1991, sayHello: [Function] }
sub
{ name: 'sub' }
注意:Sub 僅僅繼承了Base 在原型中定義的函數(shù),而構(gòu)造函數(shù)內(nèi)部創(chuàng)造的 base 屬 性和 sayHello 函數(shù)都沒(méi)有被 Sub 繼承。
同時(shí),在原型中定義的屬性不會(huì)被 console.log 作 為對(duì)象的屬性輸出。如果我們?nèi)サ?objSub.sayHello(); 這行的注釋,將會(huì)看到:
node.js:201
throw e; // process.nextTick error, or 'error' event on first tick
^
TypeError: Object #<Sub> has no method 'sayHello'
at Object.<anonymous> (/home/byvoid/utilinherits.js:29:8)
at Module._compile (module.js:441:26)
at Object..js (module.js:459:10)
at Module.load (module.js:348:31)
at Function._load (module.js:308:12)
at Array.0 (module.js:479:10)
at EventEmitter._tickCallback (node.js:192:40)
util.inspect(object,[showHidden],[depth],[colors]) 是一個(gè)將任意對(duì)象轉(zhuǎn)換 為字符串的方法,通常用于調(diào)試和錯(cuò)誤輸出。它至少接受一個(gè)參數(shù) object,即要轉(zhuǎn)換的對(duì)象。
showHidden 是一個(gè)可選參數(shù),如果值為 true,將會(huì)輸出更多隱藏信息。
depth 表示最大遞歸的層數(shù),如果對(duì)象很復(fù)雜,你可以指定層數(shù)以控制輸出信息的多 少。如果不指定depth,默認(rèn)會(huì)遞歸 2 層,指定為 null 表示將不限遞歸層數(shù)完整遍歷對(duì)象。 如果 colors 值為 true,輸出格式將會(huì)以 ANSI 顏色編碼,通常用于在終端顯示更漂亮 的效果。
特別要指出的是,util.inspect 并不會(huì)簡(jiǎn)單地直接把對(duì)象轉(zhuǎn)換為字符串,即使該對(duì) 象定義了 toString 方法也不會(huì)調(diào)用。
var util = require('util');
function Person() {
this.name = 'byvoid';
this.toString = function() {
return this.name;
};
}
var obj = new Person();
console.log(util.inspect(obj));
console.log(util.inspect(obj, true));
運(yùn)行結(jié)果是:
Person { name: 'byvoid', toString: [Function] }
Person {
name: 'byvoid',
toString:
{ [Function]
[length]: 0,
[name]: '',
[arguments]: null,
[caller]: null,
[prototype]: { [constructor]: [Circular] } } }
如果給定的參數(shù) "object" 是一個(gè)數(shù)組返回 true,否則返回 false。
var util = require('util');
util.isArray([])
// true
util.isArray(new Array)
// true
util.isArray({})
// false
如果給定的參數(shù) "object" 是一個(gè)正則表達(dá)式返回true,否則返回false。
var util = require('util');
util.isRegExp(/some regexp/)
// true
util.isRegExp(new RegExp('another regexp'))
// true
util.isRegExp({})
// false
如果給定的參數(shù) "object" 是一個(gè)日期返回true,否則返回false。
var util = require('util');
util.isDate(new Date())
// true
util.isDate(Date())
// false (without 'new' returns a String)
util.isDate({})
// false
更多詳情可以訪問(wèn) http://nodejs.org/api/util.html 了解詳細(xì)內(nèi)容。
更多建議: