一起读nodejs(六)----工具类(Utilties)

本文是对nodejs0.8.9版本的api开发手册解读.nodejs网址

工具类(util)

stability:5 - locked

这写方法都在util模块中,使用require('util')访问他们.

util.format(format,[...])

把第一个参数用类似printf的功能格式化后,返回格式化后的字符串.

第一个参数是一个字符串,包含0个或者更多个占位符.每个占位符都会被相应的参数转换后的值替换.支持的占位符有:

• %s- String 字符串.
• %d- Number (both integer and float). 数字 包括整形和浮点型
• %j- JSON.json格式
• %- single percent sign ('%'). This does not consume an argument.单个百分号,这占一个占位符空间.

如果占位符没有对应的参数,占位符不会被替换.

util.format('%s:%s', 'foo'); // 'foo:%s'

如果参数比占位符多,额外的参数将会被使用util.inspect()转换成字符串.并且用空格隔开.

util.format('%s:%s', 'foo', 'bar', 'baz'); // 'foo:bar baz'

如果第一个参数不是一个格式化字符串(意思是不是占位符),那么util.format()将会返回一个用空格分开的字符串.每个参数都会被util.inspect()转换成字符串.

util.format(1, 2, 3); // '1 2 3'

util.debug(string)

一个同步的输出函数.将会阻塞进程,并且直接输出字符串到stderr中.(感觉作用不是很大.就是一个阻塞的输出)

require('util').debug('message on stderr');

util.err([...])

除了参数个数不一样,其他功能和util.debug一样.

util.puts([...])

一个同步的输出函数.将会阻塞进程,并且直接输出字符串到stdout中.每个参数占一行.

util.prints([...])

一个同步的输出函数.将会阻塞进程,将每个参数转换成字符串后输出到stdout中.每个参数不会占用新的行.

util.log(string)

带上时间戳输出到stdout.

require('util').log('Timestamped message.');

util.inspect(object,[showHidden],[depth],[colors])

返回一个对象的字符串形式,在debugging时很有用.

如果shouhidden是true,对象的非枚举类型的属性也将会被显示出来.默认是false.

如果depth有值,它代表了inspect在格式化object时递归的次数.当在inspect很大很复杂的object时很有用.

默认只是递归两次.如果不能确定递归次数,可以传入null,

如果colors是true,输出是的风格将会使用asni 颜色代码.默认是false.

一个探测util所有属性的例子:

var util = require('util');

console.log(util.inspect(util, true, null));

util.isArray(object)

如果object是一个数组返回ture,其他情况返回false.

var util = require('util');

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

util.isArray(object)

如果object是一个正则表达式返回ture,其他情况返回false.

var util = require('util');

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

util.isDate(object)

如果object是一个date类型返回ture,其他情况返回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是一个Error类型返回ture,其他情况返回false.

var util = require('util');

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

util.pump(readableStream,writableStream,[callback])
已经废弃,用readableStream.pipe(writableStream)代替.

util.inherits(constructor,superConstructor)

继承一个constructor的原型方法到另一个中.constructor的原型将会被设置成一个从superConstructor创建的对象.

为了更便利,superConstructor可以通过constructor.super_访问.

var util = require("util");
var events = require("events");

function MyStream() {
    events.EventEmitter.call(this);
}

util.inherits(MyStream, events.EventEmitter);

MyStream.prototype.write = function(data) {
    this.emit("data", data);
}

var stream = new MyStream();

console.log(stream instanceof events.EventEmitter); // true
console.log(MyStream.super_ === events.EventEmitter); // true

stream.on("data", function(data) {
    console.log('Received data: "' + data + '"');
})
stream.write("It works!"); // Received data: "It works!"