@types/node 18.19.41 → 18.19.43

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.
node v18.19/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for node (https://nodejs.org/).
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node/v18.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Thu, 18 Jul 2024 18:38:10 GMT
11
+ * Last updated: Fri, 02 Aug 2024 08:37:31 GMT
12
12
  * Dependencies: [undici-types](https://npmjs.com/package/undici-types)
13
13
 
14
14
  # Credits
node v18.19/buffer.d.ts CHANGED
@@ -2190,31 +2190,6 @@ declare module "buffer" {
2190
2190
  * @return The index of the last occurrence of `value` in `buf`, or `-1` if `buf` does not contain `value`.
2191
2191
  */
2192
2192
  lastIndexOf(value: string | number | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number;
2193
- /**
2194
- * Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) of `[index, byte]` pairs from the contents
2195
- * of `buf`.
2196
- *
2197
- * ```js
2198
- * import { Buffer } from 'node:buffer';
2199
- *
2200
- * // Log the entire contents of a `Buffer`.
2201
- *
2202
- * const buf = Buffer.from('buffer');
2203
- *
2204
- * for (const pair of buf.entries()) {
2205
- * console.log(pair);
2206
- * }
2207
- * // Prints:
2208
- * // [0, 98]
2209
- * // [1, 117]
2210
- * // [2, 102]
2211
- * // [3, 102]
2212
- * // [4, 101]
2213
- * // [5, 114]
2214
- * ```
2215
- * @since v1.1.0
2216
- */
2217
- entries(): IterableIterator<[number, number]>;
2218
2193
  /**
2219
2194
  * Equivalent to `buf.indexOf() !== -1`.
2220
2195
  *
@@ -2245,62 +2220,6 @@ declare module "buffer" {
2245
2220
  * @return `true` if `value` was found in `buf`, `false` otherwise.
2246
2221
  */
2247
2222
  includes(value: string | number | Buffer, byteOffset?: number, encoding?: BufferEncoding): boolean;
2248
- /**
2249
- * Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) of `buf` keys (indices).
2250
- *
2251
- * ```js
2252
- * import { Buffer } from 'node:buffer';
2253
- *
2254
- * const buf = Buffer.from('buffer');
2255
- *
2256
- * for (const key of buf.keys()) {
2257
- * console.log(key);
2258
- * }
2259
- * // Prints:
2260
- * // 0
2261
- * // 1
2262
- * // 2
2263
- * // 3
2264
- * // 4
2265
- * // 5
2266
- * ```
2267
- * @since v1.1.0
2268
- */
2269
- keys(): IterableIterator<number>;
2270
- /**
2271
- * Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) for `buf` values (bytes). This function is
2272
- * called automatically when a `Buffer` is used in a `for..of` statement.
2273
- *
2274
- * ```js
2275
- * import { Buffer } from 'node:buffer';
2276
- *
2277
- * const buf = Buffer.from('buffer');
2278
- *
2279
- * for (const value of buf.values()) {
2280
- * console.log(value);
2281
- * }
2282
- * // Prints:
2283
- * // 98
2284
- * // 117
2285
- * // 102
2286
- * // 102
2287
- * // 101
2288
- * // 114
2289
- *
2290
- * for (const value of buf) {
2291
- * console.log(value);
2292
- * }
2293
- * // Prints:
2294
- * // 98
2295
- * // 117
2296
- * // 102
2297
- * // 102
2298
- * // 101
2299
- * // 114
2300
- * ```
2301
- * @since v1.1.0
2302
- */
2303
- values(): IterableIterator<number>;
2304
2223
  }
2305
2224
  var Buffer: BufferConstructor;
2306
2225
  /**
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/node",
3
- "version": "18.19.41",
3
+ "version": "18.19.43",
4
4
  "description": "TypeScript definitions for node",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
6
6
  "license": "MIT",
@@ -217,6 +217,6 @@
217
217
  "dependencies": {
218
218
  "undici-types": "~5.26.4"
219
219
  },
220
- "typesPublisherContentHash": "1bba4b67e320cd62e059125efa70ea35d3af301b4291c2b3f23df7aa3b42a9a0",
220
+ "typesPublisherContentHash": "7822f2e7f22f7070d22af915d93cb6dc4dcdf3e8a784cab073ce5b99d8a6f6bd",
221
221
  "typeScriptVersion": "4.8"
222
222
  }
node v18.19/test.d.ts CHANGED
@@ -3,7 +3,6 @@
3
3
  * @see [source](https://github.com/nodejs/node/blob/v18.x/lib/test.js)
4
4
  */
5
5
  declare module "node:test" {
6
- import { AsyncResource } from "node:async_hooks";
7
6
  /**
8
7
  * Programmatically start the test runner.
9
8
  * @since v18.9.0
@@ -204,16 +203,16 @@ declare module "node:test" {
204
203
  * Test name patterns are interpreted as JavaScript regular expressions.
205
204
  * For each test that is executed, any corresponding test hooks, such as `beforeEach()`, are also run.
206
205
  */
207
- testNamePatterns?: string | RegExp | string[] | RegExp[];
206
+ testNamePatterns?: string | RegExp | ReadonlyArray<string | RegExp> | undefined;
208
207
  /**
209
208
  * If truthy, the test context will only run tests that have the `only` option set
210
209
  * @since v18.19.0
211
210
  */
212
- only?: boolean;
211
+ only?: boolean | undefined;
213
212
  /**
214
213
  * A function that accepts the TestsStream instance and can be used to setup listeners before any tests are run.
215
214
  */
216
- setup?: (root: Test) => void | Promise<void>;
215
+ setup?: ((reporter: TestsStream) => void | Promise<void>) | undefined;
217
216
  /**
218
217
  * Whether to run in watch mode or not.
219
218
  * @default false
@@ -226,15 +225,6 @@ declare module "node:test" {
226
225
  */
227
226
  shard?: TestShard | undefined;
228
227
  }
229
- class Test extends AsyncResource {
230
- concurrency: number;
231
- nesting: number;
232
- only: boolean;
233
- reporter: TestsStream;
234
- runOnlySubtests: boolean;
235
- testNumber: number;
236
- timeout: number | null;
237
- }
238
228
 
239
229
  /**
240
230
  * A successful call of the `run()` method will return a new `TestsStream` object,
@@ -243,53 +233,77 @@ declare module "node:test" {
243
233
  * @since v18.9.0
244
234
  */
245
235
  interface TestsStream extends NodeJS.ReadableStream {
236
+ addListener(event: "test:coverage", listener: (data: TestCoverage) => void): this;
237
+ addListener(event: "test:dequeue", listener: (data: TestDequeue) => void): this;
246
238
  addListener(event: "test:diagnostic", listener: (data: DiagnosticData) => void): this;
239
+ addListener(event: "test:enqueue", listener: (data: TestEnqueue) => void): this;
247
240
  addListener(event: "test:fail", listener: (data: TestFail) => void): this;
248
241
  addListener(event: "test:pass", listener: (data: TestPass) => void): this;
249
242
  addListener(event: "test:plan", listener: (data: TestPlan) => void): this;
250
243
  addListener(event: "test:start", listener: (data: TestStart) => void): this;
251
244
  addListener(event: "test:stderr", listener: (data: TestStderr) => void): this;
252
245
  addListener(event: "test:stdout", listener: (data: TestStdout) => void): this;
246
+ addListener(event: "test:watch:drained", listener: () => void): this;
253
247
  addListener(event: string, listener: (...args: any[]) => void): this;
248
+ emit(event: "test:coverage", data: TestCoverage): boolean;
249
+ emit(event: "test:dequeue", data: TestDequeue): boolean;
254
250
  emit(event: "test:diagnostic", data: DiagnosticData): boolean;
251
+ emit(event: "test:enqueue", data: TestEnqueue): boolean;
255
252
  emit(event: "test:fail", data: TestFail): boolean;
256
253
  emit(event: "test:pass", data: TestPass): boolean;
257
254
  emit(event: "test:plan", data: TestPlan): boolean;
258
255
  emit(event: "test:start", data: TestStart): boolean;
259
256
  emit(event: "test:stderr", data: TestStderr): boolean;
260
257
  emit(event: "test:stdout", data: TestStdout): boolean;
258
+ emit(event: "test:watch:drained"): boolean;
261
259
  emit(event: string | symbol, ...args: any[]): boolean;
260
+ on(event: "test:coverage", listener: (data: TestCoverage) => void): this;
261
+ on(event: "test:dequeue", listener: (data: TestDequeue) => void): this;
262
262
  on(event: "test:diagnostic", listener: (data: DiagnosticData) => void): this;
263
+ on(event: "test:enqueue", listener: (data: TestEnqueue) => void): this;
263
264
  on(event: "test:fail", listener: (data: TestFail) => void): this;
264
265
  on(event: "test:pass", listener: (data: TestPass) => void): this;
265
266
  on(event: "test:plan", listener: (data: TestPlan) => void): this;
266
267
  on(event: "test:start", listener: (data: TestStart) => void): this;
267
268
  on(event: "test:stderr", listener: (data: TestStderr) => void): this;
268
269
  on(event: "test:stdout", listener: (data: TestStdout) => void): this;
270
+ on(event: "test:watch:drained", listener: () => void): this;
269
271
  on(event: string, listener: (...args: any[]) => void): this;
272
+ once(event: "test:coverage", listener: (data: TestCoverage) => void): this;
273
+ once(event: "test:dequeue", listener: (data: TestDequeue) => void): this;
270
274
  once(event: "test:diagnostic", listener: (data: DiagnosticData) => void): this;
275
+ once(event: "test:enqueue", listener: (data: TestEnqueue) => void): this;
271
276
  once(event: "test:fail", listener: (data: TestFail) => void): this;
272
277
  once(event: "test:pass", listener: (data: TestPass) => void): this;
273
278
  once(event: "test:plan", listener: (data: TestPlan) => void): this;
274
279
  once(event: "test:start", listener: (data: TestStart) => void): this;
275
280
  once(event: "test:stderr", listener: (data: TestStderr) => void): this;
276
281
  once(event: "test:stdout", listener: (data: TestStdout) => void): this;
282
+ once(event: "test:watch:drained", listener: () => void): this;
277
283
  once(event: string, listener: (...args: any[]) => void): this;
284
+ prependListener(event: "test:coverage", listener: (data: TestCoverage) => void): this;
285
+ prependListener(event: "test:dequeue", listener: (data: TestDequeue) => void): this;
278
286
  prependListener(event: "test:diagnostic", listener: (data: DiagnosticData) => void): this;
287
+ prependListener(event: "test:enqueue", listener: (data: TestEnqueue) => void): this;
279
288
  prependListener(event: "test:fail", listener: (data: TestFail) => void): this;
280
289
  prependListener(event: "test:pass", listener: (data: TestPass) => void): this;
281
290
  prependListener(event: "test:plan", listener: (data: TestPlan) => void): this;
282
291
  prependListener(event: "test:start", listener: (data: TestStart) => void): this;
283
292
  prependListener(event: "test:stderr", listener: (data: TestStderr) => void): this;
284
293
  prependListener(event: "test:stdout", listener: (data: TestStdout) => void): this;
294
+ prependListener(event: "test:watch:drained", listener: () => void): this;
285
295
  prependListener(event: string, listener: (...args: any[]) => void): this;
296
+ prependOnceListener(event: "test:coverage", listener: (data: TestCoverage) => void): this;
297
+ prependOnceListener(event: "test:dequeue", listener: (data: TestDequeue) => void): this;
286
298
  prependOnceListener(event: "test:diagnostic", listener: (data: DiagnosticData) => void): this;
299
+ prependOnceListener(event: "test:enqueue", listener: (data: TestEnqueue) => void): this;
287
300
  prependOnceListener(event: "test:fail", listener: (data: TestFail) => void): this;
288
301
  prependOnceListener(event: "test:pass", listener: (data: TestPass) => void): this;
289
302
  prependOnceListener(event: "test:plan", listener: (data: TestPlan) => void): this;
290
303
  prependOnceListener(event: "test:start", listener: (data: TestStart) => void): this;
291
304
  prependOnceListener(event: "test:stderr", listener: (data: TestStderr) => void): this;
292
305
  prependOnceListener(event: "test:stdout", listener: (data: TestStdout) => void): this;
306
+ prependOnceListener(event: "test:watch:drained", listener: () => void): this;
293
307
  prependOnceListener(event: string, listener: (...args: any[]) => void): this;
294
308
  }
295
309
 
@@ -752,6 +766,7 @@ declare module "node:test" {
752
766
  */
753
767
  restore(): void;
754
768
  }
769
+
755
770
  type Timer = "setInterval" | "clearInterval" | "setTimeout" | "clearTimeout";
756
771
  /**
757
772
  * Mocking timers is a technique commonly used in software testing to simulate and
@@ -901,6 +916,9 @@ declare module "node:test" {
901
916
  export { after, afterEach, before, beforeEach, describe, it, mock, run, test, test as default };
902
917
  }
903
918
 
919
+ interface TestError extends Error {
920
+ cause: Error;
921
+ }
904
922
  interface TestLocationInfo {
905
923
  /**
906
924
  * The column number where the test is defined, or
@@ -927,6 +945,133 @@ interface DiagnosticData extends TestLocationInfo {
927
945
  */
928
946
  nesting: number;
929
947
  }
948
+ interface TestCoverage {
949
+ /**
950
+ * An object containing the coverage report.
951
+ */
952
+ summary: {
953
+ /**
954
+ * An array of coverage reports for individual files.
955
+ */
956
+ files: Array<{
957
+ /**
958
+ * The absolute path of the file.
959
+ */
960
+ path: string;
961
+ /**
962
+ * The total number of lines.
963
+ */
964
+ totalLineCount: number;
965
+ /**
966
+ * The total number of branches.
967
+ */
968
+ totalBranchCount: number;
969
+ /**
970
+ * The total number of functions.
971
+ */
972
+ totalFunctionCount: number;
973
+ /**
974
+ * The number of covered lines.
975
+ */
976
+ coveredLineCount: number;
977
+ /**
978
+ * The number of covered branches.
979
+ */
980
+ coveredBranchCount: number;
981
+ /**
982
+ * The number of covered functions.
983
+ */
984
+ coveredFunctionCount: number;
985
+ /**
986
+ * The percentage of lines covered.
987
+ */
988
+ coveredLinePercent: number;
989
+ /**
990
+ * The percentage of branches covered.
991
+ */
992
+ coveredBranchPercent: number;
993
+ /**
994
+ * The percentage of functions covered.
995
+ */
996
+ coveredFunctionPercent: number;
997
+ /**
998
+ * An array of integers representing line numbers that are uncovered.
999
+ */
1000
+ uncoveredLineNumbers: number[];
1001
+ }>;
1002
+ /**
1003
+ * An object containing a summary of coverage for all files.
1004
+ */
1005
+ totals: {
1006
+ /**
1007
+ * The total number of lines.
1008
+ */
1009
+ totalLineCount: number;
1010
+ /**
1011
+ * The total number of branches.
1012
+ */
1013
+ totalBranchCount: number;
1014
+ /**
1015
+ * The total number of functions.
1016
+ */
1017
+ totalFunctionCount: number;
1018
+ /**
1019
+ * The number of covered lines.
1020
+ */
1021
+ coveredLineCount: number;
1022
+ /**
1023
+ * The number of covered branches.
1024
+ */
1025
+ coveredBranchCount: number;
1026
+ /**
1027
+ * The number of covered functions.
1028
+ */
1029
+ coveredFunctionCount: number;
1030
+ /**
1031
+ * The percentage of lines covered.
1032
+ */
1033
+ coveredLinePercent: number;
1034
+ /**
1035
+ * The percentage of branches covered.
1036
+ */
1037
+ coveredBranchPercent: number;
1038
+ /**
1039
+ * The percentage of functions covered.
1040
+ */
1041
+ coveredFunctionPercent: number;
1042
+ };
1043
+ /**
1044
+ * The working directory when code coverage began. This
1045
+ * is useful for displaying relative path names in case
1046
+ * the tests changed the working directory of the Node.js process.
1047
+ */
1048
+ workingDirectory: string;
1049
+ };
1050
+ /**
1051
+ * The nesting level of the test.
1052
+ */
1053
+ nesting: number;
1054
+ }
1055
+ interface TestDequeue extends TestLocationInfo {
1056
+ /**
1057
+ * The test name
1058
+ */
1059
+ name: string;
1060
+ /**
1061
+ * The nesting level of the test.
1062
+ */
1063
+ nesting: number;
1064
+ }
1065
+ interface TestEnqueue extends TestLocationInfo {
1066
+ /**
1067
+ * The test name
1068
+ */
1069
+ name: string;
1070
+ /**
1071
+ * The nesting level of the test.
1072
+ */
1073
+ nesting: number;
1074
+ }
930
1075
  interface TestFail extends TestLocationInfo {
931
1076
  /**
932
1077
  * Additional execution metadata.
@@ -939,7 +1084,7 @@ interface TestFail extends TestLocationInfo {
939
1084
  /**
940
1085
  * The error thrown by the test.
941
1086
  */
942
- error: Error;
1087
+ error: TestError;
943
1088
  /**
944
1089
  * The type of the test, used to denote whether this is a suite.
945
1090
  * @since 18.17.0
@@ -1035,26 +1180,6 @@ interface TestStdout extends TestLocationInfo {
1035
1180
  */
1036
1181
  message: string;
1037
1182
  }
1038
- interface TestEnqueue extends TestLocationInfo {
1039
- /**
1040
- * The test name
1041
- */
1042
- name: string;
1043
- /**
1044
- * The nesting level of the test.
1045
- */
1046
- nesting: number;
1047
- }
1048
- interface TestDequeue extends TestLocationInfo {
1049
- /**
1050
- * The test name
1051
- */
1052
- name: string;
1053
- /**
1054
- * The nesting level of the test.
1055
- */
1056
- nesting: number;
1057
- }
1058
1183
 
1059
1184
  /**
1060
1185
  * The `node:test/reporters` module exposes the builtin-reporters for `node:test`.
@@ -1077,16 +1202,17 @@ declare module "node:test/reporters" {
1077
1202
  import { Transform } from "node:stream";
1078
1203
 
1079
1204
  type TestEvent =
1205
+ | { type: "test:coverage"; data: TestCoverage }
1206
+ | { type: "test:dequeue"; data: TestDequeue }
1080
1207
  | { type: "test:diagnostic"; data: DiagnosticData }
1208
+ | { type: "test:enqueue"; data: TestEnqueue }
1081
1209
  | { type: "test:fail"; data: TestFail }
1082
1210
  | { type: "test:pass"; data: TestPass }
1083
1211
  | { type: "test:plan"; data: TestPlan }
1084
1212
  | { type: "test:start"; data: TestStart }
1085
1213
  | { type: "test:stderr"; data: TestStderr }
1086
1214
  | { type: "test:stdout"; data: TestStdout }
1087
- | { type: "test:enqueue"; data: TestEnqueue }
1088
- | { type: "test:dequeue"; data: TestDequeue }
1089
- | { type: "test:watch:drained" };
1215
+ | { type: "test:watch:drained"; data: undefined };
1090
1216
  type TestEventGenerator = AsyncGenerator<TestEvent, void>;
1091
1217
 
1092
1218
  /**