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。