types module

Returnerar true om värdet är en inbyggd ArrayBuffer eller SharedArrayBuffer instans.

Se även util.types.isArrayBuffer() och util.types.isSharedArrayBuffer().

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

function isAnyArrayBuffer(object: unknown): object

Parametrar

Returer

Returnerar true om värdet är ett arguments objekt.

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

function isArgumentsObject(object: unknown): object

Parametrar

Returer

Returnerar true om värdet är en inbyggd ArrayBuffer instans. Detta inte inkludera SharedArrayBuffer instanser. Vanligtvis är det önskvärt att testa för båda; Se util.types.isAnyArrayBuffer() för det.

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

function isArrayBuffer(object: unknown): object

Parametrar

Returer

Returnerar true om värdet är en instans av en av de ArrayBuffer vyerna, till exempel typerade matrisobjekt eller DataView. Motsvarar 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

Parametrar

Returer

Returnerar true om värdet är en asynkron funktion. Detta rapporterar bara tillbaka vad JavaScript-motorn ser. I synnerhet kanske returvärdet inte matchar den ursprungliga källkoden om ett transpileringsverktyg användes.

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

function isAsyncFunction(object: unknown): boolean

Parametrar

Returer

Returnerar true om värdet är en BigInt64Array instans.

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

function isBigInt64Array(value: unknown): value

Parametrar

Returer

Returnerar true om värdet är en BigUint64Array instans.

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

function isBigUint64Array(value: unknown): value

Parametrar

Returer

Returnerar true om värdet är ett booleskt objekt, t.ex. skapat av 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

Parametrar

Returer

Returnerar true om värdet är ett rutat primitivt objekt, t.ex. skapat av new Boolean(), new String() eller Object(Symbol()).

Till exempel:

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

Parametrar

Returer

Returnerar true om value är en CryptoKey, false annars.

function isCryptoKey(object: unknown): object

Parametrar

Returer

Returnerar true om värdet är en inbyggd DataView instans.

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

Se även ArrayBuffer.isView().

function isDataView(object: unknown): object

Parametrar

Returer

Returnerar true om värdet är en inbyggd Date instans.

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

function isDate(object: unknown): object

Parametrar

Returer

Returnerar true om värdet är ett internt External värde.

Ett internt External värde är en särskild typ av objekt som innehåller en rå C++-pekare (void*) för åtkomst från inbyggd kod och som inte har några andra egenskaper. Sådana objekt skapas antingen av Node.js interna eller interna tillägg. I JavaScript är de frysta objekt med ennull 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, &#x26;result);
  if (status != napi_ok) {
    napi_throw_error(env, NULL, "napi_create_external failed");
    return NULL;
  }
  return result;
}
...
DECLARE_NAPI_PROPERTY("myNapi", MyNapi)
...

const native = require('napi_addon.node');
const data = native.myNapi();
util.types.isExternal(data); // returns true
util.types.isExternal(0); // returns false
util.types.isExternal(new String('foo')); // returns false

Mer information om napi_create_externalfinns i napi_create_external().

function isExternal(object: unknown): boolean

Parametrar

Returer

Returnerar true om värdet är en inbyggd Float32Array instans.

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

Parametrar

Returer

Returnerar true om värdet är en inbyggd Float64Array instans.

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

Parametrar

Returer

Returnerar true om värdet är en generatorfunktion. Detta rapporterar bara tillbaka vad JavaScript-motorn ser. I synnerhet kanske returvärdet inte matchar den ursprungliga källkoden om ett transpileringsverktyg användes.

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

function isGeneratorFunction(object: unknown): object

Parametrar

Returer

Returnerar true om värdet är ett generatorobjekt som returneras från en inbyggd generatorfunktion. Detta rapporterar bara tillbaka vad JavaScript-motorn ser. I synnerhet kanske returvärdet inte matchar den ursprungliga källkoden om ett transpileringsverktyg användes.

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

function isGeneratorObject(object: unknown): object

Parametrar

Returer

Returnerar true om värdet är en inbyggd Int16Array instans.

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

Parametrar

Returer

Returnerar true om värdet är en inbyggd Int32Array instans.

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

Parametrar

Returer

Returnerar true om värdet är en inbyggd Int8Array instans.

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

Parametrar

Returer

Returnerar true om value är en KeyObject, false annars.

function isKeyObject(object: unknown): object

Parametrar

Returer

Returnerar true om värdet är en inbyggd Map instans.

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

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

Parametrar

Returer

Returnerar true om värdet är en iterator som returneras för en inbyggd Map instans.

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

Parametrar

Returer

Returnerar true om värdet är en instans av ett modulnamnområdesobjekt.

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

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

function isModuleNamespaceObject(value: unknown): boolean

Parametrar

Returer

Returnerar true om värdet returnerades av konstruktorn för en inbyggd Error typ.

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

Underklasser av de interna feltyperna är också interna fel:

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

Ett värde som instanceof en intern felklass motsvarar inte isNativeError() returnerar true för det värdet. isNativeError() returnerar true för fel som kommer från en annan sfär medan instanceof Error returnerar false för dessa fel:

const vm = require('node:vm');
const context = vm.createContext({});
const myError = vm.runInContext('new Error()', context);
console.log(util.types.isNativeError(myError)); // true
console.log(myError instanceof Error); // false

Omvänt returnerar isNativeError()false för alla objekt som inte returnerades av konstruktorn för ett internt fel. Det inkluderar värden som är instanceof interna fel:

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

function isNativeError(object: unknown): object

Parametrar

Returer

Returnerar true om värdet är ett talobjekt, t.ex. skapat av new Number().

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

function isNumberObject(object: unknown): object

Parametrar

Returer

Returnerar true om värdet är en inbyggd Promise.

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

function isPromise(object: unknown): object

Parametrar

Returer

Returnerar true om värdet är en Proxy instans.

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

function isProxy(object: unknown): boolean

Parametrar

Returer

Returnerar true om värdet är ett reguljärt uttrycksobjekt.

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

function isRegExp(object: unknown): object

Parametrar

Returer

Returnerar true om värdet är en inbyggd Set instans.

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

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

Parametrar

Returer

Returnerar true om värdet är en iterator som returneras för en inbyggd Set instans.

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

Parametrar

Returer

Returnerar true om värdet är en inbyggd SharedArrayBuffer instans. Detta inte inkludera ArrayBuffer instanser. Vanligtvis är det önskvärt att testa för båda; Se util.types.isAnyArrayBuffer() för det.

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

function isSharedArrayBuffer(object: unknown): object

Parametrar

Returer

Returnerar true om värdet är ett strängobjekt, t.ex. skapat av new String().

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

function isStringObject(object: unknown): object

Parametrar

Returer

Returnerar true om värdet är ett symbolobjekt som skapas genom att anropa Object() på en Symbol primitiv.

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

function isSymbolObject(object: unknown): object

Parametrar

Returer

Returnerar true om värdet är en inbyggd TypedArray instans.

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

Se även ArrayBuffer.isView().

function isTypedArray(object: unknown): object

Parametrar

Returer

Returnerar true om värdet är en inbyggd Uint16Array instans.

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

Parametrar

Returer

Returnerar true om värdet är en inbyggd Uint32Array instans.

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

Parametrar

Returer

Returnerar true om värdet är en inbyggd Uint8Array instans.

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

Parametrar

Returer

Returnerar true om värdet är en inbyggd Uint8ClampedArray instans.

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

Parametrar

Returer

Returnerar true om värdet är en inbyggd WeakMap instans.

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

function isWeakMap(object: unknown): object

Parametrar

Returer

Returnerar true om värdet är en inbyggd WeakSet instans.

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

function isWeakSet(object: unknown): object

Parametrar

Returer