Node.js 常用工具

util 是Node.js 核心模組，提供常用函數的集合，用來彌補核心JavaScript 的功能 過於精簡的不足。

util.inherits

util.inherits(constructor, superConstructor)是實作物件間原型繼承 的函數。

JavaScript 的物件導向特性是基於原型的，與常見的基於類別的不同。 JavaScript 沒有 提供物件繼承的語言層級特性，而是透過原型複製來實現的。

在這裡我們只介紹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);

我們定義了一個基礎物件Base 和一個繼承自Base 的Sub，Base 有三個在建構函式內定義的屬性和一個原型中定義的函數，透過util.inherits 實現繼承。運行結果如下：

base 
Hello base 
{ name: 'base', base: 1991, sayHello: [Function] } 
sub 
{ name: 'sub' }

注意：Sub 只是繼承了Base 在原型中定義的函數，而建構子內部創造的 base 屬 性和 sayHello 函數都沒有被 Sub 繼承。

同時，在原型中定義的屬性不會被console.log 作 為物件的屬性輸出。如果我們去掉objSub.sayHello(); 這行的註釋，將會看到：

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

util.inspect(object,[showHidden],[depth ],[colors])是一種將任意物件轉換為字串的方法，通常用於偵錯和錯誤輸出。它至少接受一個參數 object，也就是要轉換的物件。

showHidden 是一個可選參數，如果值為 true，將會輸出更多隱藏訊息。

depth 表示最大遞歸的層數，如果物件很複雜，你可以指定層數以控制輸出資訊的多 少。如果不指定depth，預設會遞歸2層，指定為 null 表示將不限遞歸層數完整遍歷物件。 如果color 值為 true，輸出格式會以ANSI 顏色編碼，通常用於在終端機上顯示更漂亮 的效果。

特別要指出的是，util.inspect 並不會簡單地直接把物件轉換為字串，即使該對 象定義了toString 方法也不會呼叫。

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));

運行結果是：

{ name: 'byvoid', toString: [Function] } 
{ toString: 
{ [Function] 
[prototype]: { [constructor]: [Circular] }, 
[caller]: null, 
[length]: 0, 
[name]: '', 
[arguments]: null }, 
name: 'byvoid' }

util.isArray(object)

如果給定的參數"object" 是一個陣列回傳true，否則傳回false 。

var util = require('util');

util.isArray([])
  // true
util.isArray(new Array)
  // true
util.isArray({})
  // false

util.isRegExp(object)

如果給定的參數 "object" 是一個正規表示式傳回true，否則傳回false。

var util = require('util');

util.isRegExp(/some regexp/)
  // true
util.isRegExp(new RegExp('another regexp'))
  // true
util.isRegExp({})
  // false

util.isDate(object)

如果給定的參數 "object" 是一個日期回傳true，否則回傳false。

var util = require('util');

util.isDate(new Date())
  // true
util.isDate(Date())
  // false (without 'new' returns a String)
util.isDate({})
  // false

util.isError(object)

如果給定的參數 "object" 是一個錯誤物件回傳true，否則傳回false。

var util = require('util');

util.isError(new Error())
  // true
util.isError(new TypeError())
  // true
util.isError({ name: 'Error', message: 'an error occurred' })
  // false

更多詳情可以造訪 http://nodejs.org/api/util.html 了解詳細內容。