Node.js v18.7.0 文档

util.callbackify(original)#

中英对照

采用 async 函数（或返回 Promise 的函数）并返回遵循错误优先回调风格的函数，即将 (err, value) => ... 回调作为最后一个参数。 在回调中，第一个参数将是拒绝原因（如果 Promise 已解决，则为 null），第二个参数将是已解决的值。

util.debuglog(section[, callback])#

中英对照

util.debuglog() 方法用于创建函数，该函数根据 NODE_DEBUG 环境变量的存在有条件地将调试消息写入 stderr。 如果 section 名称出现在该环境变量的值中，则返回的函数的操作类似于 console.error()。 如果不是，则返回的函数是空操作。

debuglog().enabled#

中英对照

util.debuglog().enabled 获取器用于基于 NODE_DEBUG 环境变量的存在创建可用于条件的测试。 如果 section 名称出现在该环境变量的值中，则返回值将为 true。 如果不是，则返回值将是 false。

util.debug(section)#

中英对照

util.debuglog 的别名。 当仅使用 util.debuglog().enabled 时，使用允许可读性并不意味着日志记录。

util.deprecate(fn, msg[, code])#

中英对照

util.deprecate() 方法以标记为已弃用的方式封装 fn（可能是函数或类）。

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

中英对照

util.format() 方法使用第一个参数作为类似 printf 的格式字符串（其可以包含零个或多个格式说明符）来返回格式化的字符串。 每个说明符都替换为来自相应参数的转换后的值。 支持的说明符有：

util.formatWithOptions(inspectOptions, format[, ...args])#

中英对照

此函数与 util.format() 相同，不同之处在于它接受 inspectOptions 参数，该参数指定传给 util.inspect() 的选项。

util.getSystemErrorName(err)#

中英对照

返回来自 Node.js API 的数字错误码的字符串名称。 错误码和错误名称之间的映射是平台相关的。 有关常见错误的名称，请参阅常见的系统错误。

util.getSystemErrorMap()#

中英对照

返回来自 Node.js API 的可用的所有系统错误码的映射。 错误码和错误名称之间的映射是平台相关的。 有关常见错误的名称，请参阅常见的系统错误。

util.inherits(constructor, superConstructor)#

中英对照

不鼓励使用 util.inherits()。 请使用 ES6 class 和 extends 关键字来获得语言级别的继承支持。 另请注意，这两种风格在语义上不兼容。

util.inspect(object[, options])#

util.inspect(object[, showHidden[, depth[, colors]]])#

中英对照

util.inspect() 方法返回用于调试的 object 的字符串表示。 util.inspect 的输出可能随时更改，不应以编程方式依赖。 可以传入额外的 options 来改变结果。 util.inspect() 将使用构造函数的名称和/或 @@toStringTag 为检查的值制作可识别的标签。

自定义 util.inspect 的颜色#

中英对照

util.inspect 的颜色输出（如果启用）可通过 util.inspect.styles 和 util.inspect.colors 属性全局地自定义。

修饰符#

中英对照

修饰符的支持因不同的终端而异。 如果不支持，则它们通常会被忽略。

前景颜色#

中英对照

背景颜色#

中英对照

对象上的自定义检查函数#

中英对照

对象也可以定义自己的 [util.inspect.custom](depth, opts, inspect) 函数，util.inspect() 将在检查对象时调用并使用其结果。

util.inspect.custom#

中英对照

除了可以通过 util.inspect.custom 访问之外，此符号是全局地注册，可以在任何环境中作为 Symbol.for('nodejs.util.inspect.custom') 访问。

util.inspect.defaultOptions#

中英对照

defaultOptions 值允许自定义 util.inspect 使用的默认选项。 这对于像 console.log 或 util.format 这样隐式调用 util.inspect 的函数很有用。 它应设置为包含一个或多个有效 util.inspect() 选项的对象。 也支持直接设置选项属性。

util.isDeepStrictEqual(val1, val2)#

中英对照

如果 val1 和 val2 之间存在深度严格相等，则返回 true。 否则，返回 false。

util.parseArgs([config])#

中英对照

为命令行参数解析提供比直接与 process.argv 交互更高级别的 API。 采用预期参数的规范并返回带有解析选项和位置的结构化对象。

parseArgs tokens#

中英对照

详细的解析信息可用于通过在配置中指定 tokens: true 添加自定义行为。 返回的令牌具有描述的属性：

util.promisify(original)#

中英对照

采用遵循常见的错误优先的回调风格的函数（也就是将 (err, value) => ... 回调作为最后一个参数），并返回一个返回 promise 的版本。

自定义的 promise 化函数#

中英对照

使用 util.promisify.custom 符号可以覆盖 util.promisify() 的返回值：

util.promisify.custom#

中英对照

除了可以通过 util.promisify.custom 访问之外，此符号是全局地注册，可以在任何环境中作为 Symbol.for('nodejs.util.promisify.custom') 访问。

util.stripVTControlCharacters(str)#

中英对照

返回已删除任何 ANSI 转义码的 str。

util.TextDecoder 类#

中英对照

WHATWG 编码标准 TextDecoder API 的实现。

WHATWG 支持的编码#

中英对照

根据 WHATWG 编码标准，TextDecoder API 支持的编码在下表中列出。 对于每种编码，可以使用一个或多个别名。

默认支持的编码（带有完整的 ICU 数据）#

使用 small-icu 选项构建的 Node.js 支持的编码#

当 ICU 被禁用时支持的编码#

中英对照

不支持 WHATWG 编码标准中列出的 'iso-8859-16' 编码。

new TextDecoder([encoding[, options]])#

中英对照

创建新的 TextDecoder 实例。 encoding 可以指定支持的编码之一或别名。

textDecoder.decode([input[, options]])#

中英对照

解码 input 并返回字符串。 如果 options.stream 是 true，则在 input 末尾出现的任何不完整的字节序列都会在内部缓冲并在下一次调用 textDecoder.decode() 后触发。

textDecoder.encoding#

中英对照

TextDecoder 实例支持的编码。

textDecoder.fatal#

中英对照

如果解码错误导致抛出 TypeError，则该值将为 true。

textDecoder.ignoreBOM#

中英对照

如果解码结果将包含字节顺序标记，则该值将为 true。

util.TextEncoder 类#

中英对照

WHATWG 编码标准 TextEncoder API 的实现。 TextEncoder 的所有实例仅支持 UTF-8 编码。

textEncoder.encode([input])#

中英对照

对 input 字符串进行 UTF-8 编码并返回包含编码字节的 Uint8Array。

textEncoder.encodeInto(src, dest)#

中英对照

将 src 字符串 UTF-8 编码为 dest Uint8Array 并返回包含读取的 Unicode 代码单元和写入的 UTF-8 字节的对象。

textEncoder.encoding#

中英对照

TextEncoder 实例支持的编码。 始终设置为 'utf-8'。

util.toUSVString(string)#

中英对照

在用 Unicode “替换字符” U+FFFD 替换任何代理代码点（或等效地，任何未配对的代理代码单元）后返回 string。

util.types#

中英对照

util.types 为不同种类的内置对象提供类型检查。 与 instanceof 或 Object.prototype.toString.call(value) 不同，这些检查不检查可从 JavaScript 访问的对象的属性（如它们的原型），并且通常具有调用 C++ 的开销。

util.types.isAnyArrayBuffer(value)#

中英对照

如果值为内置的 ArrayBuffer 或 SharedArrayBuffer 实例，则返回 true。

util.types.isArrayBufferView(value)#

中英对照

如果值是 ArrayBuffer 视图之一的实例，例如类型化数组对象或 DataView，则返回 true。 相当于 ArrayBuffer.isView()。

util.types.isArgumentsObject(value)#

中英对照

如果值为 arguments 对象，则返回 true。

util.types.isArrayBuffer(value)#

中英对照

如果值为内置的 ArrayBuffer 实例，则返回 true。 这不包括 SharedArrayBuffer 实例。 通常，最好对两者进行测试；参见 util.types.isAnyArrayBuffer()。

util.types.isAsyncFunction(value)#

中英对照

如果值是异步函数，则返回 true。 这只会报告 JavaScript 引擎看到的内容；特别是，如果使用了转译工具，则返回值可能与原始源代码不匹配。

util.types.isBigInt64Array(value)#

中英对照

如果值为 BigInt64Array 实例，则返回 true。

util.types.isBigUint64Array(value)#

中英对照

如果值为 BigUint64Array 实例，则返回 true。

util.types.isBooleanObject(value)#

中英对照

如果值是布尔对象（例如由 new Boolean() 创建），则返回 true。

util.types.isBoxedPrimitive(value)#

中英对照

如果值是任何封装的原始对象（例如由 new Boolean()、new String() 或 Object(Symbol()) 创建），则返回 true。

util.types.isCryptoKey(value)#

中英对照

如果 value 是 <CryptoKey>，则返回 true，否则返回 false。

util.types.isDataView(value)#

中英对照

如果值为内置的 DataView 实例，则返回 true。

util.types.isDate(value)#

中英对照

如果值为内置的 Date 实例，则返回 true。

util.types.isExternal(value)#

中英对照

如果值是原生的 External 值，则返回 true。

util.types.isFloat32Array(value)#

中英对照

如果值为内置的 Float32Array 实例，则返回 true。

util.types.isFloat64Array(value)#

中英对照

如果值为内置的 Float64Array 实例，则返回 true。

util.types.isGeneratorFunction(value)#

中英对照

如果值是生成器函数，则返回 true。 这只会报告 JavaScript 引擎看到的内容；特别是，如果使用了转译工具，则返回值可能与原始源代码不匹配。

util.types.isGeneratorObject(value)#

中英对照

如果值是从内置的生成器函数返回的生成器对象，则返回 true。 这只会报告 JavaScript 引擎看到的内容；特别是，如果使用了转译工具，则返回值可能与原始源代码不匹配。

util.types.isInt8Array(value)#

中英对照

如果值为内置的 Int8Array 实例，则返回 true。

util.types.isInt16Array(value)#

中英对照

如果值为内置的 Int16Array 实例，则返回 true。

util.types.isInt32Array(value)#

中英对照

如果值为内置的 Int32Array 实例，则返回 true。

util.types.isKeyObject(value)#

中英对照

如果 value 是 <KeyObject>，则返回 true，否则返回 false。

util.types.isMap(value)#

中英对照

如果值为内置的 Map 实例，则返回 true。

util.types.isMapIterator(value)#

中英对照

如果值是为内置的 Map 实例返回的迭代器，则返回 true。

util.types.isModuleNamespaceObject(value)#

中英对照

如果值是模块命名空间对象的实例，则返回 true。

util.types.isNativeError(value)#

中英对照

如果值是内置的 Error 类型的实例，则返回 true。

util.types.isNumberObject(value)#

中英对照

如果值是数字对象（例如由 new Number() 创建），则返回 true。

util.types.isPromise(value)#

中英对照

如果值为内置的 Promise，则返回 true。

util.types.isProxy(value)#

中英对照

如果值为 Proxy 实例，则返回 true。

util.types.isRegExp(value)#

中英对照

如果值是正则表达式对象，则返回 true。

util.types.isSet(value)#

中英对照

如果值为内置的 Set 实例，则返回 true。

util.types.isSetIterator(value)#

中英对照

如果值是为内置的 Set 实例返回的迭代器，则返回 true。

util.types.isSharedArrayBuffer(value)#

中英对照

如果值为内置的 SharedArrayBuffer 实例，则返回 true。 这不包括 ArrayBuffer 实例。 通常，最好对两者进行测试；参见 util.types.isAnyArrayBuffer()。

util.types.isStringObject(value)#

中英对照

如果值是字符串对象（例如由 new String() 创建），则返回 true。

util.types.isSymbolObject(value)#

中英对照

如果值是符号对象（通过在 Symbol 原始类型上调用 Object() 创建），则返回 true。

util.types.isTypedArray(value)#

中英对照

如果值为内置的 TypedArray 实例，则返回 true。

util.types.isUint8Array(value)#

中英对照

如果值为内置的 Uint8Array 实例，则返回 true。

util.types.isUint8ClampedArray(value)#

中英对照

如果值为内置的 Uint8ClampedArray 实例，则返回 true。

util.types.isUint16Array(value)#

中英对照

如果值为内置的 Uint16Array 实例，则返回 true。

util.types.isUint32Array(value)#

中英对照

如果值为内置的 Uint32Array 实例，则返回 true。

util.types.isWeakMap(value)#

中英对照

如果值为内置的 WeakMap 实例，则返回 true。

util.types.isWeakSet(value)#

中英对照

如果值为内置的 WeakSet 实例，则返回 true。

util.types.isWebAssemblyCompiledModule(value)#

中英对照

如果值为内置的 WebAssembly.Module 实例，则返回 true。

弃用的 API#

中英对照

以下 API 已弃用，不应再使用。 应更新现有应用程序和模块以寻找替代方法。

util._extend(target, source)#

中英对照

util._extend() 方法从未打算在内部的 Node.js 模块之外使用。 社区无论如何都找到并使用了它。

util.isArray(object)#

中英对照

Array.isArray() 的别名。

util.isBoolean(object)#

中英对照

如果给定的 object 是 Boolean，则返回 true。 否则，返回 false。

util.isBuffer(object)#

中英对照

如果给定的 object 是 Buffer，则返回 true。 否则，返回 false。

util.isDate(object)#

中英对照

如果给定的 object 是 Date，则返回 true。 否则，返回 false。

util.isError(object)#

中英对照

如果给定的 object 是 Error，则返回 true。 否则，返回 false。

util.isFunction(object)#

中英对照

如果给定的 object 是 Function，则返回 true。 否则，返回 false。

util.isNull(object)#

中英对照

如果给定的 object 严格为 null，则返回 true。 否则，返回 false。

util.isNullOrUndefined(object)#

中英对照

如果给定的 object 是 null 或 undefined，则返回 true。 否则，返回 false。

util.isNumber(object)#

中英对照

如果给定的 object 是 Number，则返回 true。 否则，返回 false。

util.isObject(object)#

中英对照

如果给定的 object 严格来说是 Object 而不是 Function（即使函数是 JavaScript 中的对象），则返回 true。 否则，返回 false。

util.isPrimitive(object)#

中英对照

如果给定的 object 是原始类型，则返回 true。 否则，返回 false。

util.isRegExp(object)#

中英对照

如果给定的 object 是 RegExp，则返回 true。 否则，返回 false。

util.isString(object)#

中英对照

如果给定的 object 是 string，则返回 true。 否则，返回 false。

util.isSymbol(object)#

中英对照

如果给定的 object 是 Symbol，则返回 true。 否则，返回 false。

util.isUndefined(object)#

中英对照

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

util.log(string)#

中英对照

util.log() 方法使用包含的时间戳打印给定的 string 到 stdout。