@idlebox/stripe-node-types 24.0.14 → 24.0.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. package/README.md +1 -1
  2. package/assert/strict.d.ts +98 -1
  3. package/assert.d.ts +147 -248
  4. package/async_hooks.d.ts +5 -5
  5. package/buffer.buffer.d.ts +9 -6
  6. package/buffer.d.ts +49 -169
  7. package/child_process.d.ts +102 -223
  8. package/cluster.d.ts +236 -329
  9. package/console.d.ts +45 -346
  10. package/constants.d.ts +0 -1
  11. package/crypto.d.ts +698 -1149
  12. package/dgram.d.ts +15 -50
  13. package/diagnostics_channel.d.ts +1 -3
  14. package/dns.d.ts +135 -131
  15. package/domain.d.ts +10 -14
  16. package/events.d.ts +846 -722
  17. package/fs/promises.d.ts +102 -53
  18. package/fs.d.ts +714 -484
  19. package/globals.d.ts +130 -347
  20. package/globals.typedarray.d.ts +79 -0
  21. package/http.d.ts +343 -246
  22. package/http2.d.ts +563 -711
  23. package/https.d.ts +70 -216
  24. package/index.d.ts +24 -3
  25. package/inspector/promises.d.ts +54 -0
  26. package/inspector.d.ts +167 -3938
  27. package/inspector.generated.d.ts +4242 -0
  28. package/module.d.ts +45 -95
  29. package/net.d.ts +87 -186
  30. package/os.d.ts +17 -6
  31. package/package.json +3 -8
  32. package/path/posix.d.ts +20 -0
  33. package/path/win32.d.ts +20 -0
  34. package/path.d.ts +117 -122
  35. package/perf_hooks.d.ts +295 -644
  36. package/process.d.ts +177 -138
  37. package/punycode.d.ts +2 -2
  38. package/querystring.d.ts +1 -1
  39. package/quic.d.ts +926 -0
  40. package/readline/promises.d.ts +1 -1
  41. package/readline.d.ts +65 -118
  42. package/repl.d.ts +83 -96
  43. package/sea.d.ts +10 -1
  44. package/sqlite.d.ts +262 -13
  45. package/stream/consumers.d.ts +7 -7
  46. package/stream/promises.d.ts +133 -12
  47. package/stream/web.d.ts +173 -495
  48. package/stream.d.ts +593 -490
  49. package/string_decoder.d.ts +3 -3
  50. package/test/reporters.d.ts +112 -0
  51. package/test.d.ts +223 -199
  52. package/timers/promises.d.ts +1 -1
  53. package/timers.d.ts +1 -129
  54. package/tls.d.ts +148 -163
  55. package/trace_events.d.ts +6 -6
  56. package/ts5.6/buffer.buffer.d.ts +10 -8
  57. package/ts5.6/globals.typedarray.d.ts +16 -0
  58. package/ts5.6/index.d.ts +24 -3
  59. package/ts5.7/index.d.ts +24 -3
  60. package/tty.d.ts +55 -13
  61. package/url.d.ts +92 -587
  62. package/util/types.d.ts +571 -0
  63. package/util.d.ts +143 -792
  64. package/v8.d.ts +67 -7
  65. package/vm.d.ts +252 -108
  66. package/wasi.d.ts +23 -2
  67. package/web-globals/abortcontroller.d.ts +75 -0
  68. package/web-globals/blob.d.ts +39 -0
  69. package/{ts5.1/compatibility/disposable.d.ts → web-globals/console.d.ts} +6 -9
  70. package/web-globals/crypto.d.ts +55 -0
  71. package/web-globals/domexception.d.ts +84 -0
  72. package/web-globals/encoding.d.ts +27 -0
  73. package/{dom-events.d.ts → web-globals/events.d.ts} +57 -50
  74. package/web-globals/fetch.d.ts +70 -0
  75. package/web-globals/importmeta.d.ts +29 -0
  76. package/web-globals/messaging.d.ts +39 -0
  77. package/web-globals/navigator.d.ts +41 -0
  78. package/web-globals/performance.d.ts +61 -0
  79. package/web-globals/storage.d.ts +40 -0
  80. package/web-globals/streams.d.ts +131 -0
  81. package/web-globals/timers.d.ts +60 -0
  82. package/web-globals/url.d.ts +40 -0
  83. package/worker_threads.d.ts +291 -349
  84. package/zlib.d.ts +44 -94
  85. package/ts5.1/index.d.ts +0 -115
@@ -0,0 +1,571 @@
1
+ // biome-ignore-all lint: generated file
2
+ // biome-ignore-all assist: generated file
3
+ /* eslint-disable */
4
+ // @ts-ignore
5
+
6
+ /******************************************************************************
7
+ * GENERATED FILE, DO NOT MODIFY
8
+ * 这是生成的文件,千万不要修改
9
+ *
10
+ * @build-script/codegen - The Simple Code Generater
11
+ * https://github.com/GongT/baobao
12
+ *
13
+ ******************************************************************************/
14
+
15
+
16
+
17
+ declare module "node:util/types" {
18
+ import { KeyObject, webcrypto } from 'node:crypto';
19
+ /**
20
+ * Returns `true` if the value is a built-in [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) or
21
+ * [`SharedArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) instance.
22
+ *
23
+ * See also `util.types.isArrayBuffer()` and `util.types.isSharedArrayBuffer()`.
24
+ *
25
+ * ```js
26
+ * util.types.isAnyArrayBuffer(new ArrayBuffer()); // Returns true
27
+ * util.types.isAnyArrayBuffer(new SharedArrayBuffer()); // Returns true
28
+ * ```
29
+ * @since v10.0.0
30
+ */
31
+ function isAnyArrayBuffer(object: unknown): object is ArrayBufferLike;
32
+ /**
33
+ * Returns `true` if the value is an `arguments` object.
34
+ *
35
+ * ```js
36
+ * function foo() {
37
+ * util.types.isArgumentsObject(arguments); // Returns true
38
+ * }
39
+ * ```
40
+ * @since v10.0.0
41
+ */
42
+ function isArgumentsObject(object: unknown): object is IArguments;
43
+ /**
44
+ * Returns `true` if the value is a built-in [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) instance.
45
+ * This does _not_ include [`SharedArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) instances. Usually, it is
46
+ * desirable to test for both; See `util.types.isAnyArrayBuffer()` for that.
47
+ *
48
+ * ```js
49
+ * util.types.isArrayBuffer(new ArrayBuffer()); // Returns true
50
+ * util.types.isArrayBuffer(new SharedArrayBuffer()); // Returns false
51
+ * ```
52
+ * @since v10.0.0
53
+ */
54
+ function isArrayBuffer(object: unknown): object is ArrayBuffer;
55
+ /**
56
+ * Returns `true` if the value is an instance of one of the [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) views, such as typed
57
+ * array objects or [`DataView`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView). Equivalent to
58
+ * [`ArrayBuffer.isView()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/isView).
59
+ *
60
+ * ```js
61
+ * util.types.isArrayBufferView(new Int8Array()); // true
62
+ * util.types.isArrayBufferView(Buffer.from('hello world')); // true
63
+ * util.types.isArrayBufferView(new DataView(new ArrayBuffer(16))); // true
64
+ * util.types.isArrayBufferView(new ArrayBuffer()); // false
65
+ * ```
66
+ * @since v10.0.0
67
+ */
68
+ function isArrayBufferView(object: unknown): object is NodeJS.ArrayBufferView;
69
+ /**
70
+ * Returns `true` if the value is an [async function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function).
71
+ * This only reports back what the JavaScript engine is seeing;
72
+ * in particular, the return value may not match the original source code if
73
+ * a transpilation tool was used.
74
+ *
75
+ * ```js
76
+ * util.types.isAsyncFunction(function foo() {}); // Returns false
77
+ * util.types.isAsyncFunction(async function foo() {}); // Returns true
78
+ * ```
79
+ * @since v10.0.0
80
+ */
81
+ function isAsyncFunction(object: unknown): boolean;
82
+ /**
83
+ * Returns `true` if the value is a `BigInt64Array` instance.
84
+ *
85
+ * ```js
86
+ * util.types.isBigInt64Array(new BigInt64Array()); // Returns true
87
+ * util.types.isBigInt64Array(new BigUint64Array()); // Returns false
88
+ * ```
89
+ * @since v10.0.0
90
+ */
91
+ function isBigInt64Array(value: unknown): value is BigInt64Array;
92
+ /**
93
+ * Returns `true` if the value is a BigInt object, e.g. created
94
+ * by `Object(BigInt(123))`.
95
+ *
96
+ * ```js
97
+ * util.types.isBigIntObject(Object(BigInt(123))); // Returns true
98
+ * util.types.isBigIntObject(BigInt(123)); // Returns false
99
+ * util.types.isBigIntObject(123); // Returns false
100
+ * ```
101
+ * @since v10.4.0
102
+ */
103
+ function isBigIntObject(object: unknown): object is BigInt;
104
+ /**
105
+ * Returns `true` if the value is a `BigUint64Array` instance.
106
+ *
107
+ * ```js
108
+ * util.types.isBigUint64Array(new BigInt64Array()); // Returns false
109
+ * util.types.isBigUint64Array(new BigUint64Array()); // Returns true
110
+ * ```
111
+ * @since v10.0.0
112
+ */
113
+ function isBigUint64Array(value: unknown): value is BigUint64Array;
114
+ /**
115
+ * Returns `true` if the value is a boolean object, e.g. created
116
+ * by `new Boolean()`.
117
+ *
118
+ * ```js
119
+ * util.types.isBooleanObject(false); // Returns false
120
+ * util.types.isBooleanObject(true); // Returns false
121
+ * util.types.isBooleanObject(new Boolean(false)); // Returns true
122
+ * util.types.isBooleanObject(new Boolean(true)); // Returns true
123
+ * util.types.isBooleanObject(Boolean(false)); // Returns false
124
+ * util.types.isBooleanObject(Boolean(true)); // Returns false
125
+ * ```
126
+ * @since v10.0.0
127
+ */
128
+ function isBooleanObject(object: unknown): object is Boolean;
129
+ /**
130
+ * Returns `true` if the value is any boxed primitive object, e.g. created
131
+ * by `new Boolean()`, `new String()` or `Object(Symbol())`.
132
+ *
133
+ * For example:
134
+ *
135
+ * ```js
136
+ * util.types.isBoxedPrimitive(false); // Returns false
137
+ * util.types.isBoxedPrimitive(new Boolean(false)); // Returns true
138
+ * util.types.isBoxedPrimitive(Symbol('foo')); // Returns false
139
+ * util.types.isBoxedPrimitive(Object(Symbol('foo'))); // Returns true
140
+ * util.types.isBoxedPrimitive(Object(BigInt(5))); // Returns true
141
+ * ```
142
+ * @since v10.11.0
143
+ */
144
+ function isBoxedPrimitive(object: unknown): object is String | Number | BigInt | Boolean | Symbol;
145
+ /**
146
+ * Returns `true` if the value is a built-in [`DataView`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView) instance.
147
+ *
148
+ * ```js
149
+ * const ab = new ArrayBuffer(20);
150
+ * util.types.isDataView(new DataView(ab)); // Returns true
151
+ * util.types.isDataView(new Float64Array()); // Returns false
152
+ * ```
153
+ *
154
+ * See also [`ArrayBuffer.isView()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/isView).
155
+ * @since v10.0.0
156
+ */
157
+ function isDataView(object: unknown): object is DataView;
158
+ /**
159
+ * Returns `true` if the value is a built-in [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) instance.
160
+ *
161
+ * ```js
162
+ * util.types.isDate(new Date()); // Returns true
163
+ * ```
164
+ * @since v10.0.0
165
+ */
166
+ function isDate(object: unknown): object is Date;
167
+ /**
168
+ * Returns `true` if the value is a native `External` value.
169
+ *
170
+ * A native `External` value is a special type of object that contains a
171
+ * raw C++ pointer (`void*`) for access from native code, and has no other
172
+ * properties. Such objects are created either by Node.js internals or native
173
+ * addons. In JavaScript, they are
174
+ * [frozen](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze) objects with a
175
+ * `null` prototype.
176
+ *
177
+ * ```c
178
+ * #include <js_native_api.h>
179
+ * #include <stdlib.h>
180
+ * napi_value result;
181
+ * static napi_value MyNapi(napi_env env, napi_callback_info info) {
182
+ * int* raw = (int*) malloc(1024);
183
+ * napi_status status = napi_create_external(env, (void*) raw, NULL, NULL, &result);
184
+ * if (status != napi_ok) {
185
+ * napi_throw_error(env, NULL, "napi_create_external failed");
186
+ * return NULL;
187
+ * }
188
+ * return result;
189
+ * }
190
+ * ...
191
+ * DECLARE_NAPI_PROPERTY("myNapi", MyNapi)
192
+ * ...
193
+ * ```
194
+ *
195
+ * ```js
196
+ * import native from 'napi_addon.node';
197
+ * import { types } from 'node:util';
198
+ *
199
+ * const data = native.myNapi();
200
+ * types.isExternal(data); // returns true
201
+ * types.isExternal(0); // returns false
202
+ * types.isExternal(new String('foo')); // returns false
203
+ * ```
204
+ *
205
+ * For further information on `napi_create_external`, refer to
206
+ * [`napi_create_external()`](https://nodejs.org/docs/latest-v25.x/api/n-api.html#napi_create_external).
207
+ * @since v10.0.0
208
+ */
209
+ function isExternal(object: unknown): boolean;
210
+ /**
211
+ * Returns `true` if the value is a built-in [`Float16Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float16Array) instance.
212
+ *
213
+ * ```js
214
+ * util.types.isFloat16Array(new ArrayBuffer()); // Returns false
215
+ * util.types.isFloat16Array(new Float16Array()); // Returns true
216
+ * util.types.isFloat16Array(new Float32Array()); // Returns false
217
+ * ```
218
+ * @since v24.0.0
219
+ */
220
+ function isFloat16Array(object: unknown): object is Float16Array;
221
+ /**
222
+ * Returns `true` if the value is a built-in [`Float32Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array) instance.
223
+ *
224
+ * ```js
225
+ * util.types.isFloat32Array(new ArrayBuffer()); // Returns false
226
+ * util.types.isFloat32Array(new Float32Array()); // Returns true
227
+ * util.types.isFloat32Array(new Float64Array()); // Returns false
228
+ * ```
229
+ * @since v10.0.0
230
+ */
231
+ function isFloat32Array(object: unknown): object is Float32Array;
232
+ /**
233
+ * Returns `true` if the value is a built-in [`Float64Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array) instance.
234
+ *
235
+ * ```js
236
+ * util.types.isFloat64Array(new ArrayBuffer()); // Returns false
237
+ * util.types.isFloat64Array(new Uint8Array()); // Returns false
238
+ * util.types.isFloat64Array(new Float64Array()); // Returns true
239
+ * ```
240
+ * @since v10.0.0
241
+ */
242
+ function isFloat64Array(object: unknown): object is Float64Array;
243
+ /**
244
+ * Returns `true` if the value is a generator function.
245
+ * This only reports back what the JavaScript engine is seeing;
246
+ * in particular, the return value may not match the original source code if
247
+ * a transpilation tool was used.
248
+ *
249
+ * ```js
250
+ * util.types.isGeneratorFunction(function foo() {}); // Returns false
251
+ * util.types.isGeneratorFunction(function* foo() {}); // Returns true
252
+ * ```
253
+ * @since v10.0.0
254
+ */
255
+ function isGeneratorFunction(object: unknown): object is GeneratorFunction;
256
+ /**
257
+ * Returns `true` if the value is a generator object as returned from a
258
+ * built-in generator function.
259
+ * This only reports back what the JavaScript engine is seeing;
260
+ * in particular, the return value may not match the original source code if
261
+ * a transpilation tool was used.
262
+ *
263
+ * ```js
264
+ * function* foo() {}
265
+ * const generator = foo();
266
+ * util.types.isGeneratorObject(generator); // Returns true
267
+ * ```
268
+ * @since v10.0.0
269
+ */
270
+ function isGeneratorObject(object: unknown): object is Generator;
271
+ /**
272
+ * Returns `true` if the value is a built-in [`Int8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int8Array) instance.
273
+ *
274
+ * ```js
275
+ * util.types.isInt8Array(new ArrayBuffer()); // Returns false
276
+ * util.types.isInt8Array(new Int8Array()); // Returns true
277
+ * util.types.isInt8Array(new Float64Array()); // Returns false
278
+ * ```
279
+ * @since v10.0.0
280
+ */
281
+ function isInt8Array(object: unknown): object is Int8Array;
282
+ /**
283
+ * Returns `true` if the value is a built-in [`Int16Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int16Array) instance.
284
+ *
285
+ * ```js
286
+ * util.types.isInt16Array(new ArrayBuffer()); // Returns false
287
+ * util.types.isInt16Array(new Int16Array()); // Returns true
288
+ * util.types.isInt16Array(new Float64Array()); // Returns false
289
+ * ```
290
+ * @since v10.0.0
291
+ */
292
+ function isInt16Array(object: unknown): object is Int16Array;
293
+ /**
294
+ * Returns `true` if the value is a built-in [`Int32Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array) instance.
295
+ *
296
+ * ```js
297
+ * util.types.isInt32Array(new ArrayBuffer()); // Returns false
298
+ * util.types.isInt32Array(new Int32Array()); // Returns true
299
+ * util.types.isInt32Array(new Float64Array()); // Returns false
300
+ * ```
301
+ * @since v10.0.0
302
+ */
303
+ function isInt32Array(object: unknown): object is Int32Array;
304
+ /**
305
+ * Returns `true` if the value is a built-in [`Map`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) instance.
306
+ *
307
+ * ```js
308
+ * util.types.isMap(new Map()); // Returns true
309
+ * ```
310
+ * @since v10.0.0
311
+ */
312
+ function isMap<T>(
313
+ object: T | {},
314
+ ): object is T extends ReadonlyMap<any, any> ? (unknown extends T ? never : ReadonlyMap<any, any>)
315
+ : Map<unknown, unknown>;
316
+ /**
317
+ * Returns `true` if the value is an iterator returned for a built-in [`Map`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) instance.
318
+ *
319
+ * ```js
320
+ * const map = new Map();
321
+ * util.types.isMapIterator(map.keys()); // Returns true
322
+ * util.types.isMapIterator(map.values()); // Returns true
323
+ * util.types.isMapIterator(map.entries()); // Returns true
324
+ * util.types.isMapIterator(map[Symbol.iterator]()); // Returns true
325
+ * ```
326
+ * @since v10.0.0
327
+ */
328
+ function isMapIterator(object: unknown): boolean;
329
+ /**
330
+ * Returns `true` if the value is an instance of a [Module Namespace Object](https://tc39.github.io/ecma262/#sec-module-namespace-exotic-objects).
331
+ *
332
+ * ```js
333
+ * import * as ns from './a.js';
334
+ *
335
+ * util.types.isModuleNamespaceObject(ns); // Returns true
336
+ * ```
337
+ * @since v10.0.0
338
+ */
339
+ function isModuleNamespaceObject(value: unknown): boolean;
340
+ /**
341
+ * Returns `true` if the value was returned by the constructor of a
342
+ * [built-in `Error` type](https://tc39.es/ecma262/#sec-error-objects).
343
+ *
344
+ * ```js
345
+ * console.log(util.types.isNativeError(new Error())); // true
346
+ * console.log(util.types.isNativeError(new TypeError())); // true
347
+ * console.log(util.types.isNativeError(new RangeError())); // true
348
+ * ```
349
+ *
350
+ * Subclasses of the native error types are also native errors:
351
+ *
352
+ * ```js
353
+ * class MyError extends Error {}
354
+ * console.log(util.types.isNativeError(new MyError())); // true
355
+ * ```
356
+ *
357
+ * A value being `instanceof` a native error class is not equivalent to `isNativeError()`
358
+ * returning `true` for that value. `isNativeError()` returns `true` for errors
359
+ * which come from a different [realm](https://tc39.es/ecma262/#realm) while `instanceof Error` returns `false`
360
+ * for these errors:
361
+ *
362
+ * ```js
363
+ * import { createContext, runInContext } from 'node:vm';
364
+ * import { types } from 'node:util';
365
+ *
366
+ * const context = createContext({});
367
+ * const myError = runInContext('new Error()', context);
368
+ * console.log(types.isNativeError(myError)); // true
369
+ * console.log(myError instanceof Error); // false
370
+ * ```
371
+ *
372
+ * Conversely, `isNativeError()` returns `false` for all objects which were not
373
+ * returned by the constructor of a native error. That includes values
374
+ * which are `instanceof` native errors:
375
+ *
376
+ * ```js
377
+ * const myError = { __proto__: Error.prototype };
378
+ * console.log(util.types.isNativeError(myError)); // false
379
+ * console.log(myError instanceof Error); // true
380
+ * ```
381
+ * @since v10.0.0
382
+ * @deprecated The `util.types.isNativeError` API is deprecated. Please use `Error.isError` instead.
383
+ */
384
+ function isNativeError(object: unknown): object is Error;
385
+ /**
386
+ * Returns `true` if the value is a number object, e.g. created
387
+ * by `new Number()`.
388
+ *
389
+ * ```js
390
+ * util.types.isNumberObject(0); // Returns false
391
+ * util.types.isNumberObject(new Number(0)); // Returns true
392
+ * ```
393
+ * @since v10.0.0
394
+ */
395
+ function isNumberObject(object: unknown): object is Number;
396
+ /**
397
+ * Returns `true` if the value is a built-in [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise).
398
+ *
399
+ * ```js
400
+ * util.types.isPromise(Promise.resolve(42)); // Returns true
401
+ * ```
402
+ * @since v10.0.0
403
+ */
404
+ function isPromise(object: unknown): object is Promise<unknown>;
405
+ /**
406
+ * Returns `true` if the value is a [`Proxy`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy) instance.
407
+ *
408
+ * ```js
409
+ * const target = {};
410
+ * const proxy = new Proxy(target, {});
411
+ * util.types.isProxy(target); // Returns false
412
+ * util.types.isProxy(proxy); // Returns true
413
+ * ```
414
+ * @since v10.0.0
415
+ */
416
+ function isProxy(object: unknown): boolean;
417
+ /**
418
+ * Returns `true` if the value is a regular expression object.
419
+ *
420
+ * ```js
421
+ * util.types.isRegExp(/abc/); // Returns true
422
+ * util.types.isRegExp(new RegExp('abc')); // Returns true
423
+ * ```
424
+ * @since v10.0.0
425
+ */
426
+ function isRegExp(object: unknown): object is RegExp;
427
+ /**
428
+ * Returns `true` if the value is a built-in [`Set`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set) instance.
429
+ *
430
+ * ```js
431
+ * util.types.isSet(new Set()); // Returns true
432
+ * ```
433
+ * @since v10.0.0
434
+ */
435
+ function isSet<T>(
436
+ object: T | {},
437
+ ): object is T extends ReadonlySet<any> ? (unknown extends T ? never : ReadonlySet<any>) : Set<unknown>;
438
+ /**
439
+ * Returns `true` if the value is an iterator returned for a built-in [`Set`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set) instance.
440
+ *
441
+ * ```js
442
+ * const set = new Set();
443
+ * util.types.isSetIterator(set.keys()); // Returns true
444
+ * util.types.isSetIterator(set.values()); // Returns true
445
+ * util.types.isSetIterator(set.entries()); // Returns true
446
+ * util.types.isSetIterator(set[Symbol.iterator]()); // Returns true
447
+ * ```
448
+ * @since v10.0.0
449
+ */
450
+ function isSetIterator(object: unknown): boolean;
451
+ /**
452
+ * Returns `true` if the value is a built-in [`SharedArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) instance.
453
+ * This does _not_ include [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) instances. Usually, it is
454
+ * desirable to test for both; See `util.types.isAnyArrayBuffer()` for that.
455
+ *
456
+ * ```js
457
+ * util.types.isSharedArrayBuffer(new ArrayBuffer()); // Returns false
458
+ * util.types.isSharedArrayBuffer(new SharedArrayBuffer()); // Returns true
459
+ * ```
460
+ * @since v10.0.0
461
+ */
462
+ function isSharedArrayBuffer(object: unknown): object is SharedArrayBuffer;
463
+ /**
464
+ * Returns `true` if the value is a string object, e.g. created
465
+ * by `new String()`.
466
+ *
467
+ * ```js
468
+ * util.types.isStringObject('foo'); // Returns false
469
+ * util.types.isStringObject(new String('foo')); // Returns true
470
+ * ```
471
+ * @since v10.0.0
472
+ */
473
+ function isStringObject(object: unknown): object is String;
474
+ /**
475
+ * Returns `true` if the value is a symbol object, created
476
+ * by calling `Object()` on a `Symbol` primitive.
477
+ *
478
+ * ```js
479
+ * const symbol = Symbol('foo');
480
+ * util.types.isSymbolObject(symbol); // Returns false
481
+ * util.types.isSymbolObject(Object(symbol)); // Returns true
482
+ * ```
483
+ * @since v10.0.0
484
+ */
485
+ function isSymbolObject(object: unknown): object is Symbol;
486
+ /**
487
+ * Returns `true` if the value is a built-in [`TypedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) instance.
488
+ *
489
+ * ```js
490
+ * util.types.isTypedArray(new ArrayBuffer()); // Returns false
491
+ * util.types.isTypedArray(new Uint8Array()); // Returns true
492
+ * util.types.isTypedArray(new Float64Array()); // Returns true
493
+ * ```
494
+ *
495
+ * See also [`ArrayBuffer.isView()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/isView).
496
+ * @since v10.0.0
497
+ */
498
+ function isTypedArray(object: unknown): object is NodeJS.TypedArray;
499
+ /**
500
+ * Returns `true` if the value is a built-in [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) instance.
501
+ *
502
+ * ```js
503
+ * util.types.isUint8Array(new ArrayBuffer()); // Returns false
504
+ * util.types.isUint8Array(new Uint8Array()); // Returns true
505
+ * util.types.isUint8Array(new Float64Array()); // Returns false
506
+ * ```
507
+ * @since v10.0.0
508
+ */
509
+ function isUint8Array(object: unknown): object is Uint8Array;
510
+ /**
511
+ * Returns `true` if the value is a built-in [`Uint8ClampedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray) instance.
512
+ *
513
+ * ```js
514
+ * util.types.isUint8ClampedArray(new ArrayBuffer()); // Returns false
515
+ * util.types.isUint8ClampedArray(new Uint8ClampedArray()); // Returns true
516
+ * util.types.isUint8ClampedArray(new Float64Array()); // Returns false
517
+ * ```
518
+ * @since v10.0.0
519
+ */
520
+ function isUint8ClampedArray(object: unknown): object is Uint8ClampedArray;
521
+ /**
522
+ * Returns `true` if the value is a built-in [`Uint16Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array) instance.
523
+ *
524
+ * ```js
525
+ * util.types.isUint16Array(new ArrayBuffer()); // Returns false
526
+ * util.types.isUint16Array(new Uint16Array()); // Returns true
527
+ * util.types.isUint16Array(new Float64Array()); // Returns false
528
+ * ```
529
+ * @since v10.0.0
530
+ */
531
+ function isUint16Array(object: unknown): object is Uint16Array;
532
+ /**
533
+ * Returns `true` if the value is a built-in [`Uint32Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array) instance.
534
+ *
535
+ * ```js
536
+ * util.types.isUint32Array(new ArrayBuffer()); // Returns false
537
+ * util.types.isUint32Array(new Uint32Array()); // Returns true
538
+ * util.types.isUint32Array(new Float64Array()); // Returns false
539
+ * ```
540
+ * @since v10.0.0
541
+ */
542
+ function isUint32Array(object: unknown): object is Uint32Array;
543
+ /**
544
+ * Returns `true` if the value is a built-in [`WeakMap`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap) instance.
545
+ *
546
+ * ```js
547
+ * util.types.isWeakMap(new WeakMap()); // Returns true
548
+ * ```
549
+ * @since v10.0.0
550
+ */
551
+ function isWeakMap(object: unknown): object is WeakMap<object, unknown>;
552
+ /**
553
+ * Returns `true` if the value is a built-in [`WeakSet`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet) instance.
554
+ *
555
+ * ```js
556
+ * util.types.isWeakSet(new WeakSet()); // Returns true
557
+ * ```
558
+ * @since v10.0.0
559
+ */
560
+ function isWeakSet(object: unknown): object is WeakSet<object>;
561
+ /**
562
+ * Returns `true` if `value` is a `KeyObject`, `false` otherwise.
563
+ * @since v16.2.0
564
+ */
565
+ function isKeyObject(object: unknown): object is KeyObject;
566
+ /**
567
+ * Returns `true` if `value` is a `CryptoKey`, `false` otherwise.
568
+ * @since v16.2.0
569
+ */
570
+ function isCryptoKey(object: unknown): object is webcrypto.CryptoKey;
571
+ }