File
Blob: src/node/internal/util.d.ts
| 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 | |
| 5 | import perfHooks from 'node:perf_hooks'; |
| 6 | |
| 7 | export const Performance = perfHooks.Performance; |
| 8 | export const PerformanceEntry = perfHooks.PerformanceEntry; |
| 9 | export const PerformanceMeasure = perfHooks.PerformanceMeasure; |
| 10 | export const PerformanceMark = perfHooks.PerformanceMark; |
| 11 | export const PerformanceObserver = perfHooks.PerformanceObserver; |
| 12 | export const PerformanceObserverEntryList = |
| 13 | perfHooks.PerformanceObserverEntryList; |
| 14 | export const PerformanceResourceTiming = perfHooks.PerformanceResourceTiming; |
| 15 | |
| 16 | export 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 | |
| 26 | export 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 | |
| 37 | export const kResourceTypeInspect: unique symbol; |
| 38 | |
| 39 | export const ALL_PROPERTIES: 0; |
| 40 | export const ONLY_ENUMERABLE: 1; |
| 41 | export function getOwnNonIndexProperties( |
| 42 | value: unknown, |
| 43 | filter: typeof ALL_PROPERTIES | typeof ONLY_ENUMERABLE |
| 44 | ): PropertyKey[]; |
| 45 | |
| 46 | export const kPending: 0; |
| 47 | export const kFulfilled: 1; |
| 48 | export const kRejected: 2; |
| 49 | export interface PromiseDetails { |
| 50 | state: typeof kPending | typeof kFulfilled | typeof kRejected; |
| 51 | result: unknown; |
| 52 | } |
| 53 | export function getPromiseDetails(value: unknown): PromiseDetails | undefined; |
| 54 | |
| 55 | export interface ProxyDetails { |
| 56 | target: unknown; |
| 57 | handler: unknown; |
| 58 | } |
| 59 | export function getProxyDetails(value: unknown): ProxyDetails | undefined; |
| 60 | |
| 61 | export interface PreviewedEntries { |
| 62 | entries: unknown[]; |
| 63 | isKeyValue: boolean; |
| 64 | } |
| 65 | export function previewEntries(value: unknown): PreviewedEntries | undefined; |
| 66 | |
| 67 | export function getConstructorName(value: unknown): string; |
| 68 | |
| 69 | export function isArrayBufferView(value: unknown): value is ArrayBufferView; |
| 70 | export function isArgumentsObject(value: unknown): value is IArguments; |
| 71 | export function isArrayBuffer(value: unknown): value is ArrayBuffer; |
| 72 | /* eslint-disable-next-line @typescript-eslint/no-unsafe-function-type */ |
| 73 | export function isAsyncFunction(value: unknown): value is Function; |
| 74 | export function isBigInt64Array(value: unknown): value is BigInt64Array; |
| 75 | export function isBigIntObject(value: unknown): value is bigint; |
| 76 | export function isBigUint64Array(value: unknown): value is BigUint64Array; |
| 77 | export function isBooleanObject(value: unknown): value is boolean; |
| 78 | export function isDataView(value: unknown): value is DataView; |
| 79 | export function isDate(value: unknown): value is Date; |
| 80 | export function isExternal(value: unknown): boolean; |
| 81 | export function isFloat16Array(value: unknown): value is Float16Array; |
| 82 | export function isFloat32Array(value: unknown): value is Float32Array; |
| 83 | export function isFloat64Array(value: unknown): value is Float64Array; |
| 84 | export function isGeneratorFunction(value: unknown): value is GeneratorFunction; |
| 85 | export function isGeneratorObject(value: unknown): value is Generator; |
| 86 | export function isInt8Array(value: unknown): value is Int8Array; |
| 87 | export function isInt16Array(value: unknown): value is Int16Array; |
| 88 | export function isInt32Array(value: unknown): value is Int32Array; |
| 89 | export function isMap(value: unknown): value is Map<unknown, unknown>; |
| 90 | export function isMapIterator( |
| 91 | value: unknown |
| 92 | ): value is IterableIterator<unknown>; |
| 93 | export function isModuleNamespaceObject(value: unknown): boolean; |
| 94 | export function isNativeError(value: unknown): value is Error; |
| 95 | export function isNumberObject(value: unknown): value is number; |
| 96 | export function isPromise(value: unknown): value is Promise<unknown>; |
| 97 | export function isProxy(value: unknown): boolean; |
| 98 | export function isRegExp(value: unknown): value is RegExp; |
| 99 | export function isSet(value: unknown): value is Set<unknown>; |
| 100 | export function isSetIterator( |
| 101 | value: unknown |
| 102 | ): value is IterableIterator<unknown>; |
| 103 | export function isSharedArrayBuffer(value: unknown): value is SharedArrayBuffer; |
| 104 | export function isStringObject(value: unknown): value is string; |
| 105 | export function isSymbolObject(value: unknown): value is symbol; |
| 106 | export function isTypedArray(value: unknown): value is NodeJS.TypedArray; |
| 107 | export function isUint8Array(value: unknown): value is Uint8Array; |
| 108 | export function isUint8ClampedArray(value: unknown): value is Uint8ClampedArray; |
| 109 | export function isUint16Array(value: unknown): value is Uint16Array; |
| 110 | export function isUint32Array(value: unknown): value is Uint32Array; |
| 111 | export function isWeakMap(value: unknown): value is WeakMap<unknown, unknown>; |
| 112 | export function isWeakSet(value: unknown): value is WeakSet<unknown>; |
| 113 | export function isAnyArrayBuffer( |
| 114 | value: unknown |
| 115 | ): value is ArrayBuffer | SharedArrayBuffer; |
| 116 | export function isBoxedPrimitive( |
| 117 | value: unknown |
| 118 | ): value is number | string | boolean | bigint | symbol; |
| 119 | export function getCallSites(frames?: number): Record<string, string>[]; |