types module
函数
is |
如果值是内置 另请参阅
|
is |
如果值是
|
is |
如果值是内置
|
is |
如果值是其中一个
|
is |
如果该值是异步函数
|
is |
如果值是
|
is |
如果值是 BigInt 对象,则返回
|
is |
如果值是
|
is |
如果值为布尔对象(例如由
|
is |
如果值是任何装箱基元对象(例如由 例如:
|
is |
如果 |
is |
如果值是内置
另请参阅 |
is |
如果值是内置
|
is |
如果值是本机 本机
有关 |
is |
如果值是内置
|
is |
如果值是内置
|
is |
如果值为生成器函数,则返回
|
is |
如果该值是从内置生成器函数返回的生成器对象,则返回
|
is |
如果值是内置
|
is |
如果值是内置
|
is |
如果值是内置
|
is |
如果 |
is |
如果值是内置
|
is |
如果值为为内置
|
is |
|
is |
如果
本机错误类型的子类也是本机错误:
正在
相反,
|
is |
如果值是数字对象,则返回
|
is |
如果值为内置
|
is |
如果值是
|
is |
如果值为正则表达式对象,则返回
|
is |
如果值是内置
|
is |
如果值为为内置
|
is |
如果值是内置
|
is |
如果值是字符串对象,则返回
|
is |
如果该值是通过对
|
is |
如果值是内置
另请参阅 |
is |
如果值是内置
|
is |
如果值是内置
|
is |
如果值是内置
|
is |
如果值是内置
|
is |
如果值是内置
|
is |
如果值是内置
|
函数详细信息
isAnyArrayBuffer(unknown)
如果值是内置 true
或 ArrayBuffer
实例,则返回 SharedArrayBuffer
。
另请参阅 util.types.isArrayBuffer()
和 util.types.isSharedArrayBuffer()
。
util.types.isAnyArrayBuffer(new ArrayBuffer()); // Returns true
util.types.isAnyArrayBuffer(new SharedArrayBuffer()); // Returns true
function isAnyArrayBuffer(object: unknown): object
参数
- object
-
unknown
返回
object
isArgumentsObject(unknown)
如果值是 true
对象,则返回 arguments
。
function foo() {
util.types.isArgumentsObject(arguments); // Returns true
}
function isArgumentsObject(object: unknown): object
参数
- object
-
unknown
返回
object
isArrayBuffer(unknown)
如果值是内置 true
实例,则返回 ArrayBuffer
。
这不会 包括 SharedArrayBuffer
实例。 通常,需要针对两者进行测试:请参阅 util.types.isAnyArrayBuffer()
。
util.types.isArrayBuffer(new ArrayBuffer()); // Returns true
util.types.isArrayBuffer(new SharedArrayBuffer()); // Returns false
function isArrayBuffer(object: unknown): object
参数
- object
-
unknown
返回
object
isArrayBufferView(unknown)
如果值是其中一个 true
视图的实例,例如类型化数组对象或 ArrayBuffer
,则返回 DataView
。 等效于 ArrayBuffer.isView()
。
util.types.isArrayBufferView(new Int8Array()); // true
util.types.isArrayBufferView(Buffer.from('hello world')); // true
util.types.isArrayBufferView(new DataView(new ArrayBuffer(16))); // true
util.types.isArrayBufferView(new ArrayBuffer()); // false
function isArrayBufferView(object: unknown): object
参数
- object
-
unknown
返回
object
isAsyncFunction(unknown)
如果该值是异步函数
util.types.isAsyncFunction(function foo() {}); // Returns false
util.types.isAsyncFunction(async function foo() {}); // Returns true
function isAsyncFunction(object: unknown): boolean
参数
- object
-
unknown
返回
boolean
isBigInt64Array(unknown)
如果值是 true
实例,则返回 BigInt64Array
。
util.types.isBigInt64Array(new BigInt64Array()); // Returns true
util.types.isBigInt64Array(new BigUint64Array()); // Returns false
function isBigInt64Array(value: unknown): value
参数
- value
-
unknown
返回
value
isBigIntObject(unknown)
如果值是 BigInt 对象,则返回 true
,例如由 Object(BigInt(123))
创建 。
util.types.isBigIntObject(Object(BigInt(123))); // Returns true
util.types.isBigIntObject(BigInt(123)); // Returns false
util.types.isBigIntObject(123); // Returns false
function isBigIntObject(object: unknown): object
参数
- object
-
unknown
返回
object
isBigUint64Array(unknown)
如果值是 true
实例,则返回 BigUint64Array
。
util.types.isBigUint64Array(new BigInt64Array()); // Returns false
util.types.isBigUint64Array(new BigUint64Array()); // Returns true
function isBigUint64Array(value: unknown): value
参数
- value
-
unknown
返回
value
isBooleanObject(unknown)
如果值为布尔对象(例如由 true
创建),则返回 new Boolean()
。
util.types.isBooleanObject(false); // Returns false
util.types.isBooleanObject(true); // Returns false
util.types.isBooleanObject(new Boolean(false)); // Returns true
util.types.isBooleanObject(new Boolean(true)); // Returns true
util.types.isBooleanObject(Boolean(false)); // Returns false
util.types.isBooleanObject(Boolean(true)); // Returns false
function isBooleanObject(object: unknown): object
参数
- object
-
unknown
返回
object
isBoxedPrimitive(unknown)
如果值是任何装箱基元对象(例如由 true
、new Boolean()
或 new String()
创建),则返回 Object(Symbol())
。
例如:
util.types.isBoxedPrimitive(false); // Returns false
util.types.isBoxedPrimitive(new Boolean(false)); // Returns true
util.types.isBoxedPrimitive(Symbol('foo')); // Returns false
util.types.isBoxedPrimitive(Object(Symbol('foo'))); // Returns true
util.types.isBoxedPrimitive(Object(BigInt(5))); // Returns true
function isBoxedPrimitive(object: unknown): object
参数
- object
-
unknown
返回
object
isCryptoKey(unknown)
如果 true
是 value
,则返回 CryptoKey
;否则返回 false
。
function isCryptoKey(object: unknown): object
参数
- object
-
unknown
返回
object
isDataView(unknown)
如果值是内置 true
实例,则返回 DataView
。
const ab = new ArrayBuffer(20);
util.types.isDataView(new DataView(ab)); // Returns true
util.types.isDataView(new Float64Array()); // Returns false
另请参阅 ArrayBuffer.isView()
。
function isDataView(object: unknown): object
参数
- object
-
unknown
返回
object
isDate(unknown)
如果值是内置 true
实例,则返回 Date
。
util.types.isDate(new Date()); // Returns true
function isDate(object: unknown): object
参数
- object
-
unknown
返回
object
isExternal(unknown)
如果值是本机 true
值,则返回 External
。
本机 External
值是一种特殊类型的对象,其中包含从本机代码访问的原始C++指针(void*
),并且没有其他属性。 此类对象由内部组件或本机加载项 Node.js 创建。 在 JavaScript 中,它们是带有原型的null
冻结对象。
#include <js_native_api.h>
#include <stdlib.h>
napi_value result;
static napi_value MyNapi(napi_env env, napi_callback_info info) {
int* raw = (int*) malloc(1024);
napi_status status = napi_create_external(env, (void*) raw, NULL, NULL, &result);
if (status != napi_ok) {
napi_throw_error(env, NULL, "napi_create_external failed");
return NULL;
}
return result;
}
...
DECLARE_NAPI_PROPERTY("myNapi", MyNapi)
...
import native from 'napi_addon.node';
import { types } from 'node:util';
const data = native.myNapi();
types.isExternal(data); // returns true
types.isExternal(0); // returns false
types.isExternal(new String('foo')); // returns false
有关 napi_create_external
的详细信息,请参阅 napi_create_external()
。
function isExternal(object: unknown): boolean
参数
- object
-
unknown
返回
boolean
isFloat32Array(unknown)
如果值是内置 true
实例,则返回 Float32Array
。
util.types.isFloat32Array(new ArrayBuffer()); // Returns false
util.types.isFloat32Array(new Float32Array()); // Returns true
util.types.isFloat32Array(new Float64Array()); // Returns false
function isFloat32Array(object: unknown): object
参数
- object
-
unknown
返回
object
isFloat64Array(unknown)
如果值是内置 true
实例,则返回 Float64Array
。
util.types.isFloat64Array(new ArrayBuffer()); // Returns false
util.types.isFloat64Array(new Uint8Array()); // Returns false
util.types.isFloat64Array(new Float64Array()); // Returns true
function isFloat64Array(object: unknown): object
参数
- object
-
unknown
返回
object
isGeneratorFunction(unknown)
如果值为生成器函数,则返回 true
。
这只会报告 JavaScript 引擎看到的内容;具体而言,如果使用了转译工具,则返回值可能与原始源代码不匹配。
util.types.isGeneratorFunction(function foo() {}); // Returns false
util.types.isGeneratorFunction(function* foo() {}); // Returns true
function isGeneratorFunction(object: unknown): object
参数
- object
-
unknown
返回
object
isGeneratorObject(unknown)
如果该值是从内置生成器函数返回的生成器对象,则返回 true
。
这只会报告 JavaScript 引擎看到的内容;具体而言,如果使用了转译工具,则返回值可能与原始源代码不匹配。
function* foo() {}
const generator = foo();
util.types.isGeneratorObject(generator); // Returns true
function isGeneratorObject(object: unknown): object
参数
- object
-
unknown
返回
object
isInt16Array(unknown)
如果值是内置 true
实例,则返回 Int16Array
。
util.types.isInt16Array(new ArrayBuffer()); // Returns false
util.types.isInt16Array(new Int16Array()); // Returns true
util.types.isInt16Array(new Float64Array()); // Returns false
function isInt16Array(object: unknown): object
参数
- object
-
unknown
返回
object
isInt32Array(unknown)
如果值是内置 true
实例,则返回 Int32Array
。
util.types.isInt32Array(new ArrayBuffer()); // Returns false
util.types.isInt32Array(new Int32Array()); // Returns true
util.types.isInt32Array(new Float64Array()); // Returns false
function isInt32Array(object: unknown): object
参数
- object
-
unknown
返回
object
isInt8Array(unknown)
如果值是内置 true
实例,则返回 Int8Array
。
util.types.isInt8Array(new ArrayBuffer()); // Returns false
util.types.isInt8Array(new Int8Array()); // Returns true
util.types.isInt8Array(new Float64Array()); // Returns false
function isInt8Array(object: unknown): object
参数
- object
-
unknown
返回
object
isKeyObject(unknown)
如果 true
是 value
,则返回 KeyObject
;否则返回 false
。
function isKeyObject(object: unknown): object
参数
- object
-
unknown
返回
object
isMap<T>({} | T)
如果值是内置 true
实例,则返回 Map
。
util.types.isMap(new Map()); // Returns true
function isMap<T>(object: {} | T): object
参数
- object
-
{} | T
返回
object
isMapIterator(unknown)
如果值为为内置 true
实例返回的迭代器,则返回 Map
。
const map = new Map();
util.types.isMapIterator(map.keys()); // Returns true
util.types.isMapIterator(map.values()); // Returns true
util.types.isMapIterator(map.entries()); // Returns true
util.types.isMapIterator(map[Symbol.iterator]()); // Returns true
function isMapIterator(object: unknown): boolean
参数
- object
-
unknown
返回
boolean
isModuleNamespaceObject(unknown)
isNativeError(unknown)
如果 true
返回值,则返回 Error
。
console.log(util.types.isNativeError(new Error())); // true
console.log(util.types.isNativeError(new TypeError())); // true
console.log(util.types.isNativeError(new RangeError())); // true
本机错误类型的子类也是本机错误:
class MyError extends Error {}
console.log(util.types.isNativeError(new MyError())); // true
正在 instanceof
本机错误类的值不等效于为该值返回 isNativeError()
true
。
isNativeError()
返回来自不同 true
的错误 ,而 instanceof Error
返回这些错误的 false
:
import { createContext, runInContext } from 'node:vm';
import { types } from 'node:util';
const context = createContext({});
const myError = runInContext('new Error()', context);
console.log(types.isNativeError(myError)); // true
console.log(myError instanceof Error); // false
相反,isNativeError()
为本机错误的构造函数未返回的所有对象返回 false
。 这包括 instanceof
本机错误的值:
const myError = { __proto__: Error.prototype };
console.log(util.types.isNativeError(myError)); // false
console.log(myError instanceof Error); // true
function isNativeError(object: unknown): object
参数
- object
-
unknown
返回
object
isNumberObject(unknown)
如果值是数字对象,则返回 true
,例如由 new Number()
创建 。
util.types.isNumberObject(0); // Returns false
util.types.isNumberObject(new Number(0)); // Returns true
function isNumberObject(object: unknown): object
参数
- object
-
unknown
返回
object
isPromise(unknown)
如果值为内置 true
,则返回 Promise
。
util.types.isPromise(Promise.resolve(42)); // Returns true
function isPromise(object: unknown): object
参数
- object
-
unknown
返回
object
isProxy(unknown)
如果值是 true
实例,则返回 Proxy
。
const target = {};
const proxy = new Proxy(target, {});
util.types.isProxy(target); // Returns false
util.types.isProxy(proxy); // Returns true
function isProxy(object: unknown): boolean
参数
- object
-
unknown
返回
boolean
isRegExp(unknown)
如果值为正则表达式对象,则返回 true
。
util.types.isRegExp(/abc/); // Returns true
util.types.isRegExp(new RegExp('abc')); // Returns true
function isRegExp(object: unknown): object
参数
- object
-
unknown
返回
object
isSet<T>({} | T)
如果值是内置 true
实例,则返回 Set
。
util.types.isSet(new Set()); // Returns true
function isSet<T>(object: {} | T): object
参数
- object
-
{} | T
返回
object
isSetIterator(unknown)
如果值为为内置 true
实例返回的迭代器,则返回 Set
。
const set = new Set();
util.types.isSetIterator(set.keys()); // Returns true
util.types.isSetIterator(set.values()); // Returns true
util.types.isSetIterator(set.entries()); // Returns true
util.types.isSetIterator(set[Symbol.iterator]()); // Returns true
function isSetIterator(object: unknown): boolean
参数
- object
-
unknown
返回
boolean
isSharedArrayBuffer(unknown)
如果值是内置 true
实例,则返回 SharedArrayBuffer
。
这不会 包括 ArrayBuffer
实例。 通常,需要针对两者进行测试:请参阅 util.types.isAnyArrayBuffer()
。
util.types.isSharedArrayBuffer(new ArrayBuffer()); // Returns false
util.types.isSharedArrayBuffer(new SharedArrayBuffer()); // Returns true
function isSharedArrayBuffer(object: unknown): object
参数
- object
-
unknown
返回
object
isStringObject(unknown)
如果值是字符串对象,则返回 true
,例如由 new String()
创建 。
util.types.isStringObject('foo'); // Returns false
util.types.isStringObject(new String('foo')); // Returns true
function isStringObject(object: unknown): object
参数
- object
-
unknown
返回
object
isSymbolObject(unknown)
如果该值是通过对 true
基元调用 Object()
创建的符号对象,则返回 Symbol
。
const symbol = Symbol('foo');
util.types.isSymbolObject(symbol); // Returns false
util.types.isSymbolObject(Object(symbol)); // Returns true
function isSymbolObject(object: unknown): object
参数
- object
-
unknown
返回
object
isTypedArray(unknown)
如果值是内置 true
实例,则返回 TypedArray
。
util.types.isTypedArray(new ArrayBuffer()); // Returns false
util.types.isTypedArray(new Uint8Array()); // Returns true
util.types.isTypedArray(new Float64Array()); // Returns true
另请参阅 ArrayBuffer.isView()
。
function isTypedArray(object: unknown): object
参数
- object
-
unknown
返回
object
isUint16Array(unknown)
如果值是内置 true
实例,则返回 Uint16Array
。
util.types.isUint16Array(new ArrayBuffer()); // Returns false
util.types.isUint16Array(new Uint16Array()); // Returns true
util.types.isUint16Array(new Float64Array()); // Returns false
function isUint16Array(object: unknown): object
参数
- object
-
unknown
返回
object
isUint32Array(unknown)
如果值是内置 true
实例,则返回 Uint32Array
。
util.types.isUint32Array(new ArrayBuffer()); // Returns false
util.types.isUint32Array(new Uint32Array()); // Returns true
util.types.isUint32Array(new Float64Array()); // Returns false
function isUint32Array(object: unknown): object
参数
- object
-
unknown
返回
object
isUint8Array(unknown)
如果值是内置 true
实例,则返回 Uint8Array
。
util.types.isUint8Array(new ArrayBuffer()); // Returns false
util.types.isUint8Array(new Uint8Array()); // Returns true
util.types.isUint8Array(new Float64Array()); // Returns false
function isUint8Array(object: unknown): object
参数
- object
-
unknown
返回
object
isUint8ClampedArray(unknown)
如果值是内置 true
实例,则返回 Uint8ClampedArray
。
util.types.isUint8ClampedArray(new ArrayBuffer()); // Returns false
util.types.isUint8ClampedArray(new Uint8ClampedArray()); // Returns true
util.types.isUint8ClampedArray(new Float64Array()); // Returns false
function isUint8ClampedArray(object: unknown): object
参数
- object
-
unknown
返回
object
isWeakMap(unknown)
如果值是内置 true
实例,则返回 WeakMap
。
util.types.isWeakMap(new WeakMap()); // Returns true
function isWeakMap(object: unknown): object
参数
- object
-
unknown
返回
object
isWeakSet(unknown)
如果值是内置 true
实例,则返回 WeakSet
。
util.types.isWeakSet(new WeakSet()); // Returns true
function isWeakSet(object: unknown): object
参数
- object
-
unknown
返回
object