types module

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem ArrayBuffer lub SharedArrayBuffer.

Zobacz również util.types.isArrayBuffer() i util.types.isSharedArrayBuffer().

util.types.isAnyArrayBuffer(new ArrayBuffer());  // Returns true
util.types.isAnyArrayBuffer(new SharedArrayBuffer());  // Returns true

function isAnyArrayBuffer(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest obiektem arguments.

function foo() {
  util.types.isArgumentsObject(arguments);  // Returns true
}

function isArgumentsObject(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem ArrayBuffer. Nie uwzględniać wystąpień SharedArrayBuffer. Zazwyczaj pożądane jest przetestowanie obu tych metod; Zobacz util.types.isAnyArrayBuffer(), aby to sprawdzić.

util.types.isArrayBuffer(new ArrayBuffer());  // Returns true
util.types.isArrayBuffer(new SharedArrayBuffer());  // Returns false

function isArrayBuffer(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest wystąpieniem jednego z widoków ArrayBuffer, takich jak typizowane obiekty tablicowe lub DataView. Odpowiednik 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

Parametry

Zwraca

Zwraca true, jeśli wartość jest funkcją asynchroniową . Zgłasza to tylko, co widzi aparat JavaScript; w szczególności wartość zwracana może nie być zgodna z oryginalnym kodem źródłowym, jeśli użyto narzędzia transpilacji.

util.types.isAsyncFunction(function foo() {});  // Returns false
util.types.isAsyncFunction(async function foo() {});  // Returns true

function isAsyncFunction(object: unknown): boolean

Parametry

Zwraca

Zwraca true, jeśli wartość jest wystąpieniem BigInt64Array.

util.types.isBigInt64Array(new BigInt64Array());   // Returns true
util.types.isBigInt64Array(new BigUint64Array());  // Returns false

function isBigInt64Array(value: unknown): value

Parametry

Zwraca

Zwraca true, jeśli wartość jest obiektem BigInt, np. utworzonym przez 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

Parametry

Zwraca

Zwraca true, jeśli wartość jest wystąpieniem BigUint64Array.

util.types.isBigUint64Array(new BigInt64Array());   // Returns false
util.types.isBigUint64Array(new BigUint64Array());  // Returns true

function isBigUint64Array(value: unknown): value

Parametry

Zwraca

Zwraca true, jeśli wartość jest obiektem logicznym, np. utworzonym przez 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

Parametry

Zwraca

Zwraca true, jeśli wartość jest dowolnym obiektem pierwotnym pola, np. utworzonym przez new Boolean(), new String() lub Object(Symbol()).

Na przykład:

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

Parametry

Zwraca

Zwraca true, jeśli value jest CryptoKey, false w przeciwnym razie.

function isCryptoKey(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem DataView.

const ab = new ArrayBuffer(20);
util.types.isDataView(new DataView(ab));  // Returns true
util.types.isDataView(new Float64Array());  // Returns false

Zobacz również ArrayBuffer.isView().

function isDataView(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem Date.

util.types.isDate(new Date());  // Returns true

function isDate(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest wartością natywną External.

Natywna wartość External to specjalny typ obiektu, który zawiera nieprzetworzone wskaźniki języka C++ (void*) na potrzeby dostępu z kodu natywnego i nie ma innych właściwości. Takie obiekty są tworzone przez Node.js wewnętrznych lub natywnych dodatków. W języku JavaScript są zamrożone obiekty z prototypem 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

Aby uzyskać więcej informacji na temat napi_create_external, zobacz napi_create_external().

function isExternal(object: unknown): boolean

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem Float16Array.

util.types.isFloat16Array(new ArrayBuffer());  // Returns false
util.types.isFloat16Array(new Float16Array());  // Returns true
util.types.isFloat16Array(new Float32Array());  // Returns false

function isFloat16Array(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem 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

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem 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

Parametry

Zwraca

Zwraca true, jeśli wartość jest funkcją generatora. Zgłasza to tylko, co widzi aparat JavaScript; w szczególności wartość zwracana może nie być zgodna z oryginalnym kodem źródłowym, jeśli użyto narzędzia transpilacji.

util.types.isGeneratorFunction(function foo() {});  // Returns false
util.types.isGeneratorFunction(function* foo() {});  // Returns true

function isGeneratorFunction(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest obiektem generatora zwracanym z wbudowanej funkcji generatora. Zgłasza to tylko, co widzi aparat JavaScript; w szczególności wartość zwracana może nie być zgodna z oryginalnym kodem źródłowym, jeśli użyto narzędzia transpilacji.

function* foo() {}
const generator = foo();
util.types.isGeneratorObject(generator);  // Returns true

function isGeneratorObject(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem 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

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem 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

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem 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

Parametry

Zwraca

Zwraca true, jeśli value jest KeyObject, false w przeciwnym razie.

function isKeyObject(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem Map.

util.types.isMap(new Map());  // Returns true

function isMap<T>(object: {} | T): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest iteratorem zwróconym dla wbudowanego wystąpienia 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

Parametry

Zwraca

Zwraca true, jeśli wartość jest wystąpieniem obiektu przestrzeni nazw modułu .

import * as ns from './a.js';

util.types.isModuleNamespaceObject(ns);  // Returns true

function isModuleNamespaceObject(value: unknown): boolean

Parametry

Zwraca

Zwraca true, jeśli wartość została zwrócona przez konstruktor wbudowanego typu 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

Podklasy typów błędów natywnych są również błędami natywnymi:

class MyError extends Error {}
console.log(util.types.isNativeError(new MyError()));  // true

Wartość instanceof natywnej klasy błędów nie jest równoważna isNativeError() zwracaniu true dla tej wartości. isNativeError() zwraca true błędów, które pochodzą z innego obszaru , podczas gdy instanceof Error zwraca false dla tych błędów:

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

Z drugiej strony isNativeError() zwraca false dla wszystkich obiektów, które nie zostały zwrócone przez konstruktora błędu natywnego. Obejmuje to wartości, które są instanceof błędów natywnych:

const myError = { __proto__: Error.prototype };
console.log(util.types.isNativeError(myError)); // false
console.log(myError instanceof Error); // true

function isNativeError(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest obiektem liczbowym, np. utworzonym przez new Number().

util.types.isNumberObject(0);  // Returns false
util.types.isNumberObject(new Number(0));   // Returns true

function isNumberObject(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowaną Promise.

util.types.isPromise(Promise.resolve(42));  // Returns true

function isPromise(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest wystąpieniem 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

Parametry

Zwraca

Zwraca true, jeśli wartość jest obiektem wyrażenia regularnego.

util.types.isRegExp(/abc/);  // Returns true
util.types.isRegExp(new RegExp('abc'));  // Returns true

function isRegExp(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem Set.

util.types.isSet(new Set());  // Returns true

function isSet<T>(object: {} | T): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest iteratorem zwróconym dla wbudowanego wystąpienia 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

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem SharedArrayBuffer. Nie uwzględniać wystąpień ArrayBuffer. Zazwyczaj pożądane jest przetestowanie obu tych metod; Zobacz util.types.isAnyArrayBuffer(), aby to sprawdzić.

util.types.isSharedArrayBuffer(new ArrayBuffer());  // Returns false
util.types.isSharedArrayBuffer(new SharedArrayBuffer());  // Returns true

function isSharedArrayBuffer(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest obiektem ciągu, np. utworzonym przez new String().

util.types.isStringObject('foo');  // Returns false
util.types.isStringObject(new String('foo'));   // Returns true

function isStringObject(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest obiektem symbolu, utworzonym przez wywołanie Object() na Symbol pierwotnym.

const symbol = Symbol('foo');
util.types.isSymbolObject(symbol);  // Returns false
util.types.isSymbolObject(Object(symbol));   // Returns true

function isSymbolObject(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem TypedArray.

util.types.isTypedArray(new ArrayBuffer());  // Returns false
util.types.isTypedArray(new Uint8Array());  // Returns true
util.types.isTypedArray(new Float64Array());  // Returns true

Zobacz również ArrayBuffer.isView().

function isTypedArray(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem 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

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem 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

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem 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

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem 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

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem WeakMap.

util.types.isWeakMap(new WeakMap());  // Returns true

function isWeakMap(object: unknown): object

Parametry

Zwraca

Zwraca true, jeśli wartość jest wbudowanym wystąpieniem WeakSet.

util.types.isWeakSet(new WeakSet());  // Returns true

function isWeakSet(object: unknown): object

Parametry

Zwraca