Node.js初步-API-Util.md

Table of Contents generated with DocToc

• Node.js初步 - API - Util
  • Util API
    • inspect
    • format

Node.js初步 - API - Util

var util = require('util');

Node.js核心模块，提供常用函数的集合

Util API

inspect

util.inspect(object[, options])

将任意对象转换为字符串，在代码调试的时候非常有用

至少接受一个参数object, options可能的配置如下：

• showHidden 如果设为 true，那么该对象的不可枚举的属性将会被显示出来。默认为false.
• depth 告诉 inspect 格式化对象的时候递归多少次。这个选项在格式化复杂对象的时候比较有用。 默认为 2。如果想无穷递归下去，则赋值为null即可
• colors 如果设为true，将会以ANSI颜色代码风格进行输出. 默认是false。颜色是可定制的
• customInspect 如果设为 false，那么定义在被检查对象上的inspect(depth, opts) 方法将不会被调用。 默认为true

// 检查util对象上的所有属性
console.log(util.inspect(util, { showHidden: true, depth: null }));

format

format 函数根据第一个参数，返回一个格式化字符串，第一个参数是一个可包含零个或多个占位符的字符串

每一个占位符被替换为与其对应的转换后的值，支持的占位符有：

%s (字符串)

%d (数字<整型和浮点型>)

%j (JSON)

% (单独一个百分号则不作为一个参数)

• 如果占位符没有相对应的参数，占位符将不会被替换

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

• 如果有多个参数占位符，额外的参数将会调用util.inspect()转换为字符串。这些字符串被连接在一起，并且以空格分隔

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

• 如果第一个参数是一个非格式化字符串，则会把所有的参数转成字符串并以空格隔开拼接在一块，而且返回该字符串

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