Utilities

稳定度: 2 - 稳定

这些功能在模块'util'中，通过require('util')来使用它们。

util模块主要的设计意图是满足io.js内部API的需要。但是许多工具对于你的程序也十分有用。如果你发现这些功能不能满足你的需要，那么鼓励你编写自己的工具集。我们对任何io.js内部功能不需要的功能，都不感兴趣。

util.debuglog(section)

section String 需要被调试的程序节点
Returns: Function 日志处理函数

这个方法被用来在NODE_DEBUG环境变量存在的情况下，创建一个有条件写入stderr的函数。如果section名出现在环境变量中，那么返回的函数与console.error()类似。否则，返回空函数。

例子：

var debuglog = util.debuglog('foo');

var bar = 123;
debuglog('hello from foo [%d]', bar);

如果程序在NODE_DEBUG=foo环境下运行，那么输出将是：

FOO 3245: hello from foo [123]

3245是进程id。如果这个环境变量没有设置，那么将不会打印任何东西。

你可以通过逗号设置多个NODE_DEBUG环境变量。例如，NODE_DEBUG=fs,net,tls。

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

使用第一个参数，像printf一样的格式输出格式化字符串。

第一个参数是一个包含了0个或更多占位符的字符串。每个占位符都被其后的参数所替换。支持的占位符有：

%s - 字符串
%d - 数字（整数和浮点数）
%j - JSON。如果参数包含循环引用，则返回字符串'[Circular]'。
%% - 单独的百分比符号（'%'），它不消耗一个参数。

如果占位符没有对应的参数，那么占位符将不被替换。

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.log(string)

在控制台输出带有时间戳的信息。

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

util.inspect(object[, options])

返回一个代表了object的字符串，在调试时很有用。

一个可选的options对象可以被传递以下属性来影响字符串的格式：

showHidden - 如果设置为true，那么对象的不可枚举属性也会被显示。默认为false。
depth - 告诉inspect格式化对象时需要递归的次数。这对于巨大的复杂对象十分有用。默认为2。传递null表示无限递归。
colors - 如果为true，那么输出会带有ANSI颜色代码风格。默认为false。颜色是可以自定义的，参阅下文。
customInspect - 如果为false，那么定义在被检查对象上的inspect(depth, opts)函数将不会被调用。默认为false。

一个检查util对象所有属性的例子：

var util = require('util');

console.log(util.inspect(util, { showHidden: true, depth: null }));

参数值可以提供了它们自己的inspect(depth, opts)函数，当被调用时它们会收到当前的递归深度值，以及其他传递给util.inspect()的选项。

自定义`util.inspect`颜色

util.inspect的有颜色的输出（如果启用）可以全局的通过util.inspect.styles和util.inspect.colors对象来自定义。

util.inspect.styles是通过util.inspect.colors设置每个风格一个颜色的映射。高亮风格和它们的默认值为number (yellow) boolean (yellow) string (green) date (magenta) regexp (red) null (bold) undefined (grey) special。这时的唯一方法(cyan) * name (intentionally no styling)。

预定义颜色有white, grey, black, blue, cyan, green, magenta, red 和 yellow。他们都是bold，italic，underline和inverse代码。

自定义对象的`inspect()`函数

对象也可以自己定义inspect(depth)函数，util.inspect()将会调用它，并且输出它的结果：

var util = require('util');

var obj = { name: 'nate' };
obj.inspect = function(depth) {
  return '{' + this.name + '}';
};

util.inspect(obj);
  // "{nate}"

你也可以完全返回另一个对象，并且返回的字符串是由这个返回对象格式化而来的，这也JSON.stringify()相似：

var obj = { foo: 'this will not show up in the inspect() output' };
obj.inspect = function(depth) {
  return { bar: 'baz' };
};

util.inspect(obj);
  // "{ bar: 'baz' }"

util.isArray(object)

Array.isArray的内部别名。

如果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

util.isBoolean(object)

如果object是一个布尔值则返回true，否则返回false。

var util = require('util');

util.isBoolean(1)
  // false
util.isBoolean(0)
  // false
util.isBoolean(false)
  // true

util.isNull(object)

如果object是严格的null则返回true，否则返回false。

var util = require('util');

util.isNull(0)
  // false
util.isNull(undefined)
  // false
util.isNull(null)
  // true

util.isNullOrUndefined(object)

如果object是一null或undefined则返回true，否则返回false。

var util = require('util');

util.isNullOrUndefined(0)
  // false
util.isNullOrUndefined(undefined)
  // true
util.isNullOrUndefined(null)
  // true

util.isNumber(object)

如果object是一个数字则返回true，否则返回false。

var util = require('util');

util.isNumber(false)
  // false
util.isNumber(Infinity)
  // true
util.isNumber(0)
  // true
util.isNumber(NaN)
  // true

util.isString(object)

如果object是一个字符串则返回true，否则返回false。

var util = require('util');

util.isString('')
  // true
util.isString('foo')
  // true
util.isString(String('foo'))
  // true
util.isString(5)
  // false

util.isSymbol(object)

如果object是一个Symbol则返回true，否则返回false。

var util = require('util');

util.isSymbol(5)
  // false
util.isSymbol('foo')
  // false
util.isSymbol(Symbol('foo'))
  // true

util.isUndefined(object)

如果object是undefined则返回true，否则返回false。

var util = require('util');

var foo;
util.isUndefined(5)
  // false
util.isUndefined(foo)
  // true
util.isUndefined(null)
  // false

util.isObject(object)

如果object严格的是一个对象而不是一个函数，则返回true，否则返回false。

var util = require('util');

util.isObject(5)
  // false
util.isObject(null)
  // false
util.isObject({})
  // true
util.isObject(function(){})
  // false

util.isFunction(object)

如果object是一个函数则返回true，否则返回false。

var util = require('util');

function Foo() {}
var Bar = function() {};

util.isFunction({})
  // false
util.isFunction(Foo)
  // true
util.isFunction(Bar)
  // true

util.isPrimitive(object)

如果object是一个基本值则返回true，否则返回false。

var util = require('util');

util.isPrimitive(5)
  // true
util.isPrimitive('foo')
  // true
util.isPrimitive(false)
  // true
util.isPrimitive(null)
  // true
util.isPrimitive(undefined)
  // true
util.isPrimitive({})
  // false
util.isPrimitive(function() {})
  // false
util.isPrimitive(/^$/)
  // false
util.isPrimitive(new Date())
  // false

util.isBuffer(object)

如果object是一个buffer则返回true，否则返回false。

var util = require('util');

util.isBuffer({ length: 0 })
  // false
util.isBuffer([])
  // false
util.isBuffer(new Buffer('hello world'))
  // true

util.inherits(constructor, 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!"

util.deprecate(function, string)

标记一个方法为不应再使用。

var util = require('util');

exports.puts = util.deprecate(function() {
  for (var i = 0, len = arguments.length; i < len; ++i) {
    process.stdout.write(arguments[i] + '\n');
  }
}, 'util.puts: Use console.log instead');

默认返回一个被运行时会发出一次警告的，修改后的函数。

如果--no-deprecation被设置，那么这个函数将为空。可以在运行时通过process.noDeprecation布尔值配置（只有在模块被加载前设置，才会有效）。

如果--trace-deprecation被设置，当被弃用的API第一次被使用时，会向控制台打印一个警告和堆栈信息。可以在运行时通过process.traceDeprecation布尔值配置。

如果--throw-deprecation被设置，那么当被弃用的API被使用时，应用会抛出一个错误。可以在运行时通过process.throwDeprecation布尔值配置。

process.throwDeprecation的优先级高于process.traceDeprecation。

util.debug(string)

稳定度: 0 - 弃用: 使用console.error()代替。

被弃用，console.error的前身。

util.error([...])