Node.js util.inspect.custom用法及代码示例

util.inspect.custom

• <symbol> 可用于声明自定义检查函数。

除了可以通过 util.inspect.custom 访问之外，这个符号是 registered globally 并且可以在任何环境中作为 Symbol.for('nodejs.util.inspect.custom') 访问。

使用它允许以可移植的方式编写代码，以便在 Node.js 环境中使用自定义检查函数并在浏览器中忽略。 util.inspect() 函数本身作为第三个参数传递给自定义检查函数，以允许进一步的可移植性。

const customInspectSymbol = Symbol.for('nodejs.util.inspect.custom');

class Password {
  constructor(value) {
    this.value = value;
  }

  toString() {
    return 'xxxxxxxx';
  }

  [customInspectSymbol](depth, inspectOptions, inspect) {
    return `Password <${this.toString()}>`;
  }
}

const password = new Password('r0sebud');
console.log(password);
// Prints Password <xxxxxxxx>

有关详细信息，请参阅Custom inspection functions on Objects。