Skip to content
File

Blob: src/node/internal/util.d.ts

typescript120 lines
1// Copyright (c) 2017-2022 Cloudflare, Inc.
2// Licensed under the Apache 2.0 license found in the LICENSE file or at:
3// https://opensource.org/licenses/Apache-2.0
4 
5import perfHooks from 'node:perf_hooks';
6 
7export const Performance = perfHooks.Performance;
8export const PerformanceEntry = perfHooks.PerformanceEntry;
9export const PerformanceMeasure = perfHooks.PerformanceMeasure;
10export const PerformanceMark = perfHooks.PerformanceMark;
11export const PerformanceObserver = perfHooks.PerformanceObserver;
12export const PerformanceObserverEntryList =
13 perfHooks.PerformanceObserverEntryList;
14export const PerformanceResourceTiming = perfHooks.PerformanceResourceTiming;
15 
16export abstract class MIMEType {
17 constructor(input: string);
18 type: string;
19 subtype: string;
20 readonly essence: string;
21 readonly params: MIMEParams;
22 toString(): string;
23 toJSON(): string;
24}
25 
26export abstract class MIMEParams {
27 constructor();
28 delete(name: string): void;
29 get(name: string): string | undefined;
30 has(name: string): boolean;
31 set(name: string, value: string): void;
32 entries(): Iterable<string[]>;
33 keys(): Iterable<string>;
34 values(): Iterable<string>;
35}
36 
37export const kResourceTypeInspect: unique symbol;
38 
39export const ALL_PROPERTIES: 0;
40export const ONLY_ENUMERABLE: 1;
41export function getOwnNonIndexProperties(
42 value: unknown,
43 filter: typeof ALL_PROPERTIES | typeof ONLY_ENUMERABLE
44): PropertyKey[];
45 
46export const kPending: 0;
47export const kFulfilled: 1;
48export const kRejected: 2;
49export interface PromiseDetails {
50 state: typeof kPending | typeof kFulfilled | typeof kRejected;
51 result: unknown;
52}
53export function getPromiseDetails(value: unknown): PromiseDetails | undefined;
54 
55export interface ProxyDetails {
56 target: unknown;
57 handler: unknown;
58}
59export function getProxyDetails(value: unknown): ProxyDetails | undefined;
60 
61export interface PreviewedEntries {
62 entries: unknown[];
63 isKeyValue: boolean;
64}
65export function previewEntries(value: unknown): PreviewedEntries | undefined;
66 
67export function getConstructorName(value: unknown): string;
68 
69export function isArrayBufferView(value: unknown): value is ArrayBufferView;
70export function isArgumentsObject(value: unknown): value is IArguments;
71export function isArrayBuffer(value: unknown): value is ArrayBuffer;
72/* eslint-disable-next-line @typescript-eslint/no-unsafe-function-type */
73export function isAsyncFunction(value: unknown): value is Function;
74export function isBigInt64Array(value: unknown): value is BigInt64Array;
75export function isBigIntObject(value: unknown): value is bigint;
76export function isBigUint64Array(value: unknown): value is BigUint64Array;
77export function isBooleanObject(value: unknown): value is boolean;
78export function isDataView(value: unknown): value is DataView;
79export function isDate(value: unknown): value is Date;
80export function isExternal(value: unknown): boolean;
81export function isFloat16Array(value: unknown): value is Float16Array;
82export function isFloat32Array(value: unknown): value is Float32Array;
83export function isFloat64Array(value: unknown): value is Float64Array;
84export function isGeneratorFunction(value: unknown): value is GeneratorFunction;
85export function isGeneratorObject(value: unknown): value is Generator;
86export function isInt8Array(value: unknown): value is Int8Array;
87export function isInt16Array(value: unknown): value is Int16Array;
88export function isInt32Array(value: unknown): value is Int32Array;
89export function isMap(value: unknown): value is Map<unknown, unknown>;
90export function isMapIterator(
91 value: unknown
92): value is IterableIterator<unknown>;
93export function isModuleNamespaceObject(value: unknown): boolean;
94export function isNativeError(value: unknown): value is Error;
95export function isNumberObject(value: unknown): value is number;
96export function isPromise(value: unknown): value is Promise<unknown>;
97export function isProxy(value: unknown): boolean;
98export function isRegExp(value: unknown): value is RegExp;
99export function isSet(value: unknown): value is Set<unknown>;
100export function isSetIterator(
101 value: unknown
102): value is IterableIterator<unknown>;
103export function isSharedArrayBuffer(value: unknown): value is SharedArrayBuffer;
104export function isStringObject(value: unknown): value is string;
105export function isSymbolObject(value: unknown): value is symbol;
106export function isTypedArray(value: unknown): value is NodeJS.TypedArray;
107export function isUint8Array(value: unknown): value is Uint8Array;
108export function isUint8ClampedArray(value: unknown): value is Uint8ClampedArray;
109export function isUint16Array(value: unknown): value is Uint16Array;
110export function isUint32Array(value: unknown): value is Uint32Array;
111export function isWeakMap(value: unknown): value is WeakMap<unknown, unknown>;
112export function isWeakSet(value: unknown): value is WeakSet<unknown>;
113export function isAnyArrayBuffer(
114 value: unknown
115): value is ArrayBuffer | SharedArrayBuffer;
116export function isBoxedPrimitive(
117 value: unknown
118): value is number | string | boolean | bigint | symbol;
119export function getCallSites(frames?: number): Record<string, string>[];