imran-dl 2.3.3

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of imran-dl might be problematic. Click here for more details.

Files changed (229) hide show
  1. package/.cache/nix/binary-cache-v6.sqlite +0 -0
  2. package/.cache/nix/binary-cache-v6.sqlite-journal +0 -0
  3. package/.cache/replit/__replit_disk_meta.json +1 -0
  4. package/.cache/replit/modules/nodejs-20:v32-20240401-269b323.res +1 -0
  5. package/.cache/replit/modules/replit:v8-20240329-787bc7d.res +1 -0
  6. package/.cache/replit/modules.stamp +0 -0
  7. package/.cache/replit/nix/env.json +1 -0
  8. package/.cache/typescript/5.0/node_modules/.package-lock.json +12 -0
  9. package/.cache/typescript/5.0/node_modules/types-registry/README.md +2 -0
  10. package/.cache/typescript/5.0/node_modules/types-registry/index.json +1 -0
  11. package/.cache/typescript/5.0/node_modules/types-registry/package.json +20 -0
  12. package/.cache/typescript/5.0/package.json +1 -0
  13. package/.cache/typescript/5.3/node_modules/.package-lock.json +114 -0
  14. package/.cache/typescript/5.3/node_modules/@types/cheerio/LICENSE +21 -0
  15. package/.cache/typescript/5.3/node_modules/@types/cheerio/README.md +15 -0
  16. package/.cache/typescript/5.3/node_modules/@types/cheerio/index.d.ts +318 -0
  17. package/.cache/typescript/5.3/node_modules/@types/cheerio/package.json +71 -0
  18. package/.cache/typescript/5.3/node_modules/@types/node/LICENSE +21 -0
  19. package/.cache/typescript/5.3/node_modules/@types/node/README.md +15 -0
  20. package/.cache/typescript/5.3/node_modules/@types/node/assert/strict.d.ts +8 -0
  21. package/.cache/typescript/5.3/node_modules/@types/node/assert.d.ts +996 -0
  22. package/.cache/typescript/5.3/node_modules/@types/node/async_hooks.d.ts +539 -0
  23. package/.cache/typescript/5.3/node_modules/@types/node/buffer.d.ts +2362 -0
  24. package/.cache/typescript/5.3/node_modules/@types/node/child_process.d.ts +1540 -0
  25. package/.cache/typescript/5.3/node_modules/@types/node/cluster.d.ts +432 -0
  26. package/.cache/typescript/5.3/node_modules/@types/node/console.d.ts +415 -0
  27. package/.cache/typescript/5.3/node_modules/@types/node/constants.d.ts +19 -0
  28. package/.cache/typescript/5.3/node_modules/@types/node/crypto.d.ts +4456 -0
  29. package/.cache/typescript/5.3/node_modules/@types/node/dgram.d.ts +586 -0
  30. package/.cache/typescript/5.3/node_modules/@types/node/diagnostics_channel.d.ts +191 -0
  31. package/.cache/typescript/5.3/node_modules/@types/node/dns/promises.d.ts +425 -0
  32. package/.cache/typescript/5.3/node_modules/@types/node/dns.d.ts +809 -0
  33. package/.cache/typescript/5.3/node_modules/@types/node/dom-events.d.ts +122 -0
  34. package/.cache/typescript/5.3/node_modules/@types/node/domain.d.ts +170 -0
  35. package/.cache/typescript/5.3/node_modules/@types/node/events.d.ts +879 -0
  36. package/.cache/typescript/5.3/node_modules/@types/node/fs/promises.d.ts +1239 -0
  37. package/.cache/typescript/5.3/node_modules/@types/node/fs.d.ts +4291 -0
  38. package/.cache/typescript/5.3/node_modules/@types/node/globals.d.ts +385 -0
  39. package/.cache/typescript/5.3/node_modules/@types/node/globals.global.d.ts +1 -0
  40. package/.cache/typescript/5.3/node_modules/@types/node/http.d.ts +1888 -0
  41. package/.cache/typescript/5.3/node_modules/@types/node/http2.d.ts +2382 -0
  42. package/.cache/typescript/5.3/node_modules/@types/node/https.d.ts +550 -0
  43. package/.cache/typescript/5.3/node_modules/@types/node/index.d.ts +88 -0
  44. package/.cache/typescript/5.3/node_modules/@types/node/inspector.d.ts +2747 -0
  45. package/.cache/typescript/5.3/node_modules/@types/node/module.d.ts +301 -0
  46. package/.cache/typescript/5.3/node_modules/@types/node/net.d.ts +949 -0
  47. package/.cache/typescript/5.3/node_modules/@types/node/os.d.ts +478 -0
  48. package/.cache/typescript/5.3/node_modules/@types/node/package.json +230 -0
  49. package/.cache/typescript/5.3/node_modules/@types/node/path.d.ts +191 -0
  50. package/.cache/typescript/5.3/node_modules/@types/node/perf_hooks.d.ts +639 -0
  51. package/.cache/typescript/5.3/node_modules/@types/node/process.d.ts +1539 -0
  52. package/.cache/typescript/5.3/node_modules/@types/node/punycode.d.ts +117 -0
  53. package/.cache/typescript/5.3/node_modules/@types/node/querystring.d.ts +141 -0
  54. package/.cache/typescript/5.3/node_modules/@types/node/readline/promises.d.ts +150 -0
  55. package/.cache/typescript/5.3/node_modules/@types/node/readline.d.ts +539 -0
  56. package/.cache/typescript/5.3/node_modules/@types/node/repl.d.ts +430 -0
  57. package/.cache/typescript/5.3/node_modules/@types/node/stream/consumers.d.ts +12 -0
  58. package/.cache/typescript/5.3/node_modules/@types/node/stream/promises.d.ts +83 -0
  59. package/.cache/typescript/5.3/node_modules/@types/node/stream/web.d.ts +350 -0
  60. package/.cache/typescript/5.3/node_modules/@types/node/stream.d.ts +1701 -0
  61. package/.cache/typescript/5.3/node_modules/@types/node/string_decoder.d.ts +67 -0
  62. package/.cache/typescript/5.3/node_modules/@types/node/test.d.ts +1382 -0
  63. package/.cache/typescript/5.3/node_modules/@types/node/timers/promises.d.ts +93 -0
  64. package/.cache/typescript/5.3/node_modules/@types/node/timers.d.ts +240 -0
  65. package/.cache/typescript/5.3/node_modules/@types/node/tls.d.ts +1210 -0
  66. package/.cache/typescript/5.3/node_modules/@types/node/trace_events.d.ts +182 -0
  67. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/assert/strict.d.ts +8 -0
  68. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/assert.d.ts +996 -0
  69. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/async_hooks.d.ts +539 -0
  70. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/buffer.d.ts +2362 -0
  71. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/child_process.d.ts +1540 -0
  72. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/cluster.d.ts +432 -0
  73. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/console.d.ts +415 -0
  74. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/constants.d.ts +19 -0
  75. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/crypto.d.ts +4455 -0
  76. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/dgram.d.ts +586 -0
  77. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/diagnostics_channel.d.ts +191 -0
  78. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/dns/promises.d.ts +425 -0
  79. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/dns.d.ts +809 -0
  80. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/dom-events.d.ts +122 -0
  81. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/domain.d.ts +170 -0
  82. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/events.d.ts +879 -0
  83. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/fs/promises.d.ts +1239 -0
  84. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/fs.d.ts +4291 -0
  85. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/globals.d.ts +385 -0
  86. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/globals.global.d.ts +1 -0
  87. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/http.d.ts +1888 -0
  88. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/http2.d.ts +2382 -0
  89. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/https.d.ts +550 -0
  90. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/index.d.ts +88 -0
  91. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/inspector.d.ts +2747 -0
  92. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/module.d.ts +301 -0
  93. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/net.d.ts +949 -0
  94. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/os.d.ts +478 -0
  95. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/path.d.ts +191 -0
  96. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/perf_hooks.d.ts +639 -0
  97. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/process.d.ts +1539 -0
  98. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/punycode.d.ts +117 -0
  99. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/querystring.d.ts +141 -0
  100. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/readline/promises.d.ts +150 -0
  101. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/readline.d.ts +539 -0
  102. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/repl.d.ts +430 -0
  103. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/stream/consumers.d.ts +12 -0
  104. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/stream/promises.d.ts +83 -0
  105. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/stream/web.d.ts +350 -0
  106. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/stream.d.ts +1701 -0
  107. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/string_decoder.d.ts +67 -0
  108. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/test.d.ts +1382 -0
  109. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/timers/promises.d.ts +93 -0
  110. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/timers.d.ts +240 -0
  111. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/tls.d.ts +1210 -0
  112. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/trace_events.d.ts +182 -0
  113. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/tty.d.ts +208 -0
  114. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/url.d.ts +927 -0
  115. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/util.d.ts +2183 -0
  116. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/v8.d.ts +635 -0
  117. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/vm.d.ts +903 -0
  118. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/wasi.d.ts +158 -0
  119. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/worker_threads.d.ts +691 -0
  120. package/.cache/typescript/5.3/node_modules/@types/node/ts4.8/zlib.d.ts +517 -0
  121. package/.cache/typescript/5.3/node_modules/@types/node/tty.d.ts +208 -0
  122. package/.cache/typescript/5.3/node_modules/@types/node/url.d.ts +927 -0
  123. package/.cache/typescript/5.3/node_modules/@types/node/util.d.ts +2183 -0
  124. package/.cache/typescript/5.3/node_modules/@types/node/v8.d.ts +635 -0
  125. package/.cache/typescript/5.3/node_modules/@types/node/vm.d.ts +903 -0
  126. package/.cache/typescript/5.3/node_modules/@types/node/wasi.d.ts +158 -0
  127. package/.cache/typescript/5.3/node_modules/@types/node/worker_threads.d.ts +691 -0
  128. package/.cache/typescript/5.3/node_modules/@types/node/zlib.d.ts +517 -0
  129. package/.cache/typescript/5.3/node_modules/@types/node-fetch/LICENSE +21 -0
  130. package/.cache/typescript/5.3/node_modules/@types/node-fetch/README.md +15 -0
  131. package/.cache/typescript/5.3/node_modules/@types/node-fetch/externals.d.ts +32 -0
  132. package/.cache/typescript/5.3/node_modules/@types/node-fetch/index.d.ts +214 -0
  133. package/.cache/typescript/5.3/node_modules/@types/node-fetch/package.json +83 -0
  134. package/.cache/typescript/5.3/node_modules/@types/qs/LICENSE +21 -0
  135. package/.cache/typescript/5.3/node_modules/@types/qs/README.md +15 -0
  136. package/.cache/typescript/5.3/node_modules/@types/qs/index.d.ts +79 -0
  137. package/.cache/typescript/5.3/node_modules/@types/qs/package.json +65 -0
  138. package/.cache/typescript/5.3/node_modules/asynckit/LICENSE +21 -0
  139. package/.cache/typescript/5.3/node_modules/asynckit/README.md +233 -0
  140. package/.cache/typescript/5.3/node_modules/asynckit/bench.js +76 -0
  141. package/.cache/typescript/5.3/node_modules/asynckit/index.js +6 -0
  142. package/.cache/typescript/5.3/node_modules/asynckit/lib/abort.js +29 -0
  143. package/.cache/typescript/5.3/node_modules/asynckit/lib/async.js +34 -0
  144. package/.cache/typescript/5.3/node_modules/asynckit/lib/defer.js +26 -0
  145. package/.cache/typescript/5.3/node_modules/asynckit/lib/iterate.js +75 -0
  146. package/.cache/typescript/5.3/node_modules/asynckit/lib/readable_asynckit.js +91 -0
  147. package/.cache/typescript/5.3/node_modules/asynckit/lib/readable_parallel.js +25 -0
  148. package/.cache/typescript/5.3/node_modules/asynckit/lib/readable_serial.js +25 -0
  149. package/.cache/typescript/5.3/node_modules/asynckit/lib/readable_serial_ordered.js +29 -0
  150. package/.cache/typescript/5.3/node_modules/asynckit/lib/state.js +37 -0
  151. package/.cache/typescript/5.3/node_modules/asynckit/lib/streamify.js +141 -0
  152. package/.cache/typescript/5.3/node_modules/asynckit/lib/terminator.js +29 -0
  153. package/.cache/typescript/5.3/node_modules/asynckit/package.json +63 -0
  154. package/.cache/typescript/5.3/node_modules/asynckit/parallel.js +43 -0
  155. package/.cache/typescript/5.3/node_modules/asynckit/serial.js +17 -0
  156. package/.cache/typescript/5.3/node_modules/asynckit/serialOrdered.js +75 -0
  157. package/.cache/typescript/5.3/node_modules/asynckit/stream.js +21 -0
  158. package/.cache/typescript/5.3/node_modules/combined-stream/License +19 -0
  159. package/.cache/typescript/5.3/node_modules/combined-stream/Readme.md +138 -0
  160. package/.cache/typescript/5.3/node_modules/combined-stream/lib/combined_stream.js +208 -0
  161. package/.cache/typescript/5.3/node_modules/combined-stream/package.json +25 -0
  162. package/.cache/typescript/5.3/node_modules/combined-stream/yarn.lock +17 -0
  163. package/.cache/typescript/5.3/node_modules/delayed-stream/License +19 -0
  164. package/.cache/typescript/5.3/node_modules/delayed-stream/Makefile +7 -0
  165. package/.cache/typescript/5.3/node_modules/delayed-stream/Readme.md +141 -0
  166. package/.cache/typescript/5.3/node_modules/delayed-stream/lib/delayed_stream.js +107 -0
  167. package/.cache/typescript/5.3/node_modules/delayed-stream/package.json +27 -0
  168. package/.cache/typescript/5.3/node_modules/form-data/License +19 -0
  169. package/.cache/typescript/5.3/node_modules/form-data/README.md.bak +358 -0
  170. package/.cache/typescript/5.3/node_modules/form-data/Readme.md +358 -0
  171. package/.cache/typescript/5.3/node_modules/form-data/index.d.ts +62 -0
  172. package/.cache/typescript/5.3/node_modules/form-data/lib/browser.js +2 -0
  173. package/.cache/typescript/5.3/node_modules/form-data/lib/form_data.js +501 -0
  174. package/.cache/typescript/5.3/node_modules/form-data/lib/populate.js +10 -0
  175. package/.cache/typescript/5.3/node_modules/form-data/package.json +68 -0
  176. package/.cache/typescript/5.3/node_modules/mime-db/HISTORY.md +507 -0
  177. package/.cache/typescript/5.3/node_modules/mime-db/LICENSE +23 -0
  178. package/.cache/typescript/5.3/node_modules/mime-db/README.md +100 -0
  179. package/.cache/typescript/5.3/node_modules/mime-db/db.json +8519 -0
  180. package/.cache/typescript/5.3/node_modules/mime-db/index.js +12 -0
  181. package/.cache/typescript/5.3/node_modules/mime-db/package.json +60 -0
  182. package/.cache/typescript/5.3/node_modules/mime-types/HISTORY.md +397 -0
  183. package/.cache/typescript/5.3/node_modules/mime-types/LICENSE +23 -0
  184. package/.cache/typescript/5.3/node_modules/mime-types/README.md +113 -0
  185. package/.cache/typescript/5.3/node_modules/mime-types/index.js +188 -0
  186. package/.cache/typescript/5.3/node_modules/mime-types/package.json +44 -0
  187. package/.cache/typescript/5.3/node_modules/types-registry/README.md +2 -0
  188. package/.cache/typescript/5.3/node_modules/types-registry/index.json +1 -0
  189. package/.cache/typescript/5.3/node_modules/types-registry/package.json +20 -0
  190. package/.cache/typescript/5.3/node_modules/undici-types/README.md +6 -0
  191. package/.cache/typescript/5.3/node_modules/undici-types/agent.d.ts +31 -0
  192. package/.cache/typescript/5.3/node_modules/undici-types/api.d.ts +43 -0
  193. package/.cache/typescript/5.3/node_modules/undici-types/balanced-pool.d.ts +18 -0
  194. package/.cache/typescript/5.3/node_modules/undici-types/cache.d.ts +36 -0
  195. package/.cache/typescript/5.3/node_modules/undici-types/client.d.ts +97 -0
  196. package/.cache/typescript/5.3/node_modules/undici-types/connector.d.ts +34 -0
  197. package/.cache/typescript/5.3/node_modules/undici-types/content-type.d.ts +21 -0
  198. package/.cache/typescript/5.3/node_modules/undici-types/cookies.d.ts +28 -0
  199. package/.cache/typescript/5.3/node_modules/undici-types/diagnostics-channel.d.ts +67 -0
  200. package/.cache/typescript/5.3/node_modules/undici-types/dispatcher.d.ts +241 -0
  201. package/.cache/typescript/5.3/node_modules/undici-types/errors.d.ts +128 -0
  202. package/.cache/typescript/5.3/node_modules/undici-types/fetch.d.ts +209 -0
  203. package/.cache/typescript/5.3/node_modules/undici-types/file.d.ts +39 -0
  204. package/.cache/typescript/5.3/node_modules/undici-types/filereader.d.ts +54 -0
  205. package/.cache/typescript/5.3/node_modules/undici-types/formdata.d.ts +108 -0
  206. package/.cache/typescript/5.3/node_modules/undici-types/global-dispatcher.d.ts +9 -0
  207. package/.cache/typescript/5.3/node_modules/undici-types/global-origin.d.ts +7 -0
  208. package/.cache/typescript/5.3/node_modules/undici-types/handlers.d.ts +9 -0
  209. package/.cache/typescript/5.3/node_modules/undici-types/header.d.ts +4 -0
  210. package/.cache/typescript/5.3/node_modules/undici-types/index.d.ts +63 -0
  211. package/.cache/typescript/5.3/node_modules/undici-types/interceptors.d.ts +5 -0
  212. package/.cache/typescript/5.3/node_modules/undici-types/mock-agent.d.ts +50 -0
  213. package/.cache/typescript/5.3/node_modules/undici-types/mock-client.d.ts +25 -0
  214. package/.cache/typescript/5.3/node_modules/undici-types/mock-errors.d.ts +12 -0
  215. package/.cache/typescript/5.3/node_modules/undici-types/mock-interceptor.d.ts +93 -0
  216. package/.cache/typescript/5.3/node_modules/undici-types/mock-pool.d.ts +25 -0
  217. package/.cache/typescript/5.3/node_modules/undici-types/package.json +55 -0
  218. package/.cache/typescript/5.3/node_modules/undici-types/patch.d.ts +71 -0
  219. package/.cache/typescript/5.3/node_modules/undici-types/pool-stats.d.ts +19 -0
  220. package/.cache/typescript/5.3/node_modules/undici-types/pool.d.ts +28 -0
  221. package/.cache/typescript/5.3/node_modules/undici-types/proxy-agent.d.ts +30 -0
  222. package/.cache/typescript/5.3/node_modules/undici-types/readable.d.ts +61 -0
  223. package/.cache/typescript/5.3/node_modules/undici-types/webidl.d.ts +220 -0
  224. package/.cache/typescript/5.3/node_modules/undici-types/websocket.d.ts +131 -0
  225. package/.cache/typescript/5.3/package.json +1 -0
  226. package/IMRAN/module.js +1 -0
  227. package/README.md +64 -0
  228. package/index.js +13 -0
  229. package/package.json +48 -0
@@ -0,0 +1,1382 @@
1
+ /**
2
+ * The `node:test` module facilitates the creation of JavaScript tests.
3
+ * To access it:
4
+ *
5
+ * ```js
6
+ * import test from 'node:test';
7
+ * ```
8
+ *
9
+ * This module is only available under the `node:` scheme. The following will not
10
+ * work:
11
+ *
12
+ * ```js
13
+ * import test from 'test';
14
+ * ```
15
+ *
16
+ * Tests created via the `test` module consist of a single function that is
17
+ * processed in one of three ways:
18
+ *
19
+ * 1. A synchronous function that is considered failing if it throws an exception,
20
+ * and is considered passing otherwise.
21
+ * 2. A function that returns a `Promise` that is considered failing if the`Promise` rejects, and is considered passing if the `Promise` fulfills.
22
+ * 3. A function that receives a callback function. If the callback receives any
23
+ * truthy value as its first argument, the test is considered failing. If a
24
+ * falsy value is passed as the first argument to the callback, the test is
25
+ * considered passing. If the test function receives a callback function and
26
+ * also returns a `Promise`, the test will fail.
27
+ *
28
+ * The following example illustrates how tests are written using the`test` module.
29
+ *
30
+ * ```js
31
+ * test('synchronous passing test', (t) => {
32
+ * // This test passes because it does not throw an exception.
33
+ * assert.strictEqual(1, 1);
34
+ * });
35
+ *
36
+ * test('synchronous failing test', (t) => {
37
+ * // This test fails because it throws an exception.
38
+ * assert.strictEqual(1, 2);
39
+ * });
40
+ *
41
+ * test('asynchronous passing test', async (t) => {
42
+ * // This test passes because the Promise returned by the async
43
+ * // function is settled and not rejected.
44
+ * assert.strictEqual(1, 1);
45
+ * });
46
+ *
47
+ * test('asynchronous failing test', async (t) => {
48
+ * // This test fails because the Promise returned by the async
49
+ * // function is rejected.
50
+ * assert.strictEqual(1, 2);
51
+ * });
52
+ *
53
+ * test('failing test using Promises', (t) => {
54
+ * // Promises can be used directly as well.
55
+ * return new Promise((resolve, reject) => {
56
+ * setImmediate(() => {
57
+ * reject(new Error('this will cause the test to fail'));
58
+ * });
59
+ * });
60
+ * });
61
+ *
62
+ * test('callback passing test', (t, done) => {
63
+ * // done() is the callback function. When the setImmediate() runs, it invokes
64
+ * // done() with no arguments.
65
+ * setImmediate(done);
66
+ * });
67
+ *
68
+ * test('callback failing test', (t, done) => {
69
+ * // When the setImmediate() runs, done() is invoked with an Error object and
70
+ * // the test fails.
71
+ * setImmediate(() => {
72
+ * done(new Error('callback failure'));
73
+ * });
74
+ * });
75
+ * ```
76
+ *
77
+ * If any tests fail, the process exit code is set to `1`.
78
+ * @since v18.0.0, v16.17.0
79
+ * @see [source](https://github.com/nodejs/node/blob/v20.4.0/lib/test.js)
80
+ */
81
+ declare module "node:test" {
82
+ import { Readable } from "node:stream";
83
+ import { AsyncResource } from "node:async_hooks";
84
+ /**
85
+ * ```js
86
+ * import { tap } from 'node:test/reporters';
87
+ * import { run } from 'node:test';
88
+ * import process from 'node:process';
89
+ * import path from 'node:path';
90
+ *
91
+ * run({ files: [path.resolve('./tests/test.js')] })
92
+ * .compose(tap)
93
+ * .pipe(process.stdout);
94
+ * ```
95
+ * @since v18.9.0, v16.19.0
96
+ * @param options Configuration options for running tests. The following properties are supported:
97
+ */
98
+ function run(options?: RunOptions): TestsStream;
99
+ /**
100
+ * The `test()` function is the value imported from the `test` module. Each
101
+ * invocation of this function results in reporting the test to the `TestsStream`.
102
+ *
103
+ * The `TestContext` object passed to the `fn` argument can be used to perform
104
+ * actions related to the current test. Examples include skipping the test, adding
105
+ * additional diagnostic information, or creating subtests.
106
+ *
107
+ * `test()` returns a `Promise` that fulfills once the test completes.
108
+ * if `test()` is called within a `describe()` block, it fulfills immediately.
109
+ * The return value can usually be discarded for top level tests.
110
+ * However, the return value from subtests should be used to prevent the parent
111
+ * test from finishing first and cancelling the subtest
112
+ * as shown in the following example.
113
+ *
114
+ * ```js
115
+ * test('top level test', async (t) => {
116
+ * // The setTimeout() in the following subtest would cause it to outlive its
117
+ * // parent test if 'await' is removed on the next line. Once the parent test
118
+ * // completes, it will cancel any outstanding subtests.
119
+ * await t.test('longer running subtest', async (t) => {
120
+ * return new Promise((resolve, reject) => {
121
+ * setTimeout(resolve, 1000);
122
+ * });
123
+ * });
124
+ * });
125
+ * ```
126
+ *
127
+ * The `timeout` option can be used to fail the test if it takes longer than`timeout` milliseconds to complete. However, it is not a reliable mechanism for
128
+ * canceling tests because a running test might block the application thread and
129
+ * thus prevent the scheduled cancellation.
130
+ * @since v18.0.0, v16.17.0
131
+ * @param [name='The name'] The name of the test, which is displayed when reporting test results.
132
+ * @param options Configuration options for the test. The following properties are supported:
133
+ * @param [fn='A no-op function'] The function under test. The first argument to this function is a {@link TestContext} object. If the test uses callbacks, the callback function is passed as the
134
+ * second argument.
135
+ * @return Fulfilled with `undefined` once the test completes, or immediately if the test runs within {@link describe}.
136
+ */
137
+ function test(name?: string, fn?: TestFn): Promise<void>;
138
+ function test(name?: string, options?: TestOptions, fn?: TestFn): Promise<void>;
139
+ function test(options?: TestOptions, fn?: TestFn): Promise<void>;
140
+ function test(fn?: TestFn): Promise<void>;
141
+ namespace test {
142
+ export { after, afterEach, before, beforeEach, describe, it, mock, only, run, skip, test, todo };
143
+ }
144
+ /**
145
+ * The `describe()` function imported from the `node:test` module. Each
146
+ * invocation of this function results in the creation of a Subtest.
147
+ * After invocation of top level `describe` functions,
148
+ * all top level tests and suites will execute.
149
+ * @param [name='The name'] The name of the suite, which is displayed when reporting test results.
150
+ * @param options Configuration options for the suite. supports the same options as `test([name][, options][, fn])`.
151
+ * @param [fn='A no-op function'] The function under suite declaring all subtests and subsuites. The first argument to this function is a {@link SuiteContext} object.
152
+ * @return Immediately fulfilled with `undefined`.
153
+ */
154
+ function describe(name?: string, options?: TestOptions, fn?: SuiteFn): Promise<void>;
155
+ function describe(name?: string, fn?: SuiteFn): Promise<void>;
156
+ function describe(options?: TestOptions, fn?: SuiteFn): Promise<void>;
157
+ function describe(fn?: SuiteFn): Promise<void>;
158
+ namespace describe {
159
+ /**
160
+ * Shorthand for skipping a suite, same as `describe([name], { skip: true }[, fn])`.
161
+ */
162
+ function skip(name?: string, options?: TestOptions, fn?: SuiteFn): Promise<void>;
163
+ function skip(name?: string, fn?: SuiteFn): Promise<void>;
164
+ function skip(options?: TestOptions, fn?: SuiteFn): Promise<void>;
165
+ function skip(fn?: SuiteFn): Promise<void>;
166
+ /**
167
+ * Shorthand for marking a suite as `TODO`, same as `describe([name], { todo: true }[, fn])`.
168
+ */
169
+ function todo(name?: string, options?: TestOptions, fn?: SuiteFn): Promise<void>;
170
+ function todo(name?: string, fn?: SuiteFn): Promise<void>;
171
+ function todo(options?: TestOptions, fn?: SuiteFn): Promise<void>;
172
+ function todo(fn?: SuiteFn): Promise<void>;
173
+ /**
174
+ * Shorthand for marking a suite as `only`, same as `describe([name], { only: true }[, fn])`.
175
+ * @since v18.15.0
176
+ */
177
+ function only(name?: string, options?: TestOptions, fn?: SuiteFn): Promise<void>;
178
+ function only(name?: string, fn?: SuiteFn): Promise<void>;
179
+ function only(options?: TestOptions, fn?: SuiteFn): Promise<void>;
180
+ function only(fn?: SuiteFn): Promise<void>;
181
+ }
182
+ /**
183
+ * Shorthand for `test()`.
184
+ *
185
+ * The `it()` function is imported from the `node:test` module.
186
+ * @since v18.6.0, v16.17.0
187
+ */
188
+ function it(name?: string, options?: TestOptions, fn?: TestFn): Promise<void>;
189
+ function it(name?: string, fn?: TestFn): Promise<void>;
190
+ function it(options?: TestOptions, fn?: TestFn): Promise<void>;
191
+ function it(fn?: TestFn): Promise<void>;
192
+ namespace it {
193
+ /**
194
+ * Shorthand for skipping a test, same as `it([name], { skip: true }[, fn])`.
195
+ */
196
+ function skip(name?: string, options?: TestOptions, fn?: TestFn): Promise<void>;
197
+ function skip(name?: string, fn?: TestFn): Promise<void>;
198
+ function skip(options?: TestOptions, fn?: TestFn): Promise<void>;
199
+ function skip(fn?: TestFn): Promise<void>;
200
+ /**
201
+ * Shorthand for marking a test as `TODO`, same as `it([name], { todo: true }[, fn])`.
202
+ */
203
+ function todo(name?: string, options?: TestOptions, fn?: TestFn): Promise<void>;
204
+ function todo(name?: string, fn?: TestFn): Promise<void>;
205
+ function todo(options?: TestOptions, fn?: TestFn): Promise<void>;
206
+ function todo(fn?: TestFn): Promise<void>;
207
+ /**
208
+ * Shorthand for marking a test as `only`, same as `it([name], { only: true }[, fn])`.
209
+ * @since v18.15.0
210
+ */
211
+ function only(name?: string, options?: TestOptions, fn?: TestFn): Promise<void>;
212
+ function only(name?: string, fn?: TestFn): Promise<void>;
213
+ function only(options?: TestOptions, fn?: TestFn): Promise<void>;
214
+ function only(fn?: TestFn): Promise<void>;
215
+ }
216
+ /**
217
+ * Shorthand for skipping a test, same as `test([name], { skip: true }[, fn])`.
218
+ * @since v20.2.0
219
+ */
220
+ function skip(name?: string, options?: TestOptions, fn?: TestFn): Promise<void>;
221
+ function skip(name?: string, fn?: TestFn): Promise<void>;
222
+ function skip(options?: TestOptions, fn?: TestFn): Promise<void>;
223
+ function skip(fn?: TestFn): Promise<void>;
224
+ /**
225
+ * Shorthand for marking a test as `TODO`, same as `test([name], { todo: true }[, fn])`.
226
+ * @since v20.2.0
227
+ */
228
+ function todo(name?: string, options?: TestOptions, fn?: TestFn): Promise<void>;
229
+ function todo(name?: string, fn?: TestFn): Promise<void>;
230
+ function todo(options?: TestOptions, fn?: TestFn): Promise<void>;
231
+ function todo(fn?: TestFn): Promise<void>;
232
+ /**
233
+ * Shorthand for marking a test as `only`, same as `test([name], { only: true }[, fn])`.
234
+ * @since v20.2.0
235
+ */
236
+ function only(name?: string, options?: TestOptions, fn?: TestFn): Promise<void>;
237
+ function only(name?: string, fn?: TestFn): Promise<void>;
238
+ function only(options?: TestOptions, fn?: TestFn): Promise<void>;
239
+ function only(fn?: TestFn): Promise<void>;
240
+ /**
241
+ * The type of a function under test. The first argument to this function is a
242
+ * {@link TestContext} object. If the test uses callbacks, the callback function is passed as
243
+ * the second argument.
244
+ */
245
+ type TestFn = (t: TestContext, done: (result?: any) => void) => void | Promise<void>;
246
+ /**
247
+ * The type of a function under Suite.
248
+ */
249
+ type SuiteFn = (s: SuiteContext) => void | Promise<void>;
250
+ interface TestShard {
251
+ /**
252
+ * A positive integer between 1 and `<total>` that specifies the index of the shard to run.
253
+ */
254
+ index: number;
255
+ /**
256
+ * A positive integer that specifies the total number of shards to split the test files to.
257
+ */
258
+ total: number;
259
+ }
260
+ interface RunOptions {
261
+ /**
262
+ * If a number is provided, then that many files would run in parallel.
263
+ * If truthy, it would run (number of cpu cores - 1) files in parallel.
264
+ * If falsy, it would only run one file at a time.
265
+ * If unspecified, subtests inherit this value from their parent.
266
+ * @default true
267
+ */
268
+ concurrency?: number | boolean | undefined;
269
+ /**
270
+ * An array containing the list of files to run.
271
+ * If unspecified, the test runner execution model will be used.
272
+ */
273
+ files?: readonly string[] | undefined;
274
+ /**
275
+ * Allows aborting an in-progress test execution.
276
+ * @default undefined
277
+ */
278
+ signal?: AbortSignal | undefined;
279
+ /**
280
+ * A number of milliseconds the test will fail after.
281
+ * If unspecified, subtests inherit this value from their parent.
282
+ * @default Infinity
283
+ */
284
+ timeout?: number | undefined;
285
+ /**
286
+ * Sets inspector port of test child process.
287
+ * If a nullish value is provided, each process gets its own port,
288
+ * incremented from the primary's `process.debugPort`.
289
+ */
290
+ inspectPort?: number | (() => number) | undefined;
291
+ /**
292
+ * That can be used to only run tests whose name matches the provided pattern.
293
+ * Test name patterns are interpreted as JavaScript regular expressions.
294
+ * For each test that is executed, any corresponding test hooks, such as `beforeEach()`, are also run.
295
+ */
296
+ testNamePatterns?: string | RegExp | string[] | RegExp[];
297
+ /**
298
+ * If truthy, the test context will only run tests that have the `only` option set
299
+ */
300
+ only?: boolean;
301
+ /**
302
+ * A function that accepts the TestsStream instance and can be used to setup listeners before any tests are run.
303
+ */
304
+ setup?: (root: Test) => void | Promise<void>;
305
+ /**
306
+ * Whether to run in watch mode or not.
307
+ * @default false
308
+ */
309
+ watch?: boolean | undefined;
310
+ /**
311
+ * Running tests in a specific shard.
312
+ * @default undefined
313
+ */
314
+ shard?: TestShard | undefined;
315
+ }
316
+ class Test extends AsyncResource {
317
+ concurrency: number;
318
+ nesting: number;
319
+ only: boolean;
320
+ reporter: TestsStream;
321
+ runOnlySubtests: boolean;
322
+ testNumber: number;
323
+ timeout: number | null;
324
+ }
325
+ /**
326
+ * A successful call to `run()` method will return a new `TestsStream` object, streaming a series of events representing the execution of the tests.`TestsStream` will emit events, in the
327
+ * order of the tests definition
328
+ * @since v18.9.0, v16.19.0
329
+ */
330
+ class TestsStream extends Readable implements NodeJS.ReadableStream {
331
+ addListener(event: "test:diagnostic", listener: (data: DiagnosticData) => void): this;
332
+ addListener(event: "test:fail", listener: (data: TestFail) => void): this;
333
+ addListener(event: "test:pass", listener: (data: TestPass) => void): this;
334
+ addListener(event: "test:plan", listener: (data: TestPlan) => void): this;
335
+ addListener(event: "test:start", listener: (data: TestStart) => void): this;
336
+ addListener(event: "test:stderr", listener: (data: TestStderr) => void): this;
337
+ addListener(event: "test:stdout", listener: (data: TestStdout) => void): this;
338
+ addListener(event: string, listener: (...args: any[]) => void): this;
339
+ emit(event: "test:diagnostic", data: DiagnosticData): boolean;
340
+ emit(event: "test:fail", data: TestFail): boolean;
341
+ emit(event: "test:pass", data: TestPass): boolean;
342
+ emit(event: "test:plan", data: TestPlan): boolean;
343
+ emit(event: "test:start", data: TestStart): boolean;
344
+ emit(event: "test:stderr", data: TestStderr): boolean;
345
+ emit(event: "test:stdout", data: TestStdout): boolean;
346
+ emit(event: string | symbol, ...args: any[]): boolean;
347
+ on(event: "test:diagnostic", listener: (data: DiagnosticData) => void): this;
348
+ on(event: "test:fail", listener: (data: TestFail) => void): this;
349
+ on(event: "test:pass", listener: (data: TestPass) => void): this;
350
+ on(event: "test:plan", listener: (data: TestPlan) => void): this;
351
+ on(event: "test:start", listener: (data: TestStart) => void): this;
352
+ on(event: "test:stderr", listener: (data: TestStderr) => void): this;
353
+ on(event: "test:stdout", listener: (data: TestStdout) => void): this;
354
+ on(event: string, listener: (...args: any[]) => void): this;
355
+ once(event: "test:diagnostic", listener: (data: DiagnosticData) => void): this;
356
+ once(event: "test:fail", listener: (data: TestFail) => void): this;
357
+ once(event: "test:pass", listener: (data: TestPass) => void): this;
358
+ once(event: "test:plan", listener: (data: TestPlan) => void): this;
359
+ once(event: "test:start", listener: (data: TestStart) => void): this;
360
+ once(event: "test:stderr", listener: (data: TestStderr) => void): this;
361
+ once(event: "test:stdout", listener: (data: TestStdout) => void): this;
362
+ once(event: string, listener: (...args: any[]) => void): this;
363
+ prependListener(event: "test:diagnostic", listener: (data: DiagnosticData) => void): this;
364
+ prependListener(event: "test:fail", listener: (data: TestFail) => void): this;
365
+ prependListener(event: "test:pass", listener: (data: TestPass) => void): this;
366
+ prependListener(event: "test:plan", listener: (data: TestPlan) => void): this;
367
+ prependListener(event: "test:start", listener: (data: TestStart) => void): this;
368
+ prependListener(event: "test:stderr", listener: (data: TestStderr) => void): this;
369
+ prependListener(event: "test:stdout", listener: (data: TestStdout) => void): this;
370
+ prependListener(event: string, listener: (...args: any[]) => void): this;
371
+ prependOnceListener(event: "test:diagnostic", listener: (data: DiagnosticData) => void): this;
372
+ prependOnceListener(event: "test:fail", listener: (data: TestFail) => void): this;
373
+ prependOnceListener(event: "test:pass", listener: (data: TestPass) => void): this;
374
+ prependOnceListener(event: "test:plan", listener: (data: TestPlan) => void): this;
375
+ prependOnceListener(event: "test:start", listener: (data: TestStart) => void): this;
376
+ prependOnceListener(event: "test:stderr", listener: (data: TestStderr) => void): this;
377
+ prependOnceListener(event: "test:stdout", listener: (data: TestStdout) => void): this;
378
+ prependOnceListener(event: string, listener: (...args: any[]) => void): this;
379
+ }
380
+ /**
381
+ * An instance of `TestContext` is passed to each test function in order to
382
+ * interact with the test runner. However, the `TestContext` constructor is not
383
+ * exposed as part of the API.
384
+ * @since v18.0.0, v16.17.0
385
+ */
386
+ class TestContext {
387
+ /**
388
+ * This function is used to create a hook running before subtest of the current test.
389
+ * @param fn The hook function. If the hook uses callbacks, the callback function is passed as
390
+ * the second argument. Default: A no-op function.
391
+ * @param options Configuration options for the hook.
392
+ * @since v20.1.0
393
+ */
394
+ before: typeof before;
395
+ /**
396
+ * This function is used to create a hook running before each subtest of the current test.
397
+ * @param fn The hook function. If the hook uses callbacks, the callback function is passed as
398
+ * the second argument. Default: A no-op function.
399
+ * @param options Configuration options for the hook.
400
+ * @since v18.8.0
401
+ */
402
+ beforeEach: typeof beforeEach;
403
+ /**
404
+ * This function is used to create a hook that runs after the current test finishes.
405
+ * @param fn The hook function. If the hook uses callbacks, the callback function is passed as
406
+ * the second argument. Default: A no-op function.
407
+ * @param options Configuration options for the hook.
408
+ * @since v18.13.0
409
+ */
410
+ after: typeof after;
411
+ /**
412
+ * This function is used to create a hook running after each subtest of the current test.
413
+ * @param fn The hook function. If the hook uses callbacks, the callback function is passed as
414
+ * the second argument. Default: A no-op function.
415
+ * @param options Configuration options for the hook.
416
+ * @since v18.8.0
417
+ */
418
+ afterEach: typeof afterEach;
419
+ /**
420
+ * This function is used to write diagnostics to the output. Any diagnostic
421
+ * information is included at the end of the test's results. This function does
422
+ * not return a value.
423
+ *
424
+ * ```js
425
+ * test('top level test', (t) => {
426
+ * t.diagnostic('A diagnostic message');
427
+ * });
428
+ * ```
429
+ * @since v18.0.0, v16.17.0
430
+ * @param message Message to be reported.
431
+ */
432
+ diagnostic(message: string): void;
433
+ /**
434
+ * The name of the test.
435
+ * @since v18.8.0, v16.18.0
436
+ */
437
+ readonly name: string;
438
+ /**
439
+ * If `shouldRunOnlyTests` is truthy, the test context will only run tests that
440
+ * have the `only` option set. Otherwise, all tests are run. If Node.js was not
441
+ * started with the `--test-only` command-line option, this function is a
442
+ * no-op.
443
+ *
444
+ * ```js
445
+ * test('top level test', (t) => {
446
+ * // The test context can be set to run subtests with the 'only' option.
447
+ * t.runOnly(true);
448
+ * return Promise.all([
449
+ * t.test('this subtest is now skipped'),
450
+ * t.test('this subtest is run', { only: true }),
451
+ * ]);
452
+ * });
453
+ * ```
454
+ * @since v18.0.0, v16.17.0
455
+ * @param shouldRunOnlyTests Whether or not to run `only` tests.
456
+ */
457
+ runOnly(shouldRunOnlyTests: boolean): void;
458
+ /**
459
+ * ```js
460
+ * test('top level test', async (t) => {
461
+ * await fetch('some/uri', { signal: t.signal });
462
+ * });
463
+ * ```
464
+ * @since v18.7.0, v16.17.0
465
+ */
466
+ readonly signal: AbortSignal;
467
+ /**
468
+ * This function causes the test's output to indicate the test as skipped. If`message` is provided, it is included in the output. Calling `skip()` does
469
+ * not terminate execution of the test function. This function does not return a
470
+ * value.
471
+ *
472
+ * ```js
473
+ * test('top level test', (t) => {
474
+ * // Make sure to return here as well if the test contains additional logic.
475
+ * t.skip('this is skipped');
476
+ * });
477
+ * ```
478
+ * @since v18.0.0, v16.17.0
479
+ * @param message Optional skip message.
480
+ */
481
+ skip(message?: string): void;
482
+ /**
483
+ * This function adds a `TODO` directive to the test's output. If `message` is
484
+ * provided, it is included in the output. Calling `todo()` does not terminate
485
+ * execution of the test function. This function does not return a value.
486
+ *
487
+ * ```js
488
+ * test('top level test', (t) => {
489
+ * // This test is marked as `TODO`
490
+ * t.todo('this is a todo');
491
+ * });
492
+ * ```
493
+ * @since v18.0.0, v16.17.0
494
+ * @param message Optional `TODO` message.
495
+ */
496
+ todo(message?: string): void;
497
+ /**
498
+ * This function is used to create subtests under the current test. This function behaves in
499
+ * the same fashion as the top level {@link test} function.
500
+ * @since v18.0.0
501
+ * @param name The name of the test, which is displayed when reporting test results.
502
+ * Default: The `name` property of fn, or `'<anonymous>'` if `fn` does not have a name.
503
+ * @param options Configuration options for the test
504
+ * @param fn The function under test. This first argument to this function is a
505
+ * {@link TestContext} object. If the test uses callbacks, the callback function is
506
+ * passed as the second argument. Default: A no-op function.
507
+ * @returns A {@link Promise} resolved with `undefined` once the test completes.
508
+ */
509
+ test: typeof test;
510
+ /**
511
+ * Each test provides its own MockTracker instance.
512
+ */
513
+ readonly mock: MockTracker;
514
+ }
515
+ /**
516
+ * An instance of `SuiteContext` is passed to each suite function in order to
517
+ * interact with the test runner. However, the `SuiteContext` constructor is not
518
+ * exposed as part of the API.
519
+ * @since v18.7.0, v16.17.0
520
+ */
521
+ class SuiteContext {
522
+ /**
523
+ * The name of the suite.
524
+ * @since v18.8.0, v16.18.0
525
+ */
526
+ readonly name: string;
527
+ /**
528
+ * Can be used to abort test subtasks when the test has been aborted.
529
+ * @since v18.7.0, v16.17.0
530
+ */
531
+ readonly signal: AbortSignal;
532
+ }
533
+ interface TestOptions {
534
+ /**
535
+ * If a number is provided, then that many tests would run in parallel.
536
+ * If truthy, it would run (number of cpu cores - 1) tests in parallel.
537
+ * For subtests, it will be `Infinity` tests in parallel.
538
+ * If falsy, it would only run one test at a time.
539
+ * If unspecified, subtests inherit this value from their parent.
540
+ * @default false
541
+ */
542
+ concurrency?: number | boolean | undefined;
543
+ /**
544
+ * If truthy, and the test context is configured to run `only` tests, then this test will be
545
+ * run. Otherwise, the test is skipped.
546
+ * @default false
547
+ */
548
+ only?: boolean | undefined;
549
+ /**
550
+ * Allows aborting an in-progress test.
551
+ * @since v18.8.0
552
+ */
553
+ signal?: AbortSignal | undefined;
554
+ /**
555
+ * If truthy, the test is skipped. If a string is provided, that string is displayed in the
556
+ * test results as the reason for skipping the test.
557
+ * @default false
558
+ */
559
+ skip?: boolean | string | undefined;
560
+ /**
561
+ * A number of milliseconds the test will fail after. If unspecified, subtests inherit this
562
+ * value from their parent.
563
+ * @default Infinity
564
+ * @since v18.7.0
565
+ */
566
+ timeout?: number | undefined;
567
+ /**
568
+ * If truthy, the test marked as `TODO`. If a string is provided, that string is displayed in
569
+ * the test results as the reason why the test is `TODO`.
570
+ * @default false
571
+ */
572
+ todo?: boolean | string | undefined;
573
+ }
574
+ /**
575
+ * This function is used to create a hook running before running a suite.
576
+ *
577
+ * ```js
578
+ * describe('tests', async () => {
579
+ * before(() => console.log('about to run some test'));
580
+ * it('is a subtest', () => {
581
+ * assert.ok('some relevant assertion here');
582
+ * });
583
+ * });
584
+ * ```
585
+ * @since v18.8.0, v16.18.0
586
+ * @param [fn='A no-op function'] The hook function. If the hook uses callbacks, the callback function is passed as the second argument.
587
+ * @param options Configuration options for the hook. The following properties are supported:
588
+ */
589
+ function before(fn?: HookFn, options?: HookOptions): void;
590
+ /**
591
+ * This function is used to create a hook running after running a suite.
592
+ *
593
+ * ```js
594
+ * describe('tests', async () => {
595
+ * after(() => console.log('finished running tests'));
596
+ * it('is a subtest', () => {
597
+ * assert.ok('some relevant assertion here');
598
+ * });
599
+ * });
600
+ * ```
601
+ * @since v18.8.0, v16.18.0
602
+ * @param [fn='A no-op function'] The hook function. If the hook uses callbacks, the callback function is passed as the second argument.
603
+ * @param options Configuration options for the hook. The following properties are supported:
604
+ */
605
+ function after(fn?: HookFn, options?: HookOptions): void;
606
+ /**
607
+ * This function is used to create a hook running
608
+ * before each subtest of the current suite.
609
+ *
610
+ * ```js
611
+ * describe('tests', async () => {
612
+ * beforeEach(() => console.log('about to run a test'));
613
+ * it('is a subtest', () => {
614
+ * assert.ok('some relevant assertion here');
615
+ * });
616
+ * });
617
+ * ```
618
+ * @since v18.8.0, v16.18.0
619
+ * @param [fn='A no-op function'] The hook function. If the hook uses callbacks, the callback function is passed as the second argument.
620
+ * @param options Configuration options for the hook. The following properties are supported:
621
+ */
622
+ function beforeEach(fn?: HookFn, options?: HookOptions): void;
623
+ /**
624
+ * This function is used to create a hook running
625
+ * after each subtest of the current test.
626
+ *
627
+ * ```js
628
+ * describe('tests', async () => {
629
+ * afterEach(() => console.log('finished running a test'));
630
+ * it('is a subtest', () => {
631
+ * assert.ok('some relevant assertion here');
632
+ * });
633
+ * });
634
+ * ```
635
+ * @since v18.8.0, v16.18.0
636
+ * @param [fn='A no-op function'] The hook function. If the hook uses callbacks, the callback function is passed as the second argument.
637
+ * @param options Configuration options for the hook. The following properties are supported:
638
+ */
639
+ function afterEach(fn?: HookFn, options?: HookOptions): void;
640
+ /**
641
+ * The hook function. If the hook uses callbacks, the callback function is passed as the
642
+ * second argument.
643
+ */
644
+ type HookFn = (s: SuiteContext, done: (result?: any) => void) => any;
645
+ /**
646
+ * Configuration options for hooks.
647
+ * @since v18.8.0
648
+ */
649
+ interface HookOptions {
650
+ /**
651
+ * Allows aborting an in-progress hook.
652
+ */
653
+ signal?: AbortSignal | undefined;
654
+ /**
655
+ * A number of milliseconds the hook will fail after. If unspecified, subtests inherit this
656
+ * value from their parent.
657
+ * @default Infinity
658
+ */
659
+ timeout?: number | undefined;
660
+ }
661
+ interface MockFunctionOptions {
662
+ /**
663
+ * The number of times that the mock will use the behavior of `implementation`.
664
+ * Once the mock function has been called `times` times,
665
+ * it will automatically restore the behavior of `original`.
666
+ * This value must be an integer greater than zero.
667
+ * @default Infinity
668
+ */
669
+ times?: number | undefined;
670
+ }
671
+ interface MockMethodOptions extends MockFunctionOptions {
672
+ /**
673
+ * If `true`, `object[methodName]` is treated as a getter.
674
+ * This option cannot be used with the `setter` option.
675
+ */
676
+ getter?: boolean | undefined;
677
+ /**
678
+ * If `true`, `object[methodName]` is treated as a setter.
679
+ * This option cannot be used with the `getter` option.
680
+ */
681
+ setter?: boolean | undefined;
682
+ }
683
+ type Mock<F extends Function> = F & {
684
+ mock: MockFunctionContext<F>;
685
+ };
686
+ type NoOpFunction = (...args: any[]) => undefined;
687
+ type FunctionPropertyNames<T> = {
688
+ [K in keyof T]: T[K] extends Function ? K : never;
689
+ }[keyof T];
690
+ /**
691
+ * The `MockTracker` class is used to manage mocking functionality. The test runner
692
+ * module provides a top level `mock` export which is a `MockTracker` instance.
693
+ * Each test also provides its own `MockTracker` instance via the test context's`mock` property.
694
+ * @since v19.1.0, v18.13.0
695
+ */
696
+ class MockTracker {
697
+ /**
698
+ * This function is used to create a mock function.
699
+ *
700
+ * The following example creates a mock function that increments a counter by one
701
+ * on each invocation. The `times` option is used to modify the mock behavior such
702
+ * that the first two invocations add two to the counter instead of one.
703
+ *
704
+ * ```js
705
+ * test('mocks a counting function', (t) => {
706
+ * let cnt = 0;
707
+ *
708
+ * function addOne() {
709
+ * cnt++;
710
+ * return cnt;
711
+ * }
712
+ *
713
+ * function addTwo() {
714
+ * cnt += 2;
715
+ * return cnt;
716
+ * }
717
+ *
718
+ * const fn = t.mock.fn(addOne, addTwo, { times: 2 });
719
+ *
720
+ * assert.strictEqual(fn(), 2);
721
+ * assert.strictEqual(fn(), 4);
722
+ * assert.strictEqual(fn(), 5);
723
+ * assert.strictEqual(fn(), 6);
724
+ * });
725
+ * ```
726
+ * @since v19.1.0, v18.13.0
727
+ * @param [original='A no-op function'] An optional function to create a mock on.
728
+ * @param implementation An optional function used as the mock implementation for `original`. This is useful for creating mocks that exhibit one behavior for a specified number of calls and
729
+ * then restore the behavior of `original`.
730
+ * @param options Optional configuration options for the mock function. The following properties are supported:
731
+ * @return The mocked function. The mocked function contains a special `mock` property, which is an instance of {@link MockFunctionContext}, and can be used for inspecting and changing the
732
+ * behavior of the mocked function.
733
+ */
734
+ fn<F extends Function = NoOpFunction>(original?: F, options?: MockFunctionOptions): Mock<F>;
735
+ fn<F extends Function = NoOpFunction, Implementation extends Function = F>(
736
+ original?: F,
737
+ implementation?: Implementation,
738
+ options?: MockFunctionOptions,
739
+ ): Mock<F | Implementation>;
740
+ /**
741
+ * This function is used to create a mock on an existing object method. The
742
+ * following example demonstrates how a mock is created on an existing object
743
+ * method.
744
+ *
745
+ * ```js
746
+ * test('spies on an object method', (t) => {
747
+ * const number = {
748
+ * value: 5,
749
+ * subtract(a) {
750
+ * return this.value - a;
751
+ * },
752
+ * };
753
+ *
754
+ * t.mock.method(number, 'subtract');
755
+ * assert.strictEqual(number.subtract.mock.calls.length, 0);
756
+ * assert.strictEqual(number.subtract(3), 2);
757
+ * assert.strictEqual(number.subtract.mock.calls.length, 1);
758
+ *
759
+ * const call = number.subtract.mock.calls[0];
760
+ *
761
+ * assert.deepStrictEqual(call.arguments, [3]);
762
+ * assert.strictEqual(call.result, 2);
763
+ * assert.strictEqual(call.error, undefined);
764
+ * assert.strictEqual(call.target, undefined);
765
+ * assert.strictEqual(call.this, number);
766
+ * });
767
+ * ```
768
+ * @since v19.1.0, v18.13.0
769
+ * @param object The object whose method is being mocked.
770
+ * @param methodName The identifier of the method on `object` to mock. If `object[methodName]` is not a function, an error is thrown.
771
+ * @param implementation An optional function used as the mock implementation for `object[methodName]`.
772
+ * @param options Optional configuration options for the mock method. The following properties are supported:
773
+ * @return The mocked method. The mocked method contains a special `mock` property, which is an instance of {@link MockFunctionContext}, and can be used for inspecting and changing the
774
+ * behavior of the mocked method.
775
+ */
776
+ method<
777
+ MockedObject extends object,
778
+ MethodName extends FunctionPropertyNames<MockedObject>,
779
+ >(
780
+ object: MockedObject,
781
+ methodName: MethodName,
782
+ options?: MockFunctionOptions,
783
+ ): MockedObject[MethodName] extends Function ? Mock<MockedObject[MethodName]>
784
+ : never;
785
+ method<
786
+ MockedObject extends object,
787
+ MethodName extends FunctionPropertyNames<MockedObject>,
788
+ Implementation extends Function,
789
+ >(
790
+ object: MockedObject,
791
+ methodName: MethodName,
792
+ implementation: Implementation,
793
+ options?: MockFunctionOptions,
794
+ ): MockedObject[MethodName] extends Function ? Mock<MockedObject[MethodName] | Implementation>
795
+ : never;
796
+ method<MockedObject extends object>(
797
+ object: MockedObject,
798
+ methodName: keyof MockedObject,
799
+ options: MockMethodOptions,
800
+ ): Mock<Function>;
801
+ method<MockedObject extends object>(
802
+ object: MockedObject,
803
+ methodName: keyof MockedObject,
804
+ implementation: Function,
805
+ options: MockMethodOptions,
806
+ ): Mock<Function>;
807
+
808
+ /**
809
+ * This function is syntax sugar for `MockTracker.method` with `options.getter`set to `true`.
810
+ * @since v19.3.0, v18.13.0
811
+ */
812
+ getter<
813
+ MockedObject extends object,
814
+ MethodName extends keyof MockedObject,
815
+ >(
816
+ object: MockedObject,
817
+ methodName: MethodName,
818
+ options?: MockFunctionOptions,
819
+ ): Mock<() => MockedObject[MethodName]>;
820
+ getter<
821
+ MockedObject extends object,
822
+ MethodName extends keyof MockedObject,
823
+ Implementation extends Function,
824
+ >(
825
+ object: MockedObject,
826
+ methodName: MethodName,
827
+ implementation?: Implementation,
828
+ options?: MockFunctionOptions,
829
+ ): Mock<(() => MockedObject[MethodName]) | Implementation>;
830
+ /**
831
+ * This function is syntax sugar for `MockTracker.method` with `options.setter`set to `true`.
832
+ * @since v19.3.0, v18.13.0
833
+ */
834
+ setter<
835
+ MockedObject extends object,
836
+ MethodName extends keyof MockedObject,
837
+ >(
838
+ object: MockedObject,
839
+ methodName: MethodName,
840
+ options?: MockFunctionOptions,
841
+ ): Mock<(value: MockedObject[MethodName]) => void>;
842
+ setter<
843
+ MockedObject extends object,
844
+ MethodName extends keyof MockedObject,
845
+ Implementation extends Function,
846
+ >(
847
+ object: MockedObject,
848
+ methodName: MethodName,
849
+ implementation?: Implementation,
850
+ options?: MockFunctionOptions,
851
+ ): Mock<((value: MockedObject[MethodName]) => void) | Implementation>;
852
+ /**
853
+ * This function restores the default behavior of all mocks that were previously
854
+ * created by this `MockTracker` and disassociates the mocks from the`MockTracker` instance. Once disassociated, the mocks can still be used, but the`MockTracker` instance can no longer be
855
+ * used to reset their behavior or
856
+ * otherwise interact with them.
857
+ *
858
+ * After each test completes, this function is called on the test context's`MockTracker`. If the global `MockTracker` is used extensively, calling this
859
+ * function manually is recommended.
860
+ * @since v19.1.0, v18.13.0
861
+ */
862
+ reset(): void;
863
+ /**
864
+ * This function restores the default behavior of all mocks that were previously
865
+ * created by this `MockTracker`. Unlike `mock.reset()`, `mock.restoreAll()` does
866
+ * not disassociate the mocks from the `MockTracker` instance.
867
+ * @since v19.1.0, v18.13.0
868
+ */
869
+ restoreAll(): void;
870
+ timers: MockTimers;
871
+ }
872
+ const mock: MockTracker;
873
+ interface MockFunctionCall<
874
+ F extends Function,
875
+ ReturnType = F extends (...args: any) => infer T ? T
876
+ : F extends abstract new(...args: any) => infer T ? T
877
+ : unknown,
878
+ Args = F extends (...args: infer Y) => any ? Y
879
+ : F extends abstract new(...args: infer Y) => any ? Y
880
+ : unknown[],
881
+ > {
882
+ /**
883
+ * An array of the arguments passed to the mock function.
884
+ */
885
+ arguments: Args;
886
+ /**
887
+ * If the mocked function threw then this property contains the thrown value.
888
+ */
889
+ error: unknown | undefined;
890
+ /**
891
+ * The value returned by the mocked function.
892
+ *
893
+ * If the mocked function threw, it will be `undefined`.
894
+ */
895
+ result: ReturnType | undefined;
896
+ /**
897
+ * An `Error` object whose stack can be used to determine the callsite of the mocked function invocation.
898
+ */
899
+ stack: Error;
900
+ /**
901
+ * If the mocked function is a constructor, this field contains the class being constructed.
902
+ * Otherwise this will be `undefined`.
903
+ */
904
+ target: F extends abstract new(...args: any) => any ? F : undefined;
905
+ /**
906
+ * The mocked function's `this` value.
907
+ */
908
+ this: unknown;
909
+ }
910
+ /**
911
+ * The `MockFunctionContext` class is used to inspect or manipulate the behavior of
912
+ * mocks created via the `MockTracker` APIs.
913
+ * @since v19.1.0, v18.13.0
914
+ */
915
+ class MockFunctionContext<F extends Function> {
916
+ /**
917
+ * A getter that returns a copy of the internal array used to track calls to the
918
+ * mock. Each entry in the array is an object with the following properties.
919
+ * @since v19.1.0, v18.13.0
920
+ */
921
+ readonly calls: Array<MockFunctionCall<F>>;
922
+ /**
923
+ * This function returns the number of times that this mock has been invoked. This
924
+ * function is more efficient than checking `ctx.calls.length` because `ctx.calls`is a getter that creates a copy of the internal call tracking array.
925
+ * @since v19.1.0, v18.13.0
926
+ * @return The number of times that this mock has been invoked.
927
+ */
928
+ callCount(): number;
929
+ /**
930
+ * This function is used to change the behavior of an existing mock.
931
+ *
932
+ * The following example creates a mock function using `t.mock.fn()`, calls the
933
+ * mock function, and then changes the mock implementation to a different function.
934
+ *
935
+ * ```js
936
+ * test('changes a mock behavior', (t) => {
937
+ * let cnt = 0;
938
+ *
939
+ * function addOne() {
940
+ * cnt++;
941
+ * return cnt;
942
+ * }
943
+ *
944
+ * function addTwo() {
945
+ * cnt += 2;
946
+ * return cnt;
947
+ * }
948
+ *
949
+ * const fn = t.mock.fn(addOne);
950
+ *
951
+ * assert.strictEqual(fn(), 1);
952
+ * fn.mock.mockImplementation(addTwo);
953
+ * assert.strictEqual(fn(), 3);
954
+ * assert.strictEqual(fn(), 5);
955
+ * });
956
+ * ```
957
+ * @since v19.1.0, v18.13.0
958
+ * @param implementation The function to be used as the mock's new implementation.
959
+ */
960
+ mockImplementation(implementation: Function): void;
961
+ /**
962
+ * This function is used to change the behavior of an existing mock for a single
963
+ * invocation. Once invocation `onCall` has occurred, the mock will revert to
964
+ * whatever behavior it would have used had `mockImplementationOnce()` not been
965
+ * called.
966
+ *
967
+ * The following example creates a mock function using `t.mock.fn()`, calls the
968
+ * mock function, changes the mock implementation to a different function for the
969
+ * next invocation, and then resumes its previous behavior.
970
+ *
971
+ * ```js
972
+ * test('changes a mock behavior once', (t) => {
973
+ * let cnt = 0;
974
+ *
975
+ * function addOne() {
976
+ * cnt++;
977
+ * return cnt;
978
+ * }
979
+ *
980
+ * function addTwo() {
981
+ * cnt += 2;
982
+ * return cnt;
983
+ * }
984
+ *
985
+ * const fn = t.mock.fn(addOne);
986
+ *
987
+ * assert.strictEqual(fn(), 1);
988
+ * fn.mock.mockImplementationOnce(addTwo);
989
+ * assert.strictEqual(fn(), 3);
990
+ * assert.strictEqual(fn(), 4);
991
+ * });
992
+ * ```
993
+ * @since v19.1.0, v18.13.0
994
+ * @param implementation The function to be used as the mock's implementation for the invocation number specified by `onCall`.
995
+ * @param onCall The invocation number that will use `implementation`. If the specified invocation has already occurred then an exception is thrown.
996
+ */
997
+ mockImplementationOnce(implementation: Function, onCall?: number): void;
998
+ /**
999
+ * Resets the call history of the mock function.
1000
+ * @since v19.3.0, v18.13.0
1001
+ */
1002
+ resetCalls(): void;
1003
+ /**
1004
+ * Resets the implementation of the mock function to its original behavior. The
1005
+ * mock can still be used after calling this function.
1006
+ * @since v19.1.0, v18.13.0
1007
+ */
1008
+ restore(): void;
1009
+ }
1010
+ type Timer = "setInterval" | "clearInterval" | "setTimeout" | "clearTimeout";
1011
+ /**
1012
+ * Mocking timers is a technique commonly used in software testing to simulate and
1013
+ * control the behavior of timers, such as `setInterval` and `setTimeout`,
1014
+ * without actually waiting for the specified time intervals.
1015
+ *
1016
+ * The `MockTracker` provides a top-level `timers` export
1017
+ * which is a `MockTimers` instance.
1018
+ * @since v20.4.0
1019
+ * @experimental
1020
+ */
1021
+ class MockTimers {
1022
+ /**
1023
+ * Enables timer mocking for the specified timers.
1024
+ *
1025
+ * **Note:** When you enable mocking for a specific timer, its associated
1026
+ * clear function will also be implicitly mocked.
1027
+ *
1028
+ * Example usage:
1029
+ *
1030
+ * ```js
1031
+ * import { mock } from 'node:test';
1032
+ * mock.timers.enable(['setInterval']);
1033
+ * ```
1034
+ *
1035
+ * The above example enables mocking for the `setInterval` timer and
1036
+ * implicitly mocks the `clearInterval` function. Only the `setInterval`and `clearInterval` functions from `node:timers`,`node:timers/promises`, and`globalThis` will be mocked.
1037
+ *
1038
+ * Alternatively, if you call `mock.timers.enable()` without any parameters:
1039
+ *
1040
+ * All timers (`'setInterval'`, `'clearInterval'`, `'setTimeout'`, and `'clearTimeout'`)
1041
+ * will be mocked. The `setInterval`, `clearInterval`, `setTimeout`, and `clearTimeout`functions from `node:timers`, `node:timers/promises`,
1042
+ * and `globalThis` will be mocked.
1043
+ * @since v20.4.0
1044
+ */
1045
+ enable(timers?: Timer[]): void;
1046
+ /**
1047
+ * This function restores the default behavior of all mocks that were previously
1048
+ * created by this `MockTimers` instance and disassociates the mocks
1049
+ * from the `MockTracker` instance.
1050
+ *
1051
+ * **Note:** After each test completes, this function is called on
1052
+ * the test context's `MockTracker`.
1053
+ *
1054
+ * ```js
1055
+ * import { mock } from 'node:test';
1056
+ * mock.timers.reset();
1057
+ * ```
1058
+ * @since v20.4.0
1059
+ */
1060
+ reset(): void;
1061
+ /**
1062
+ * Advances time for all mocked timers.
1063
+ *
1064
+ * **Note:** This diverges from how `setTimeout` in Node.js behaves and accepts
1065
+ * only positive numbers. In Node.js, `setTimeout` with negative numbers is
1066
+ * only supported for web compatibility reasons.
1067
+ *
1068
+ * The following example mocks a `setTimeout` function and
1069
+ * by using `.tick` advances in
1070
+ * time triggering all pending timers.
1071
+ *
1072
+ * ```js
1073
+ * import assert from 'node:assert';
1074
+ * import { test } from 'node:test';
1075
+ *
1076
+ * test('mocks setTimeout to be executed synchronously without having to actually wait for it', (context) => {
1077
+ * const fn = context.mock.fn();
1078
+ *
1079
+ * context.mock.timers.enable(['setTimeout']);
1080
+ *
1081
+ * setTimeout(fn, 9999);
1082
+ *
1083
+ * assert.strictEqual(fn.mock.callCount(), 0);
1084
+ *
1085
+ * // Advance in time
1086
+ * context.mock.timers.tick(9999);
1087
+ *
1088
+ * assert.strictEqual(fn.mock.callCount(), 1);
1089
+ * });
1090
+ * ```
1091
+ *
1092
+ * Alternativelly, the `.tick` function can be called many times
1093
+ *
1094
+ * ```js
1095
+ * import assert from 'node:assert';
1096
+ * import { test } from 'node:test';
1097
+ *
1098
+ * test('mocks setTimeout to be executed synchronously without having to actually wait for it', (context) => {
1099
+ * const fn = context.mock.fn();
1100
+ * context.mock.timers.enable(['setTimeout']);
1101
+ * const nineSecs = 9000;
1102
+ * setTimeout(fn, nineSecs);
1103
+ *
1104
+ * const twoSeconds = 3000;
1105
+ * context.mock.timers.tick(twoSeconds);
1106
+ * context.mock.timers.tick(twoSeconds);
1107
+ * context.mock.timers.tick(twoSeconds);
1108
+ *
1109
+ * assert.strictEqual(fn.mock.callCount(), 1);
1110
+ * });
1111
+ * ```
1112
+ * @since v20.4.0
1113
+ */
1114
+ tick(milliseconds: number): void;
1115
+ /**
1116
+ * Triggers all pending mocked timers immediately.
1117
+ *
1118
+ * The example below triggers all pending timers immediately,
1119
+ * causing them to execute without any delay.
1120
+ *
1121
+ * ```js
1122
+ * import assert from 'node:assert';
1123
+ * import { test } from 'node:test';
1124
+ *
1125
+ * test('runAll functions following the given order', (context) => {
1126
+ * context.mock.timers.enable(['setTimeout']);
1127
+ * const results = [];
1128
+ * setTimeout(() => results.push(1), 9999);
1129
+ *
1130
+ * // Notice that if both timers have the same timeout,
1131
+ * // the order of execution is guaranteed
1132
+ * setTimeout(() => results.push(3), 8888);
1133
+ * setTimeout(() => results.push(2), 8888);
1134
+ *
1135
+ * assert.deepStrictEqual(results, []);
1136
+ *
1137
+ * context.mock.timers.runAll();
1138
+ *
1139
+ * assert.deepStrictEqual(results, [3, 2, 1]);
1140
+ * });
1141
+ * ```
1142
+ *
1143
+ * **Note:** The `runAll()` function is specifically designed for
1144
+ * triggering timers in the context of timer mocking.
1145
+ * It does not have any effect on real-time system
1146
+ * clocks or actual timers outside of the mocking environment.
1147
+ * @since v20.4.0
1148
+ */
1149
+ runAll(): void;
1150
+ /**
1151
+ * Calls {@link MockTimers.reset()}.
1152
+ */
1153
+ [Symbol.dispose](): void;
1154
+ }
1155
+ export {
1156
+ after,
1157
+ afterEach,
1158
+ before,
1159
+ beforeEach,
1160
+ describe,
1161
+ it,
1162
+ Mock,
1163
+ mock,
1164
+ only,
1165
+ run,
1166
+ skip,
1167
+ test,
1168
+ test as default,
1169
+ todo,
1170
+ };
1171
+ }
1172
+
1173
+ interface TestLocationInfo {
1174
+ /**
1175
+ * The column number where the test is defined, or
1176
+ * `undefined` if the test was run through the REPL.
1177
+ */
1178
+ column?: number;
1179
+ /**
1180
+ * The path of the test file, `undefined` if test is not ran through a file.
1181
+ */
1182
+ file?: string;
1183
+ /**
1184
+ * The line number where the test is defined, or
1185
+ * `undefined` if the test was run through the REPL.
1186
+ */
1187
+ line?: number;
1188
+ }
1189
+ interface DiagnosticData extends TestLocationInfo {
1190
+ /**
1191
+ * The diagnostic message.
1192
+ */
1193
+ message: string;
1194
+ /**
1195
+ * The nesting level of the test.
1196
+ */
1197
+ nesting: number;
1198
+ }
1199
+ interface TestFail extends TestLocationInfo {
1200
+ /**
1201
+ * Additional execution metadata.
1202
+ */
1203
+ details: {
1204
+ /**
1205
+ * The duration of the test in milliseconds.
1206
+ */
1207
+ duration_ms: number;
1208
+ /**
1209
+ * The error thrown by the test.
1210
+ */
1211
+ error: Error;
1212
+ /**
1213
+ * The type of the test, used to denote whether this is a suite.
1214
+ * @since 20.0.0, 19.9.0, 18.17.0
1215
+ */
1216
+ type?: "suite";
1217
+ };
1218
+ /**
1219
+ * The test name.
1220
+ */
1221
+ name: string;
1222
+ /**
1223
+ * The nesting level of the test.
1224
+ */
1225
+ nesting: number;
1226
+ /**
1227
+ * The ordinal number of the test.
1228
+ */
1229
+ testNumber: number;
1230
+ /**
1231
+ * Present if `context.todo` is called.
1232
+ */
1233
+ todo?: string | boolean;
1234
+ /**
1235
+ * Present if `context.skip` is called.
1236
+ */
1237
+ skip?: string | boolean;
1238
+ }
1239
+ interface TestPass extends TestLocationInfo {
1240
+ /**
1241
+ * Additional execution metadata.
1242
+ */
1243
+ details: {
1244
+ /**
1245
+ * The duration of the test in milliseconds.
1246
+ */
1247
+ duration_ms: number;
1248
+ /**
1249
+ * The type of the test, used to denote whether this is a suite.
1250
+ * @since 20.0.0, 19.9.0, 18.17.0
1251
+ */
1252
+ type?: "suite";
1253
+ };
1254
+ /**
1255
+ * The test name.
1256
+ */
1257
+ name: string;
1258
+ /**
1259
+ * The nesting level of the test.
1260
+ */
1261
+ nesting: number;
1262
+ /**
1263
+ * The ordinal number of the test.
1264
+ */
1265
+ testNumber: number;
1266
+ /**
1267
+ * Present if `context.todo` is called.
1268
+ */
1269
+ todo?: string | boolean;
1270
+ /**
1271
+ * Present if `context.skip` is called.
1272
+ */
1273
+ skip?: string | boolean;
1274
+ }
1275
+ interface TestPlan extends TestLocationInfo {
1276
+ /**
1277
+ * The nesting level of the test.
1278
+ */
1279
+ nesting: number;
1280
+ /**
1281
+ * The number of subtests that have ran.
1282
+ */
1283
+ count: number;
1284
+ }
1285
+ interface TestStart extends TestLocationInfo {
1286
+ /**
1287
+ * The test name.
1288
+ */
1289
+ name: string;
1290
+ /**
1291
+ * The nesting level of the test.
1292
+ */
1293
+ nesting: number;
1294
+ }
1295
+ interface TestStderr extends TestLocationInfo {
1296
+ /**
1297
+ * The message written to `stderr`
1298
+ */
1299
+ message: string;
1300
+ }
1301
+ interface TestStdout extends TestLocationInfo {
1302
+ /**
1303
+ * The message written to `stdout`
1304
+ */
1305
+ message: string;
1306
+ }
1307
+ interface TestEnqueue extends TestLocationInfo {
1308
+ /**
1309
+ * The test name
1310
+ */
1311
+ name: string;
1312
+ /**
1313
+ * The nesting level of the test.
1314
+ */
1315
+ nesting: number;
1316
+ }
1317
+ interface TestDequeue extends TestLocationInfo {
1318
+ /**
1319
+ * The test name
1320
+ */
1321
+ name: string;
1322
+ /**
1323
+ * The nesting level of the test.
1324
+ */
1325
+ nesting: number;
1326
+ }
1327
+
1328
+ /**
1329
+ * The `node:test/reporters` module exposes the builtin-reporters for `node:test`.
1330
+ * To access it:
1331
+ *
1332
+ * ```js
1333
+ * import test from 'node:test/reporters';
1334
+ * ```
1335
+ *
1336
+ * This module is only available under the `node:` scheme. The following will not
1337
+ * work:
1338
+ *
1339
+ * ```js
1340
+ * import test from 'test/reporters';
1341
+ * ```
1342
+ * @since v19.9.0
1343
+ * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/test/reporters.js)
1344
+ */
1345
+ declare module "node:test/reporters" {
1346
+ import { Transform } from "node:stream";
1347
+
1348
+ type TestEvent =
1349
+ | { type: "test:diagnostic"; data: DiagnosticData }
1350
+ | { type: "test:fail"; data: TestFail }
1351
+ | { type: "test:pass"; data: TestPass }
1352
+ | { type: "test:plan"; data: TestPlan }
1353
+ | { type: "test:start"; data: TestStart }
1354
+ | { type: "test:stderr"; data: TestStderr }
1355
+ | { type: "test:stdout"; data: TestStdout }
1356
+ | { type: "test:enqueue"; data: TestEnqueue }
1357
+ | { type: "test:dequeue"; data: TestDequeue }
1358
+ | { type: "test:watch:drained" };
1359
+ type TestEventGenerator = AsyncGenerator<TestEvent, void>;
1360
+
1361
+ /**
1362
+ * The `dot` reporter outputs the test results in a compact format,
1363
+ * where each passing test is represented by a `.`,
1364
+ * and each failing test is represented by a `X`.
1365
+ */
1366
+ function dot(source: TestEventGenerator): AsyncGenerator<"\n" | "." | "X", void>;
1367
+ /**
1368
+ * The `tap` reporter outputs the test results in the [TAP](https://testanything.org/) format.
1369
+ */
1370
+ function tap(source: TestEventGenerator): AsyncGenerator<string, void>;
1371
+ /**
1372
+ * The `spec` reporter outputs the test results in a human-readable format.
1373
+ */
1374
+ class Spec extends Transform {
1375
+ constructor();
1376
+ }
1377
+ /**
1378
+ * The `junit` reporter outputs test results in a jUnit XML format
1379
+ */
1380
+ function junit(source: TestEventGenerator): AsyncGenerator<string, void>;
1381
+ export { dot, junit, Spec as spec, tap, TestEvent };
1382
+ }