探索node之常用工具

常用工具

util是一个Node.js核心模块，提供常用函数的集合，用于弥补核心JavaScript的功能过于精简的不足

const util = require('util')

util.callbackify()

util.callbackify(original)将async异步函数（或者一个返回值为Promise的函数）转换成遵循异常优先的回调风格的函数，例如将(err,value)=>…回调作为最后一个参数。在回调函数中，第一个参数为拒绝的原因。(如果promise解决，则为null)，第二个参数则是解决的值。

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

回调函数是异步执行的，并且有异常堆栈错误追踪。 如果回调函数抛出一个异常，进程会触发一个 ‘uncaughtException’ 异常，如果没有被捕获，进程将会退出。

null 在回调函数中作为一个参数有其特殊的意义，如果回调函数的首个参数为 Promise 拒绝的原因且带有返回值，且值可以转换成布尔值 false，这个值会被封装在 Error 对象里，可以通过属性 reason 获取。

function fn() {
  return Promise.reject(null);
}
const callbackFunction = util.callbackify(fn);

callbackFunction((err, ret) => {
  // 当 Promise 被以 `null` 拒绝时，它被包装为 Error 并且原始值存储在 `reason` 中。
  err && err.hasOwnProperty('reason') && err.reason === null;  // true
});

util.inherits

util.inherits(constructor, superConstructor) 是一个实现对象间原型继承的函数。

javaScript 的面向对象特性是基于原型的，与常见的基于类的不同。JavaScript 没有提供对象继承的语言级别特性，而是通过原型复制来实现的。

const util = require('util')

function Base() {
  this.name = 'angula'
  this.base = 1999;
  this.sayHello = function () {
    console.log('Hello ' + this.name)
  }
}

Base.prototype.showName = function () {
  console.log(this.name);
}


function Sub() {
  this.name = 'nicai'
}

util.inherits(Sub, Base)

let objBase = new Base();
objBase.showName();
objBase.sayHello();
console.log(objBase);


let objSub = new Sub();
objSub.showName();
// objSub.sayHello();
console.log(objSub);

输出：

angula
Hello angula
Base { name: 'angula', base: 1999, sayHello: [Function] }
nicai
Sub { name: 'nicai' }

注意：Sub 仅仅继承了Base 在原型中定义的函数，而构造函数内部创造的 base 属 性和 sayHello 函数都没有被 Sub 继承。同时，在原型中定义的属性不会被 console.log 作 为对象的属性输出

util.inspect

util.inspect(object,[showHidden],[depth],[colors]) 是一个将任意对象转换 为字符串的方法，通常用于调试和错误输出。它至少接受一个参数 object，即要转换的对象

showHidden 是一个可选参数，如果值为true，将会输出更多隐藏信息

depth表示最大递归的层数，如果对象很复杂，可以指定层数以控制输出信息的多少，如果不指定depth，默认递归两层，指定为null表示将不限递归层数完整遍历对象。如果colors值为true，输出格式将会以ANSI颜色编码，通常用于在终端显示更漂亮的效果。

util.inspect 并不会简单地直接把对象转换为字符串，即使该对象定义了 toString 方法也不会调用。

const util = require('util')
function Person() {
  this.name = 'angula';
  this.toString = function () {
    return this.name;
  }
}

let obj = new Person();
console.log(util.inspect(obj));
console.log(util.inspect(obj, true))

输出：

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

util.isArray(object)

如果给定的参数 “object” 是一个数组返回 true，否则返回 false。

util.isRegExp(object)

如果给定的参数 “object” 是一个正则表达式返回true，否则返回false。

util.isDate(object)

如果给定的参数 “object” 是一个日期返回true，否则返回false。

var util = require('util');

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

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

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