types module

Gibt true zurück, wenn der Wert eine integrierte ArrayBuffer- oder SharedArrayBuffer Instanz ist.

Siehe auch util.types.isArrayBuffer() und util.types.isSharedArrayBuffer().

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

function isAnyArrayBuffer(object: unknown): object

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert ein arguments -Objekt ist.

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

function isArgumentsObject(object: unknown): object

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte ArrayBuffer Instanz ist. Dies nichtSharedArrayBuffer Instanzen enthalten. In der Regel ist es wünschenswert, beide zu testen; Siehe util.types.isAnyArrayBuffer() dazu.

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

function isArrayBuffer(object: unknown): object

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine Instanz einer der ArrayBuffer Ansichten ist, z. B. typierte Arrayobjekte oder DataView. Entspricht 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

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine asynchrone Funktionist. Dies meldet nur, was das JavaScript-Modul sieht; Insbesondere entspricht der Rückgabewert möglicherweise nicht dem ursprünglichen Quellcode, wenn ein Transpilierungstool verwendet wurde.

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

function isAsyncFunction(object: unknown): boolean

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine BigInt64Array Instanz ist.

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

function isBigInt64Array(value: unknown): value

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert ein BigInt -Objekt ist, z. B. von Object(BigInt(123))erstellt.

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

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine BigUint64Array Instanz ist.

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

function isBigUint64Array(value: unknown): value

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert ein boolesches Objekt ist, z. B. von new Boolean()erstellt.

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

Parameter

Gibt zurück

Gibt true zurück, wenn es sich bei dem Wert um ein boxed primitives Objekt handelt, z. B. durch new Boolean(), new String() oder Object(Symbol())erstellt.

Zum Beispiel:

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

Parameter

Gibt zurück

Gibt true zurück, wenn value ein CryptoKeyist, andernfalls false.

function isCryptoKey(object: unknown): object

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte DataView Instanz ist.

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

Siehe auch ArrayBuffer.isView().

function isDataView(object: unknown): object

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte Date Instanz ist.

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

function isDate(object: unknown): object

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert ein systemeigener External Wert ist.

Ein systemeigener External-Wert ist ein spezieller Objekttyp, der einen unformatierten C++-Zeiger (void*) für den Zugriff von systemeigenem Code enthält und keine anderen Eigenschaften aufweist. Solche Objekte werden entweder durch Node.js Interne oder systemeigene Addons erstellt. In JavaScript sind sie fixierte Objekte mit einem null Prototyp.

#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

Weitere Informationen zu napi_create_externalfinden Sie unter napi_create_external().

function isExternal(object: unknown): boolean

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte Float16Array Instanz ist.

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

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte Float32Array Instanz ist.

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

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte Float64Array Instanz ist.

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

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine Generatorfunktion ist. Dies meldet nur, was das JavaScript-Modul sieht; Insbesondere entspricht der Rückgabewert möglicherweise nicht dem ursprünglichen Quellcode, wenn ein Transpilierungstool verwendet wurde.

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

function isGeneratorFunction(object: unknown): object

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert ein Generatorobjekt ist, das von einer integrierten Generatorfunktion zurückgegeben wird. Dies meldet nur, was das JavaScript-Modul sieht; Insbesondere entspricht der Rückgabewert möglicherweise nicht dem ursprünglichen Quellcode, wenn ein Transpilierungstool verwendet wurde.

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

function isGeneratorObject(object: unknown): object

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte Int16Array Instanz ist.

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

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte Int32Array Instanz ist.

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

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte Int8Array Instanz ist.

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

Parameter

Gibt zurück

Gibt true zurück, wenn value ein KeyObjectist, andernfalls false.

function isKeyObject(object: unknown): object

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte Map Instanz ist.

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

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

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert ein Iterator ist, der für eine integrierte Map Instanz zurückgegeben wird.

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

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine Instanz eines Module Namespace Objectist.

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

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

function isModuleNamespaceObject(value: unknown): boolean

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert vom Konstruktor eines integrierten Error Typszurückgegeben wurde.

console.log(util.types.isNativeError(new Error()));  // true
console.log(util.types.isNativeError(new TypeError()));  // true
console.log(util.types.isNativeError(new RangeError()));  // true

Unterklassen der systemeigenen Fehlertypen sind auch systemeigene Fehler:

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

Ein Wert instanceof einer systemeigenen Fehlerklasse entspricht nicht isNativeError() rückgabenden true für diesen Wert. isNativeError() gibt true für Fehler zurück, die aus einem anderen Bereich stammen, während instanceof Error für diese Fehler false zurückgibt:

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

Umgekehrt gibt isNativeError()false für alle Objekte zurück, die nicht vom Konstruktor eines systemeigenen Fehlers zurückgegeben wurden. Dazu gehören Werte, die instanceof systemeigenen Fehler sind:

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

function isNativeError(object: unknown): object

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert ein Zahlenobjekt ist, z. B. von new Number()erstellt.

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

function isNumberObject(object: unknown): object

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert ein integriertes Promiseist.

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

function isPromise(object: unknown): object

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine Proxy Instanz ist.

const target = {};
const proxy = new Proxy(target, {});
util.types.isProxy(target);  // Returns false
util.types.isProxy(proxy);  // Returns true

function isProxy(object: unknown): boolean

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert ein reguläres Ausdrucksobjekt ist.

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

function isRegExp(object: unknown): object

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte Set Instanz ist.

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

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

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert ein Iterator ist, der für eine integrierte Set Instanz zurückgegeben wird.

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

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte SharedArrayBuffer Instanz ist. Dies nichtArrayBuffer Instanzen enthalten. In der Regel ist es wünschenswert, beide zu testen; Siehe util.types.isAnyArrayBuffer() dazu.

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

function isSharedArrayBuffer(object: unknown): object

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert ein Zeichenfolgenobjekt ist, z. B. von new String()erstellt.

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

function isStringObject(object: unknown): object

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert ein Symbolobjekt ist, das durch Aufrufen von Object() für einen Symbol Grundtyp erstellt wird.

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

function isSymbolObject(object: unknown): object

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte TypedArray Instanz ist.

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

Siehe auch ArrayBuffer.isView().

function isTypedArray(object: unknown): object

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte Uint16Array Instanz ist.

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

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte Uint32Array Instanz ist.

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

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte Uint8Array Instanz ist.

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

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte Uint8ClampedArray Instanz ist.

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

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte WeakMap Instanz ist.

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

function isWeakMap(object: unknown): object

Parameter

Gibt zurück

Gibt true zurück, wenn der Wert eine integrierte WeakSet Instanz ist.

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

function isWeakSet(object: unknown): object

Parameter

Gibt zurück