types module

Retorna true se o valor for um ArrayBuffer interno ou SharedArrayBuffer instância.

Ver também util.types.isArrayBuffer() e util.types.isSharedArrayBuffer().

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

function isAnyArrayBuffer(object: unknown): object

Parâmetros

Devoluções

Retorna true se o valor for um objeto arguments.

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

function isArgumentsObject(object: unknown): object

Parâmetros

Devoluções

Retorna true se o valor for uma instância ArrayBuffer interna. Isso não incluiSharedArrayBuffer instâncias. Normalmente, é desejável testar para ambos; Veja util.types.isAnyArrayBuffer() para isso.

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

function isArrayBuffer(object: unknown): object

Parâmetros

Devoluções

Retorna true se o valor for uma instância de uma das ArrayBuffer modos de exibição, como objetos de matriz digitados ou DataView. Equivalente a 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

Parâmetros

Devoluções

Retorna true se o valor for uma função assíncrona . Isso apenas relata o que o mecanismo JavaScript está vendo; Em particular, o valor de retorno pode não corresponder ao código-fonte original se uma ferramenta de transpilação foi usada.

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

function isAsyncFunction(object: unknown): boolean

Parâmetros

Devoluções

Retorna true se o valor for uma instância BigInt64Array.

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

function isBigInt64Array(value: unknown): value

Parâmetros

Devoluções

Retorna true se o valor for uma instância BigUint64Array.

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

function isBigUint64Array(value: unknown): value

Parâmetros

Devoluções

Retorna true se o valor for um objeto booleano, por exemplo, criado por 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

Parâmetros

Devoluções

Retorna true se o valor for qualquer objeto primitivo em caixa, por exemplo, criado por new Boolean(), new String() ou Object(Symbol()).

Por exemplo:

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

Parâmetros

Devoluções

Retorna true se value for um CryptoKeyfalse caso contrário.

function isCryptoKey(object: unknown): object

Parâmetros

Devoluções

Retorna true se o valor for uma instância DataView interna.

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

Ver também ArrayBuffer.isView().

function isDataView(object: unknown): object

Parâmetros

Devoluções

Retorna true se o valor for uma instância Date interna.

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

function isDate(object: unknown): object

Parâmetros

Devoluções

Retorna true se o valor for um valor External nativo.

Um valor External nativo é um tipo especial de objeto que contém um ponteiro C++ bruto (void*) para acesso a partir de código nativo e não tem outras propriedades. Tais objetos são criados por Node.js internos ou addons nativos. Em JavaScript, eles são congelados objetos com um protótiponull.

#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

Para obter mais informações sobre napi_create_external, consulte napi_create_external().

function isExternal(object: unknown): boolean

Parâmetros

Devoluções

Retorna true se o valor for uma instância Float32Array interna.

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

Parâmetros

Devoluções

Retorna true se o valor for uma instância Float64Array interna.

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

Parâmetros

Devoluções

Retorna true se o valor for uma função geradora. Isso apenas relata o que o mecanismo JavaScript está vendo; Em particular, o valor de retorno pode não corresponder ao código-fonte original se uma ferramenta de transpilação foi usada.

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

function isGeneratorFunction(object: unknown): object

Parâmetros

Devoluções

Retorna true se o valor for um objeto gerador como retornado de uma função de gerador interna. Isso apenas relata o que o mecanismo JavaScript está vendo; Em particular, o valor de retorno pode não corresponder ao código-fonte original se uma ferramenta de transpilação foi usada.

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

function isGeneratorObject(object: unknown): object

Parâmetros

Devoluções

Retorna true se o valor for uma instância Int16Array interna.

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

Parâmetros

Devoluções

Retorna true se o valor for uma instância Int32Array interna.

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

Parâmetros

Devoluções

Retorna true se o valor for uma instância Int8Array interna.

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

Parâmetros

Devoluções

Retorna true se value for um KeyObjectfalse caso contrário.

function isKeyObject(object: unknown): object

Parâmetros

Devoluções

Retorna true se o valor for uma instância Map interna.

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

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

Parâmetros

Devoluções

Retorna true se o valor for um iterador retornado para uma instância Map interna.

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

Parâmetros

Devoluções

Retorna true se o valor for uma instância de um Module Namespace Object.

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

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

function isModuleNamespaceObject(value: unknown): boolean

Parâmetros

Devoluções

Retorna true se o valor foi retornado pelo construtor de um interno Error tipo.

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

Subclasses dos tipos de erro nativos também são erros nativos:

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

Um valor sendo instanceof uma classe de erro nativa não é equivalente a isNativeError() retornando true para esse valor. retorna para erros que vêm de um de domínio diferente, enquanto retorna para esses erros:

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

Por outro lado, isNativeError() retorna false para todos os objetos que não foram retornados pelo construtor de um erro nativo. Isso inclui valores que são instanceof erros nativos:

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

function isNativeError(object: unknown): object

Parâmetros

Devoluções

Retorna true se o valor for um objeto numérico, por exemplo, criado por new Number().

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

function isNumberObject(object: unknown): object

Parâmetros

Devoluções

Retorna true se o valor for um Promiseinterno.

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

function isPromise(object: unknown): object

Parâmetros

Devoluções

Retorna true se o valor for uma instância 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

Parâmetros

Devoluções

Retorna true se o valor for um objeto de expressão regular.

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

function isRegExp(object: unknown): object

Parâmetros

Devoluções

Retorna true se o valor for uma instância Set interna.

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

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

Parâmetros

Devoluções

Retorna true se o valor for um iterador retornado para uma instância Set interna.

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

Parâmetros

Devoluções

Retorna true se o valor for uma instância SharedArrayBuffer interna. Isso não incluiArrayBuffer instâncias. Normalmente, é desejável testar para ambos; Veja util.types.isAnyArrayBuffer() para isso.

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

function isSharedArrayBuffer(object: unknown): object

Parâmetros

Devoluções

Retorna true se o valor for um objeto string, por exemplo, criado por new String().

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

function isStringObject(object: unknown): object

Parâmetros

Devoluções

Retorna true se o valor for um objeto de símbolo, criado chamando Object() em um primitivo Symbol.

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

function isSymbolObject(object: unknown): object

Parâmetros

Devoluções

Retorna true se o valor for uma instância TypedArray interna.

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

Ver também ArrayBuffer.isView().

function isTypedArray(object: unknown): object

Parâmetros

Devoluções

Retorna true se o valor for uma instância Uint16Array interna.

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

Parâmetros

Devoluções

Retorna true se o valor for uma instância Uint32Array interna.

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

Parâmetros

Devoluções

Retorna true se o valor for uma instância Uint8Array interna.

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

Parâmetros

Devoluções

Retorna true se o valor for uma instância Uint8ClampedArray interna.

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

Parâmetros

Devoluções

Retorna true se o valor for uma instância WeakMap interna.

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

function isWeakMap(object: unknown): object

Parâmetros

Devoluções

Retorna true se o valor for uma instância WeakSet interna.

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

function isWeakSet(object: unknown): object

Parâmetros

Devoluções