util/types

Использование в Deno

import * as mod from "node:util/types";

функция isAnyArrayBuffer

Использование в Deno

import { isAnyArrayBuffer } from "node:util/types";

isAnyArrayBuffer(object: unknown): object is ArrayBufferLike

Возвращает true, если значение является встроенным экземпляром ArrayBuffer или SharedArrayBuffer.

См. также util.types.isArrayBuffer() и util.types.isSharedArrayBuffer().

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

Параметры

object: unknown

Тип возвращаемого значения

object is ArrayBufferLike

функция isArrayBuffer

Использование в Deno

import { isArrayBuffer } from "node:util/types";

isArrayBuffer(object: unknown): object is ArrayBuffer

Возвращает true, если значение является экземпляром встроенного ArrayBuffer. Сюда не входят экземпляры SharedArrayBuffer. Обычно желательно проверять оба типа; см. util.types.isAnyArrayBuffer().

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

Параметры

object: unknown

Тип возвращаемого значения

object is ArrayBuffer

функция isArrayBufferView

Использование в Deno

import { isArrayBufferView } from "node:util/types";

isArrayBufferView(object: unknown): object is ArrayBufferView

Возвращает 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

Параметры

object: unknown

Тип возвращаемого значения

object is ArrayBufferView

функция isAsyncFunction

Использование в Deno

import { isAsyncFunction } from "node:util/types";

isAsyncFunction(object: unknown): boolean

Возвращает true, если значение является асинхронной функцией. Функция сообщает только то, что видит движок JavaScript; в частности, возвращаемое значение может не совпадать с исходным кодом, если использовался инструмент транспиляции.

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

Параметры

object: unknown

Тип возвращаемого значения

boolean

функция isBigInt64Array

Использование в Deno

import { isBigInt64Array } from "node:util/types";

isBigInt64Array(value: unknown): value is BigInt64Array

Возвращает true, если значение является экземпляром BigInt64Array.

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

Параметры

value: unknown

Тип возвращаемого значения

value is BigInt64Array

функция isBigIntObject

Использование в Deno

import { isBigIntObject } from "node:util/types";

isBigIntObject(object: unknown): object is BigInt

Возвращает true, если значение является объектом BigInt, например созданным с помощью Object(BigInt(123)).

util.types.isBigIntObject(Object(BigInt(123)));   // Returns true
util.types.isBigIntObject(BigInt(123));   // Returns false
util.types.isBigIntObject(123);  // Returns false

Параметры

object: unknown

Тип возвращаемого значения

object is BigInt

функция isBigUint64Array

Использование в Deno

import { isBigUint64Array } from "node:util/types";

isBigUint64Array(value: unknown): value is BigUint64Array

Возвращает true, если значение является экземпляром BigUint64Array.

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

Параметры

value: unknown

Тип возвращаемого значения

value is BigUint64Array

функция isBooleanObject

Использование в Deno

import { isBooleanObject } from "node:util/types";

isBooleanObject(object: unknown): object is Boolean

Возвращает true, если значение является объектом Boolean, например созданным с помощью 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

Параметры

object: unknown

Тип возвращаемого значения

object is Boolean

функция isBoxedPrimitive

Использование в Deno

import { isBoxedPrimitive } from "node:util/types";

isBoxedPrimitive(object: unknown): object is 
String
 | Number
 | BigInt
 | Boolean
 | Symbol

Возвращает 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

Параметры

object: unknown

Тип возвращаемого значения

object is 
String
 | Number
 | BigInt
 | Boolean
 | Symbol

функция isCryptoKey

Использование в Deno

import { isCryptoKey } from "node:util/types";

isCryptoKey(object: unknown): object is webcrypto.CryptoKey

Возвращает true, если value является CryptoKey, и false в противном случае.

Параметры

object: unknown

Тип возвращаемого значения

object is webcrypto.CryptoKey

функция isDataView

Использование в Deno

import { isDataView } from "node:util/types";

isDataView(object: unknown): object is DataView

Возвращает true, если значение является экземпляром встроенного DataView.

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

См. также ArrayBuffer.isView().

Параметры

object: unknown

Тип возвращаемого значения

object is DataView

функция isDate

Использование в Deno

import { isDate } from "node:util/types";

isDate(object: unknown): object is Date

Возвращает true, если значение является экземпляром встроенного Date.

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

Параметры

object: unknown

Тип возвращаемого значения

object is Date

функция isExternal

Использование в Deno

import { isExternal } from "node:util/types";

isExternal(object: unknown): boolean

Возвращает 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, &#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

Дополнительную информацию о napi_create_external см. в napi_create_external().

Параметры

object: unknown

Тип возвращаемого значения

boolean

функция isFloat32Array

Использование в Deno

import { isFloat32Array } from "node:util/types";

isFloat32Array(object: unknown): object is Float32Array

Возвращает true, если значение является экземпляром встроенного Float32Array.

util.types.isFloat32Array(new ArrayBuffer());  // Returns false
util.types.isFloat32Array(new Float32Array());  // Returns true
util.types.isFloat32Array(new Float64Array());  // Returns false

Параметры

object: unknown

Тип возвращаемого значения

object is Float32Array

функция isFloat64Array

Использование в Deno

import { isFloat64Array } from "node:util/types";

isFloat64Array(object: unknown): object is Float64Array

Возвращает true, если значение является экземпляром встроенного Float64Array.

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

Параметры

object: unknown

Тип возвращаемого значения

object is Float64Array

функция isGeneratorFunction

Использование в Deno

import { isGeneratorFunction } from "node:util/types";

isGeneratorFunction(object: unknown): object is GeneratorFunction

Возвращает true, если значение является функцией-генератором. Функция сообщает только то, что видит движок JavaScript; в частности, возвращаемое значение может не совпадать с исходным кодом, если использовался инструмент транспиляции.

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

Параметры

object: unknown

Тип возвращаемого значения

object is GeneratorFunction

функция isGeneratorObject

Использование в Deno

import { isGeneratorObject } from "node:util/types";

isGeneratorObject(object: unknown): object is Generator

Возвращает true, если значение является объектом-генератором, возвращённым встроенной функцией-генератором. Это лишь отражает то, что видит движок JavaScript; в частности, возвращаемое значение может не соответствовать исходному коду, если использовался инструмент транспиляции.

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

Параметры

object: unknown

Тип возвращаемого значения

object is Generator

функция isInt16Array

Использование в Deno

import { isInt16Array } from "node:util/types";

isInt16Array(object: unknown): object is Int16Array

Возвращает true, если значение является экземпляром встроенного типа Int16Array.

util.types.isInt16Array(new ArrayBuffer());  // Returns false
util.types.isInt16Array(new Int16Array());  // Returns true
util.types.isInt16Array(new Float64Array());  // Returns false

Параметры

object: unknown

Тип возвращаемого значения

object is Int16Array

функция isInt32Array

Использование в Deno

import { isInt32Array } from "node:util/types";

isInt32Array(object: unknown): object is Int32Array

Возвращает true, если значение является экземпляром встроенного типа Int32Array.

util.types.isInt32Array(new ArrayBuffer());  // Returns false
util.types.isInt32Array(new Int32Array());  // Returns true
util.types.isInt32Array(new Float64Array());  // Returns false

Параметры

object: unknown

Тип возвращаемого значения

object is Int32Array

функция isInt8Array

Использование в Deno

import { isInt8Array } from "node:util/types";

isInt8Array(object: unknown): object is Int8Array

Возвращает true, если значение является экземпляром встроенного типа Int8Array.

util.types.isInt8Array(new ArrayBuffer());  // Returns false
util.types.isInt8Array(new Int8Array());  // Returns true
util.types.isInt8Array(new Float64Array());  // Returns false

Параметры

object: unknown

Тип возвращаемого значения

object is Int8Array

функция isKeyObject

Использование в Deno

import { isKeyObject } from "node:util/types";

isKeyObject(object: unknown): object is KeyObject

Возвращает true, если value является KeyObject, и false в противном случае.

Параметры

object: unknown

Тип возвращаемого значения

object is KeyObject

функция isMap

Использование в Deno

import { isMap } from "node:util/types";

isMap<T>(object: T | {  }): object is T extends ReadonlyMap<any, any> ? (unknown extends T ? never : ReadonlyMap<any, any>) : Map<unknown, unknown>

Возвращает true, если значение является экземпляром встроенного типа Map.

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

Параметры типа

T

Параметры

object: T | { }

Тип возвращаемого значения

object is T extends ReadonlyMap<any, any> ? (unknown extends T ? never : ReadonlyMap<any, any>) : Map<unknown, unknown>

функция isMapIterator

Использование в Deno

import { isMapIterator } from "node:util/types";

isMapIterator(object: unknown): boolean

Возвращает 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

Параметры

object: unknown

Тип возвращаемого значения

boolean

функция isModuleNamespaceObject

Использование в Deno

import { isModuleNamespaceObject } from "node:util/types";

isModuleNamespaceObject(value: unknown): boolean

Возвращает true, если значение является экземпляром объекта пространства имён модуля.

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

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

Параметры

value: unknown

Тип возвращаемого значения

boolean

функция isNativeError

Использование в Deno

import { isNativeError } from "node:util/types";

isNativeError(object: unknown): object is Error

Возвращает 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 vm from '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

И наоборот, isNativeError() возвращает false для всех объектов, которые не были возвращены конструктором встроенного типа ошибки. Сюда входят значения, которые являются instanceof встроенными ошибками:

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

Параметры

object: unknown

Тип возвращаемого значения

object is Error

функция isNumberObject

Использование в Deno

import { isNumberObject } from "node:util/types";

isNumberObject(object: unknown): object is Number

Возвращает true, если значение является числовым объектом, например созданным с помощью new Number().

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

Параметры

object: unknown

Тип возвращаемого значения

object is Number

функция isPromise

Использование в Deno

import { isPromise } from "node:util/types";

isPromise(object: unknown): object is Promise<unknown>

Возвращает true, если значение является экземпляром встроенного типа Promise.

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

Параметры

object: unknown

Тип возвращаемого значения

object is Promise<unknown>

функция isProxy

Использование в Deno

import { isProxy } from "node:util/types";

isProxy(object: unknown): boolean

Возвращает true, если значение является экземпляром Proxy.

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

Параметры

object: unknown

Тип возвращаемого значения

boolean

функция isRegExp

Использование в Deno

import { isRegExp } from "node:util/types";

isRegExp(object: unknown): object is RegExp

Возвращает true, если значение является объектом регулярного выражения.

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

Параметры

object: unknown

Тип возвращаемого значения

object is RegExp

функция isSet

Использование в Deno

import { isSet } from "node:util/types";

isSet<T>(object: T | {  }): object is T extends ReadonlySet<any> ? (unknown extends T ? never : ReadonlySet<any>) : Set<unknown>

Возвращает true, если значение является экземпляром встроенного типа Set.

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

Параметры типа

T

Параметры

object: T | { }

Тип возвращаемого значения

object is T extends ReadonlySet<any> ? (unknown extends T ? never : ReadonlySet<any>) : Set<unknown>

функция isSetIterator

Использование в Deno

import { isSetIterator } from "node:util/types";

isSetIterator(object: unknown): boolean

Возвращает 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

Параметры

object: unknown

Тип возвращаемого значения

boolean

функция isSharedArrayBuffer

Использование в Deno

import { isSharedArrayBuffer } from "node:util/types";

isSharedArrayBuffer(object: unknown): object is SharedArrayBuffer

Возвращает true, если значение является экземпляром встроенного типа SharedArrayBuffer. Сюда не входят экземпляры ArrayBuffer. Обычно желательно проверять оба типа; см. util.types.isAnyArrayBuffer().

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

Параметры

object: unknown

Тип возвращаемого значения

object is SharedArrayBuffer

функция isStringObject

Использование в Deno

import { isStringObject } from "node:util/types";

isStringObject(object: unknown): object is String

Возвращает true, если значение является строковым объектом, например созданным с помощью new String().

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

Параметры

object: unknown

Тип возвращаемого значения

object is String

функция isSymbolObject

Использование в Deno

import { isSymbolObject } from "node:util/types";

isSymbolObject(object: unknown): object is Symbol

Возвращает true, если значение является объектом-символом, созданным вызовом Object() для примитива Symbol.

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

Параметры

object: unknown

Тип возвращаемого значения

object is Symbol

функция isTypedArray

Использование в Deno

import { isTypedArray } from "node:util/types";

isTypedArray(object: unknown): object is TypedArray

Возвращает 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().

Параметры

object: unknown

Тип возвращаемого значения

object is TypedArray

функция isUint16Array

Использование в Deno

import { isUint16Array } from "node:util/types";

isUint16Array(object: unknown): object is Uint16Array

Возвращает true, если значение является экземпляром встроенного типа Uint16Array.

util.types.isUint16Array(new ArrayBuffer());  // Returns false
util.types.isUint16Array(new Uint16Array());  // Returns true
util.types.isUint16Array(new Float64Array());  // Returns false

Параметры

object: unknown

Тип возвращаемого значения

object is Uint16Array

функция isUint32Array

Использование в Deno

import { isUint32Array } from "node:util/types";

isUint32Array(object: unknown): object is Uint32Array

Возвращает true, если значение является экземпляром встроенного типа Uint32Array.

util.types.isUint32Array(new ArrayBuffer());  // Returns false
util.types.isUint32Array(new Uint32Array());  // Returns true
util.types.isUint32Array(new Float64Array());  // Returns false

Параметры

object: unknown

Тип возвращаемого значения

object is Uint32Array

функция isUint8Array

Использование в Deno

import { isUint8Array } from "node:util/types";

isUint8Array(object: unknown): object is Uint8Array

Возвращает true, если значение является экземпляром встроенного типа Uint8Array.

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

Параметры

object: unknown

Тип возвращаемого значения

object is Uint8Array

функция isUint8ClampedArray

Использование в Deno

import { isUint8ClampedArray } from "node:util/types";

isUint8ClampedArray(object: unknown): object is Uint8ClampedArray

Возвращает true, если значение является экземпляром встроенного типа Uint8ClampedArray.

util.types.isUint8ClampedArray(new ArrayBuffer());  // Returns false
util.types.isUint8ClampedArray(new Uint8ClampedArray());  // Returns true
util.types.isUint8ClampedArray(new Float64Array());  // Returns false

Параметры

object: unknown

Тип возвращаемого значения

object is Uint8ClampedArray

функция isWeakMap

Использование в Deno

import { isWeakMap } from "node:util/types";

isWeakMap(object: unknown): object is WeakMap<object, unknown>

Возвращает true, если значение является экземпляром встроенного типа WeakMap.

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

Параметры

object: unknown

Тип возвращаемого значения

object is WeakMap<object, unknown>

функция isWeakSet

Использование в Deno

import { isWeakSet } from "node:util/types";

isWeakSet(object: unknown): object is WeakSet<object>

Возвращает true, если значение является экземпляром встроенного типа WeakSet.

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

Параметры

object: unknown

Тип возвращаемого значения

object is WeakSet<object>

функция isAnyArrayBuffer

Использование в Deno

Параметры

Тип возвращаемого значения

функция isArgumentsObject

Использование в Deno

Параметры

Тип возвращаемого значения

функция isArrayBuffer

Использование в Deno

Параметры

Тип возвращаемого значения

функция isArrayBufferView

Использование в Deno

Параметры

Тип возвращаемого значения

функция isAsyncFunction

Использование в Deno

Параметры

Тип возвращаемого значения

функция isBigInt64Array

Использование в Deno

Параметры

Тип возвращаемого значения

функция isBigIntObject

Использование в Deno

Параметры

Тип возвращаемого значения

функция isBigUint64Array

Использование в Deno

Параметры

Тип возвращаемого значения

функция isBooleanObject

Использование в Deno

Параметры

Тип возвращаемого значения

функция isBoxedPrimitive

Использование в Deno

Параметры

Тип возвращаемого значения

функция isCryptoKey

Использование в Deno

Параметры

Тип возвращаемого значения

функция isDataView

Использование в Deno

Параметры

Тип возвращаемого значения

функция isDate

Использование в Deno

Параметры

Тип возвращаемого значения

функция isExternal

Использование в Deno

Параметры

Тип возвращаемого значения

функция isFloat32Array

Использование в Deno

Параметры

Тип возвращаемого значения

функция isFloat64Array

Использование в Deno

Параметры

Тип возвращаемого значения

функция isGeneratorFunction

Использование в Deno

Параметры

Тип возвращаемого значения

функция isGeneratorObject

Использование в Deno

Параметры

Тип возвращаемого значения

функция isInt16Array

Использование в Deno

Параметры

Тип возвращаемого значения

функция isInt32Array

Использование в Deno

Параметры

Тип возвращаемого значения