rahad-media-downloader 2.1.12 → 2.1.13

Sign up to get free protection for your applications and to get access to all the features.
Files changed (232) hide show
  1. package/.cache/replit/modules/nodejs-20.res +1 -0
  2. package/.cache/replit/modules/replit.res +1 -0
  3. package/.cache/typescript/5.4/node_modules/.package-lock.json +185 -0
  4. package/.cache/typescript/5.4/node_modules/@types/caseless/LICENSE +21 -0
  5. package/.cache/typescript/5.4/node_modules/@types/caseless/README.md +48 -0
  6. package/.cache/typescript/5.4/node_modules/@types/caseless/index.d.ts +29 -0
  7. package/.cache/typescript/5.4/node_modules/@types/caseless/package.json +35 -0
  8. package/.cache/typescript/5.4/node_modules/@types/domhandler/LICENSE +21 -0
  9. package/.cache/typescript/5.4/node_modules/@types/domhandler/README.md +92 -0
  10. package/.cache/typescript/5.4/node_modules/@types/domhandler/index.d.ts +73 -0
  11. package/.cache/typescript/5.4/node_modules/@types/domhandler/package.json +25 -0
  12. package/.cache/typescript/5.4/node_modules/@types/domutils/LICENSE +21 -0
  13. package/.cache/typescript/5.4/node_modules/@types/domutils/README.md +15 -0
  14. package/.cache/typescript/5.4/node_modules/@types/domutils/index.d.ts +124 -0
  15. package/.cache/typescript/5.4/node_modules/@types/domutils/package.json +27 -0
  16. package/.cache/typescript/5.4/node_modules/@types/htmlparser2/LICENSE +21 -0
  17. package/.cache/typescript/5.4/node_modules/@types/htmlparser2/README.md +15 -0
  18. package/.cache/typescript/5.4/node_modules/@types/htmlparser2/index.d.ts +120 -0
  19. package/.cache/typescript/5.4/node_modules/@types/htmlparser2/package.json +45 -0
  20. package/.cache/typescript/5.4/node_modules/@types/node/LICENSE +21 -0
  21. package/.cache/typescript/5.4/node_modules/@types/node/README.md +15 -0
  22. package/.cache/typescript/5.4/node_modules/@types/node/assert/strict.d.ts +8 -0
  23. package/.cache/typescript/5.4/node_modules/@types/node/assert.d.ts +1040 -0
  24. package/.cache/typescript/5.4/node_modules/@types/node/async_hooks.d.ts +541 -0
  25. package/.cache/typescript/5.4/node_modules/@types/node/buffer.d.ts +2363 -0
  26. package/.cache/typescript/5.4/node_modules/@types/node/child_process.d.ts +1542 -0
  27. package/.cache/typescript/5.4/node_modules/@types/node/cluster.d.ts +578 -0
  28. package/.cache/typescript/5.4/node_modules/@types/node/console.d.ts +452 -0
  29. package/.cache/typescript/5.4/node_modules/@types/node/constants.d.ts +19 -0
  30. package/.cache/typescript/5.4/node_modules/@types/node/crypto.d.ts +4522 -0
  31. package/.cache/typescript/5.4/node_modules/@types/node/dgram.d.ts +596 -0
  32. package/.cache/typescript/5.4/node_modules/@types/node/diagnostics_channel.d.ts +545 -0
  33. package/.cache/typescript/5.4/node_modules/@types/node/dns/promises.d.ts +473 -0
  34. package/.cache/typescript/5.4/node_modules/@types/node/dns.d.ts +853 -0
  35. package/.cache/typescript/5.4/node_modules/@types/node/dom-events.d.ts +124 -0
  36. package/.cache/typescript/5.4/node_modules/@types/node/domain.d.ts +170 -0
  37. package/.cache/typescript/5.4/node_modules/@types/node/events.d.ts +884 -0
  38. package/.cache/typescript/5.4/node_modules/@types/node/fs/promises.d.ts +1245 -0
  39. package/.cache/typescript/5.4/node_modules/@types/node/fs.d.ts +4317 -0
  40. package/.cache/typescript/5.4/node_modules/@types/node/globals.d.ts +411 -0
  41. package/.cache/typescript/5.4/node_modules/@types/node/globals.global.d.ts +1 -0
  42. package/.cache/typescript/5.4/node_modules/@types/node/http.d.ts +1889 -0
  43. package/.cache/typescript/5.4/node_modules/@types/node/http2.d.ts +2418 -0
  44. package/.cache/typescript/5.4/node_modules/@types/node/https.d.ts +550 -0
  45. package/.cache/typescript/5.4/node_modules/@types/node/index.d.ts +89 -0
  46. package/.cache/typescript/5.4/node_modules/@types/node/inspector.d.ts +2746 -0
  47. package/.cache/typescript/5.4/node_modules/@types/node/module.d.ts +315 -0
  48. package/.cache/typescript/5.4/node_modules/@types/node/net.d.ts +996 -0
  49. package/.cache/typescript/5.4/node_modules/@types/node/os.d.ts +495 -0
  50. package/.cache/typescript/5.4/node_modules/@types/node/package.json +217 -0
  51. package/.cache/typescript/5.4/node_modules/@types/node/path.d.ts +191 -0
  52. package/.cache/typescript/5.4/node_modules/@types/node/perf_hooks.d.ts +645 -0
  53. package/.cache/typescript/5.4/node_modules/@types/node/process.d.ts +1747 -0
  54. package/.cache/typescript/5.4/node_modules/@types/node/punycode.d.ts +117 -0
  55. package/.cache/typescript/5.4/node_modules/@types/node/querystring.d.ts +153 -0
  56. package/.cache/typescript/5.4/node_modules/@types/node/readline/promises.d.ts +150 -0
  57. package/.cache/typescript/5.4/node_modules/@types/node/readline.d.ts +540 -0
  58. package/.cache/typescript/5.4/node_modules/@types/node/repl.d.ts +430 -0
  59. package/.cache/typescript/5.4/node_modules/@types/node/sea.d.ts +153 -0
  60. package/.cache/typescript/5.4/node_modules/@types/node/stream/consumers.d.ts +12 -0
  61. package/.cache/typescript/5.4/node_modules/@types/node/stream/promises.d.ts +83 -0
  62. package/.cache/typescript/5.4/node_modules/@types/node/stream/web.d.ts +367 -0
  63. package/.cache/typescript/5.4/node_modules/@types/node/stream.d.ts +1707 -0
  64. package/.cache/typescript/5.4/node_modules/@types/node/string_decoder.d.ts +67 -0
  65. package/.cache/typescript/5.4/node_modules/@types/node/test.d.ts +1470 -0
  66. package/.cache/typescript/5.4/node_modules/@types/node/timers/promises.d.ts +97 -0
  67. package/.cache/typescript/5.4/node_modules/@types/node/timers.d.ts +240 -0
  68. package/.cache/typescript/5.4/node_modules/@types/node/tls.d.ts +1217 -0
  69. package/.cache/typescript/5.4/node_modules/@types/node/trace_events.d.ts +197 -0
  70. package/.cache/typescript/5.4/node_modules/@types/node/tty.d.ts +208 -0
  71. package/.cache/typescript/5.4/node_modules/@types/node/url.d.ts +944 -0
  72. package/.cache/typescript/5.4/node_modules/@types/node/util.d.ts +2276 -0
  73. package/.cache/typescript/5.4/node_modules/@types/node/v8.d.ts +764 -0
  74. package/.cache/typescript/5.4/node_modules/@types/node/vm.d.ts +921 -0
  75. package/.cache/typescript/5.4/node_modules/@types/node/wasi.d.ts +181 -0
  76. package/.cache/typescript/5.4/node_modules/@types/node/worker_threads.d.ts +691 -0
  77. package/.cache/typescript/5.4/node_modules/@types/node/zlib.d.ts +530 -0
  78. package/.cache/typescript/5.4/node_modules/@types/node-fetch/LICENSE +21 -0
  79. package/.cache/typescript/5.4/node_modules/@types/node-fetch/README.md +15 -0
  80. package/.cache/typescript/5.4/node_modules/@types/node-fetch/externals.d.ts +32 -0
  81. package/.cache/typescript/5.4/node_modules/@types/node-fetch/index.d.ts +238 -0
  82. package/.cache/typescript/5.4/node_modules/@types/node-fetch/package.json +83 -0
  83. package/.cache/typescript/5.4/node_modules/@types/qs/LICENSE +21 -0
  84. package/.cache/typescript/5.4/node_modules/@types/qs/README.md +15 -0
  85. package/.cache/typescript/5.4/node_modules/@types/qs/index.d.ts +79 -0
  86. package/.cache/typescript/5.4/node_modules/@types/qs/package.json +65 -0
  87. package/.cache/typescript/5.4/node_modules/@types/request/LICENSE +21 -0
  88. package/.cache/typescript/5.4/node_modules/@types/request/README.md +15 -0
  89. package/.cache/typescript/5.4/node_modules/@types/request/index.d.ts +395 -0
  90. package/.cache/typescript/5.4/node_modules/@types/request/node_modules/form-data/License +19 -0
  91. package/.cache/typescript/5.4/node_modules/@types/request/node_modules/form-data/README.md +350 -0
  92. package/.cache/typescript/5.4/node_modules/@types/request/node_modules/form-data/README.md.bak +350 -0
  93. package/.cache/typescript/5.4/node_modules/@types/request/node_modules/form-data/index.d.ts +51 -0
  94. package/.cache/typescript/5.4/node_modules/@types/request/node_modules/form-data/lib/browser.js +2 -0
  95. package/.cache/typescript/5.4/node_modules/@types/request/node_modules/form-data/lib/form_data.js +483 -0
  96. package/.cache/typescript/5.4/node_modules/@types/request/node_modules/form-data/lib/populate.js +10 -0
  97. package/.cache/typescript/5.4/node_modules/@types/request/node_modules/form-data/package.json +68 -0
  98. package/.cache/typescript/5.4/node_modules/@types/request/package.json +70 -0
  99. package/.cache/typescript/5.4/node_modules/@types/tough-cookie/LICENSE +21 -0
  100. package/.cache/typescript/5.4/node_modules/@types/tough-cookie/README.md +15 -0
  101. package/.cache/typescript/5.4/node_modules/@types/tough-cookie/index.d.ts +321 -0
  102. package/.cache/typescript/5.4/node_modules/@types/tough-cookie/package.json +35 -0
  103. package/.cache/typescript/5.4/node_modules/asynckit/LICENSE +21 -0
  104. package/.cache/typescript/5.4/node_modules/asynckit/README.md +233 -0
  105. package/.cache/typescript/5.4/node_modules/asynckit/bench.js +76 -0
  106. package/.cache/typescript/5.4/node_modules/asynckit/index.js +6 -0
  107. package/.cache/typescript/5.4/node_modules/asynckit/lib/abort.js +29 -0
  108. package/.cache/typescript/5.4/node_modules/asynckit/lib/async.js +34 -0
  109. package/.cache/typescript/5.4/node_modules/asynckit/lib/defer.js +26 -0
  110. package/.cache/typescript/5.4/node_modules/asynckit/lib/iterate.js +75 -0
  111. package/.cache/typescript/5.4/node_modules/asynckit/lib/readable_asynckit.js +91 -0
  112. package/.cache/typescript/5.4/node_modules/asynckit/lib/readable_parallel.js +25 -0
  113. package/.cache/typescript/5.4/node_modules/asynckit/lib/readable_serial.js +25 -0
  114. package/.cache/typescript/5.4/node_modules/asynckit/lib/readable_serial_ordered.js +29 -0
  115. package/.cache/typescript/5.4/node_modules/asynckit/lib/state.js +37 -0
  116. package/.cache/typescript/5.4/node_modules/asynckit/lib/streamify.js +141 -0
  117. package/.cache/typescript/5.4/node_modules/asynckit/lib/terminator.js +29 -0
  118. package/.cache/typescript/5.4/node_modules/asynckit/package.json +63 -0
  119. package/.cache/typescript/5.4/node_modules/asynckit/parallel.js +43 -0
  120. package/.cache/typescript/5.4/node_modules/asynckit/serial.js +17 -0
  121. package/.cache/typescript/5.4/node_modules/asynckit/serialOrdered.js +75 -0
  122. package/.cache/typescript/5.4/node_modules/asynckit/stream.js +21 -0
  123. package/.cache/typescript/5.4/node_modules/combined-stream/License +19 -0
  124. package/.cache/typescript/5.4/node_modules/combined-stream/Readme.md +138 -0
  125. package/.cache/typescript/5.4/node_modules/combined-stream/lib/combined_stream.js +208 -0
  126. package/.cache/typescript/5.4/node_modules/combined-stream/package.json +25 -0
  127. package/.cache/typescript/5.4/node_modules/combined-stream/yarn.lock +17 -0
  128. package/.cache/typescript/5.4/node_modules/delayed-stream/License +19 -0
  129. package/.cache/typescript/5.4/node_modules/delayed-stream/Makefile +7 -0
  130. package/.cache/typescript/5.4/node_modules/delayed-stream/Readme.md +141 -0
  131. package/.cache/typescript/5.4/node_modules/delayed-stream/lib/delayed_stream.js +107 -0
  132. package/.cache/typescript/5.4/node_modules/delayed-stream/package.json +27 -0
  133. package/.cache/typescript/5.4/node_modules/domelementtype/LICENSE +11 -0
  134. package/.cache/typescript/5.4/node_modules/domelementtype/index.js +15 -0
  135. package/.cache/typescript/5.4/node_modules/domelementtype/package.json +16 -0
  136. package/.cache/typescript/5.4/node_modules/domelementtype/readme.md +1 -0
  137. package/.cache/typescript/5.4/node_modules/domhandler/.travis.yml +6 -0
  138. package/.cache/typescript/5.4/node_modules/domhandler/LICENSE +11 -0
  139. package/.cache/typescript/5.4/node_modules/domhandler/index.js +217 -0
  140. package/.cache/typescript/5.4/node_modules/domhandler/lib/element.js +20 -0
  141. package/.cache/typescript/5.4/node_modules/domhandler/lib/node.js +44 -0
  142. package/.cache/typescript/5.4/node_modules/domhandler/package.json +41 -0
  143. package/.cache/typescript/5.4/node_modules/domhandler/readme.md +116 -0
  144. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/01-basic.json +57 -0
  145. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/02-single_tag_1.json +21 -0
  146. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/03-single_tag_2.json +21 -0
  147. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/04-unescaped_in_script.json +27 -0
  148. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/05-tags_in_comment.json +18 -0
  149. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/06-comment_in_script.json +18 -0
  150. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/07-unescaped_in_style.json +20 -0
  151. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/08-extra_spaces_in_tag.json +20 -0
  152. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/09-unquoted_attrib.json +20 -0
  153. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/10-singular_attribute.json +15 -0
  154. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/11-text_outside_tags.json +40 -0
  155. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/12-text_only.json +11 -0
  156. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/13-comment_in_text.json +19 -0
  157. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/14-comment_in_text_in_script.json +18 -0
  158. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/15-non-verbose.json +22 -0
  159. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/16-normalize_whitespace.json +47 -0
  160. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/17-xml_namespace.json +18 -0
  161. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/18-enforce_empty_tags.json +16 -0
  162. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/19-ignore_empty_tags.json +20 -0
  163. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/20-template_script_tags.json +20 -0
  164. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/21-conditional_comments.json +15 -0
  165. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/22-lowercase_tags.json +41 -0
  166. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/23-dom-lvl1.json +131 -0
  167. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/24-with-start-indices.json +85 -0
  168. package/.cache/typescript/5.4/node_modules/domhandler/test/cases/25-with-end-indices.json +86 -0
  169. package/.cache/typescript/5.4/node_modules/domhandler/test/tests.js +60 -0
  170. package/.cache/typescript/5.4/node_modules/form-data/License +19 -0
  171. package/.cache/typescript/5.4/node_modules/form-data/README.md.bak +358 -0
  172. package/.cache/typescript/5.4/node_modules/form-data/Readme.md +358 -0
  173. package/.cache/typescript/5.4/node_modules/form-data/index.d.ts +62 -0
  174. package/.cache/typescript/5.4/node_modules/form-data/lib/browser.js +2 -0
  175. package/.cache/typescript/5.4/node_modules/form-data/lib/form_data.js +501 -0
  176. package/.cache/typescript/5.4/node_modules/form-data/lib/populate.js +10 -0
  177. package/.cache/typescript/5.4/node_modules/form-data/package.json +68 -0
  178. package/.cache/typescript/5.4/node_modules/mime-db/HISTORY.md +507 -0
  179. package/.cache/typescript/5.4/node_modules/mime-db/LICENSE +23 -0
  180. package/.cache/typescript/5.4/node_modules/mime-db/README.md +100 -0
  181. package/.cache/typescript/5.4/node_modules/mime-db/db.json +8519 -0
  182. package/.cache/typescript/5.4/node_modules/mime-db/index.js +12 -0
  183. package/.cache/typescript/5.4/node_modules/mime-db/package.json +60 -0
  184. package/.cache/typescript/5.4/node_modules/mime-types/HISTORY.md +397 -0
  185. package/.cache/typescript/5.4/node_modules/mime-types/LICENSE +23 -0
  186. package/.cache/typescript/5.4/node_modules/mime-types/README.md +113 -0
  187. package/.cache/typescript/5.4/node_modules/mime-types/index.js +188 -0
  188. package/.cache/typescript/5.4/node_modules/mime-types/package.json +44 -0
  189. package/.cache/typescript/5.4/node_modules/types-registry/README.md +2 -0
  190. package/.cache/typescript/5.4/node_modules/types-registry/index.json +1 -0
  191. package/.cache/typescript/5.4/node_modules/types-registry/package.json +20 -0
  192. package/.cache/typescript/5.4/node_modules/undici-types/README.md +6 -0
  193. package/.cache/typescript/5.4/node_modules/undici-types/agent.d.ts +31 -0
  194. package/.cache/typescript/5.4/node_modules/undici-types/api.d.ts +43 -0
  195. package/.cache/typescript/5.4/node_modules/undici-types/balanced-pool.d.ts +18 -0
  196. package/.cache/typescript/5.4/node_modules/undici-types/cache.d.ts +36 -0
  197. package/.cache/typescript/5.4/node_modules/undici-types/client.d.ts +97 -0
  198. package/.cache/typescript/5.4/node_modules/undici-types/connector.d.ts +34 -0
  199. package/.cache/typescript/5.4/node_modules/undici-types/content-type.d.ts +21 -0
  200. package/.cache/typescript/5.4/node_modules/undici-types/cookies.d.ts +28 -0
  201. package/.cache/typescript/5.4/node_modules/undici-types/diagnostics-channel.d.ts +67 -0
  202. package/.cache/typescript/5.4/node_modules/undici-types/dispatcher.d.ts +241 -0
  203. package/.cache/typescript/5.4/node_modules/undici-types/errors.d.ts +128 -0
  204. package/.cache/typescript/5.4/node_modules/undici-types/fetch.d.ts +209 -0
  205. package/.cache/typescript/5.4/node_modules/undici-types/file.d.ts +39 -0
  206. package/.cache/typescript/5.4/node_modules/undici-types/filereader.d.ts +54 -0
  207. package/.cache/typescript/5.4/node_modules/undici-types/formdata.d.ts +108 -0
  208. package/.cache/typescript/5.4/node_modules/undici-types/global-dispatcher.d.ts +9 -0
  209. package/.cache/typescript/5.4/node_modules/undici-types/global-origin.d.ts +7 -0
  210. package/.cache/typescript/5.4/node_modules/undici-types/handlers.d.ts +9 -0
  211. package/.cache/typescript/5.4/node_modules/undici-types/header.d.ts +4 -0
  212. package/.cache/typescript/5.4/node_modules/undici-types/index.d.ts +63 -0
  213. package/.cache/typescript/5.4/node_modules/undici-types/interceptors.d.ts +5 -0
  214. package/.cache/typescript/5.4/node_modules/undici-types/mock-agent.d.ts +50 -0
  215. package/.cache/typescript/5.4/node_modules/undici-types/mock-client.d.ts +25 -0
  216. package/.cache/typescript/5.4/node_modules/undici-types/mock-errors.d.ts +12 -0
  217. package/.cache/typescript/5.4/node_modules/undici-types/mock-interceptor.d.ts +93 -0
  218. package/.cache/typescript/5.4/node_modules/undici-types/mock-pool.d.ts +25 -0
  219. package/.cache/typescript/5.4/node_modules/undici-types/package.json +55 -0
  220. package/.cache/typescript/5.4/node_modules/undici-types/patch.d.ts +71 -0
  221. package/.cache/typescript/5.4/node_modules/undici-types/pool-stats.d.ts +19 -0
  222. package/.cache/typescript/5.4/node_modules/undici-types/pool.d.ts +28 -0
  223. package/.cache/typescript/5.4/node_modules/undici-types/proxy-agent.d.ts +30 -0
  224. package/.cache/typescript/5.4/node_modules/undici-types/readable.d.ts +61 -0
  225. package/.cache/typescript/5.4/node_modules/undici-types/webidl.d.ts +220 -0
  226. package/.cache/typescript/5.4/node_modules/undici-types/websocket.d.ts +131 -0
  227. package/.cache/typescript/5.4/package-lock.json +197 -0
  228. package/.cache/typescript/5.4/package.json +1 -0
  229. package/index.js +1 -1
  230. package/package.json +8 -2
  231. package/.cache/replit/modules/nodejs-20:v36-20240502-f4453db.res +0 -1
  232. package/.cache/replit/modules/replit:v9-20240429-0325cbb.res +0 -1
@@ -0,0 +1,921 @@
1
+ /**
2
+ * The `node:vm` module enables compiling and running code within V8 Virtual
3
+ * Machine contexts.
4
+ *
5
+ * **The `node:vm` module is not a security**
6
+ * **mechanism. Do not use it to run untrusted code.**
7
+ *
8
+ * JavaScript code can be compiled and run immediately or
9
+ * compiled, saved, and run later.
10
+ *
11
+ * A common use case is to run the code in a different V8 Context. This means
12
+ * invoked code has a different global object than the invoking code.
13
+ *
14
+ * One can provide the context by `contextifying` an
15
+ * object. The invoked code treats any property in the context like a
16
+ * global variable. Any changes to global variables caused by the invoked
17
+ * code are reflected in the context object.
18
+ *
19
+ * ```js
20
+ * const vm = require('node:vm');
21
+ *
22
+ * const x = 1;
23
+ *
24
+ * const context = { x: 2 };
25
+ * vm.createContext(context); // Contextify the object.
26
+ *
27
+ * const code = 'x += 40; var y = 17;';
28
+ * // `x` and `y` are global variables in the context.
29
+ * // Initially, x has the value 2 because that is the value of context.x.
30
+ * vm.runInContext(code, context);
31
+ *
32
+ * console.log(context.x); // 42
33
+ * console.log(context.y); // 17
34
+ *
35
+ * console.log(x); // 1; y is not defined.
36
+ * ```
37
+ * @see [source](https://github.com/nodejs/node/blob/v20.12.2/lib/vm.js)
38
+ */
39
+ declare module "vm" {
40
+ import { ImportAttributes } from "node:module";
41
+ interface Context extends NodeJS.Dict<any> {}
42
+ interface BaseOptions {
43
+ /**
44
+ * Specifies the filename used in stack traces produced by this script.
45
+ * @default ''
46
+ */
47
+ filename?: string | undefined;
48
+ /**
49
+ * Specifies the line number offset that is displayed in stack traces produced by this script.
50
+ * @default 0
51
+ */
52
+ lineOffset?: number | undefined;
53
+ /**
54
+ * Specifies the column number offset that is displayed in stack traces produced by this script.
55
+ * @default 0
56
+ */
57
+ columnOffset?: number | undefined;
58
+ }
59
+ interface ScriptOptions extends BaseOptions {
60
+ /**
61
+ * V8's code cache data for the supplied source.
62
+ */
63
+ cachedData?: Buffer | NodeJS.ArrayBufferView | undefined;
64
+ /** @deprecated in favor of `script.createCachedData()` */
65
+ produceCachedData?: boolean | undefined;
66
+ /**
67
+ * Used to specify how the modules should be loaded during the evaluation of this script when `import()` is called. This option is
68
+ * part of the experimental modules API. We do not recommend using it in a production environment. For detailed information, see
69
+ * [Support of dynamic `import()` in compilation APIs](https://nodejs.org/docs/latest-v20.x/api/vm.html#support-of-dynamic-import-in-compilation-apis).
70
+ */
71
+ importModuleDynamically?:
72
+ | ((specifier: string, script: Script, importAttributes: ImportAttributes) => Module)
73
+ | typeof constants.USE_MAIN_CONTEXT_DEFAULT_LOADER
74
+ | undefined;
75
+ }
76
+ interface RunningScriptOptions extends BaseOptions {
77
+ /**
78
+ * When `true`, if an `Error` occurs while compiling the `code`, the line of code causing the error is attached to the stack trace.
79
+ * @default true
80
+ */
81
+ displayErrors?: boolean | undefined;
82
+ /**
83
+ * Specifies the number of milliseconds to execute code before terminating execution.
84
+ * If execution is terminated, an `Error` will be thrown. This value must be a strictly positive integer.
85
+ */
86
+ timeout?: number | undefined;
87
+ /**
88
+ * If `true`, the execution will be terminated when `SIGINT` (Ctrl+C) is received.
89
+ * Existing handlers for the event that have been attached via `process.on('SIGINT')` will be disabled during script execution, but will continue to work after that.
90
+ * If execution is terminated, an `Error` will be thrown.
91
+ * @default false
92
+ */
93
+ breakOnSigint?: boolean | undefined;
94
+ }
95
+ interface RunningScriptInNewContextOptions extends RunningScriptOptions {
96
+ /**
97
+ * Human-readable name of the newly created context.
98
+ */
99
+ contextName?: CreateContextOptions["name"];
100
+ /**
101
+ * Origin corresponding to the newly created context for display purposes. The origin should be formatted like a URL,
102
+ * but with only the scheme, host, and port (if necessary), like the value of the `url.origin` property of a `URL` object.
103
+ * Most notably, this string should omit the trailing slash, as that denotes a path.
104
+ */
105
+ contextOrigin?: CreateContextOptions["origin"];
106
+ contextCodeGeneration?: CreateContextOptions["codeGeneration"];
107
+ /**
108
+ * If set to `afterEvaluate`, microtasks will be run immediately after the script has run.
109
+ */
110
+ microtaskMode?: CreateContextOptions["microtaskMode"];
111
+ }
112
+ interface RunningCodeOptions extends RunningScriptOptions {
113
+ cachedData?: ScriptOptions["cachedData"];
114
+ importModuleDynamically?: ScriptOptions["importModuleDynamically"];
115
+ }
116
+ interface RunningCodeInNewContextOptions extends RunningScriptInNewContextOptions {
117
+ cachedData?: ScriptOptions["cachedData"];
118
+ importModuleDynamically?: ScriptOptions["importModuleDynamically"];
119
+ }
120
+ interface CompileFunctionOptions extends BaseOptions {
121
+ /**
122
+ * Provides an optional data with V8's code cache data for the supplied source.
123
+ */
124
+ cachedData?: Buffer | undefined;
125
+ /**
126
+ * Specifies whether to produce new cache data.
127
+ * @default false
128
+ */
129
+ produceCachedData?: boolean | undefined;
130
+ /**
131
+ * The sandbox/context in which the said function should be compiled in.
132
+ */
133
+ parsingContext?: Context | undefined;
134
+ /**
135
+ * An array containing a collection of context extensions (objects wrapping the current scope) to be applied while compiling
136
+ */
137
+ contextExtensions?: Object[] | undefined;
138
+ }
139
+ interface CreateContextOptions {
140
+ /**
141
+ * Human-readable name of the newly created context.
142
+ * @default 'VM Context i' Where i is an ascending numerical index of the created context.
143
+ */
144
+ name?: string | undefined;
145
+ /**
146
+ * Corresponds to the newly created context for display purposes.
147
+ * The origin should be formatted like a `URL`, but with only the scheme, host, and port (if necessary),
148
+ * like the value of the `url.origin` property of a URL object.
149
+ * Most notably, this string should omit the trailing slash, as that denotes a path.
150
+ * @default ''
151
+ */
152
+ origin?: string | undefined;
153
+ codeGeneration?:
154
+ | {
155
+ /**
156
+ * If set to false any calls to eval or function constructors (Function, GeneratorFunction, etc)
157
+ * will throw an EvalError.
158
+ * @default true
159
+ */
160
+ strings?: boolean | undefined;
161
+ /**
162
+ * If set to false any attempt to compile a WebAssembly module will throw a WebAssembly.CompileError.
163
+ * @default true
164
+ */
165
+ wasm?: boolean | undefined;
166
+ }
167
+ | undefined;
168
+ /**
169
+ * If set to `afterEvaluate`, microtasks will be run immediately after the script has run.
170
+ */
171
+ microtaskMode?: "afterEvaluate" | undefined;
172
+ }
173
+ type MeasureMemoryMode = "summary" | "detailed";
174
+ interface MeasureMemoryOptions {
175
+ /**
176
+ * @default 'summary'
177
+ */
178
+ mode?: MeasureMemoryMode | undefined;
179
+ /**
180
+ * @default 'default'
181
+ */
182
+ execution?: "default" | "eager" | undefined;
183
+ }
184
+ interface MemoryMeasurement {
185
+ total: {
186
+ jsMemoryEstimate: number;
187
+ jsMemoryRange: [number, number];
188
+ };
189
+ }
190
+ /**
191
+ * Instances of the `vm.Script` class contain precompiled scripts that can be
192
+ * executed in specific contexts.
193
+ * @since v0.3.1
194
+ */
195
+ class Script {
196
+ constructor(code: string, options?: ScriptOptions | string);
197
+ /**
198
+ * Runs the compiled code contained by the `vm.Script` object within the given `contextifiedObject` and returns the result. Running code does not have access
199
+ * to local scope.
200
+ *
201
+ * The following example compiles code that increments a global variable, sets
202
+ * the value of another global variable, then execute the code multiple times.
203
+ * The globals are contained in the `context` object.
204
+ *
205
+ * ```js
206
+ * const vm = require('node:vm');
207
+ *
208
+ * const context = {
209
+ * animal: 'cat',
210
+ * count: 2,
211
+ * };
212
+ *
213
+ * const script = new vm.Script('count += 1; name = "kitty";');
214
+ *
215
+ * vm.createContext(context);
216
+ * for (let i = 0; i < 10; ++i) {
217
+ * script.runInContext(context);
218
+ * }
219
+ *
220
+ * console.log(context);
221
+ * // Prints: { animal: 'cat', count: 12, name: 'kitty' }
222
+ * ```
223
+ *
224
+ * Using the `timeout` or `breakOnSigint` options will result in new event loops
225
+ * and corresponding threads being started, which have a non-zero performance
226
+ * overhead.
227
+ * @since v0.3.1
228
+ * @param contextifiedObject A `contextified` object as returned by the `vm.createContext()` method.
229
+ * @return the result of the very last statement executed in the script.
230
+ */
231
+ runInContext(contextifiedObject: Context, options?: RunningScriptOptions): any;
232
+ /**
233
+ * First contextifies the given `contextObject`, runs the compiled code contained
234
+ * by the `vm.Script` object within the created context, and returns the result.
235
+ * Running code does not have access to local scope.
236
+ *
237
+ * The following example compiles code that sets a global variable, then executes
238
+ * the code multiple times in different contexts. The globals are set on and
239
+ * contained within each individual `context`.
240
+ *
241
+ * ```js
242
+ * const vm = require('node:vm');
243
+ *
244
+ * const script = new vm.Script('globalVar = "set"');
245
+ *
246
+ * const contexts = [{}, {}, {}];
247
+ * contexts.forEach((context) => {
248
+ * script.runInNewContext(context);
249
+ * });
250
+ *
251
+ * console.log(contexts);
252
+ * // Prints: [{ globalVar: 'set' }, { globalVar: 'set' }, { globalVar: 'set' }]
253
+ * ```
254
+ * @since v0.3.1
255
+ * @param contextObject An object that will be `contextified`. If `undefined`, a new object will be created.
256
+ * @return the result of the very last statement executed in the script.
257
+ */
258
+ runInNewContext(contextObject?: Context, options?: RunningScriptInNewContextOptions): any;
259
+ /**
260
+ * Runs the compiled code contained by the `vm.Script` within the context of the
261
+ * current `global` object. Running code does not have access to local scope, but _does_ have access to the current `global` object.
262
+ *
263
+ * The following example compiles code that increments a `global` variable then
264
+ * executes that code multiple times:
265
+ *
266
+ * ```js
267
+ * const vm = require('node:vm');
268
+ *
269
+ * global.globalVar = 0;
270
+ *
271
+ * const script = new vm.Script('globalVar += 1', { filename: 'myfile.vm' });
272
+ *
273
+ * for (let i = 0; i < 1000; ++i) {
274
+ * script.runInThisContext();
275
+ * }
276
+ *
277
+ * console.log(globalVar);
278
+ *
279
+ * // 1000
280
+ * ```
281
+ * @since v0.3.1
282
+ * @return the result of the very last statement executed in the script.
283
+ */
284
+ runInThisContext(options?: RunningScriptOptions): any;
285
+ /**
286
+ * Creates a code cache that can be used with the `Script` constructor's `cachedData` option. Returns a `Buffer`. This method may be called at any
287
+ * time and any number of times.
288
+ *
289
+ * The code cache of the `Script` doesn't contain any JavaScript observable
290
+ * states. The code cache is safe to be saved along side the script source and
291
+ * used to construct new `Script` instances multiple times.
292
+ *
293
+ * Functions in the `Script` source can be marked as lazily compiled and they are
294
+ * not compiled at construction of the `Script`. These functions are going to be
295
+ * compiled when they are invoked the first time. The code cache serializes the
296
+ * metadata that V8 currently knows about the `Script` that it can use to speed up
297
+ * future compilations.
298
+ *
299
+ * ```js
300
+ * const script = new vm.Script(`
301
+ * function add(a, b) {
302
+ * return a + b;
303
+ * }
304
+ *
305
+ * const x = add(1, 2);
306
+ * `);
307
+ *
308
+ * const cacheWithoutAdd = script.createCachedData();
309
+ * // In `cacheWithoutAdd` the function `add()` is marked for full compilation
310
+ * // upon invocation.
311
+ *
312
+ * script.runInThisContext();
313
+ *
314
+ * const cacheWithAdd = script.createCachedData();
315
+ * // `cacheWithAdd` contains fully compiled function `add()`.
316
+ * ```
317
+ * @since v10.6.0
318
+ */
319
+ createCachedData(): Buffer;
320
+ /** @deprecated in favor of `script.createCachedData()` */
321
+ cachedDataProduced?: boolean | undefined;
322
+ /**
323
+ * When `cachedData` is supplied to create the `vm.Script`, this value will be set
324
+ * to either `true` or `false` depending on acceptance of the data by V8.
325
+ * Otherwise the value is `undefined`.
326
+ * @since v5.7.0
327
+ */
328
+ cachedDataRejected?: boolean | undefined;
329
+ cachedData?: Buffer | undefined;
330
+ /**
331
+ * When the script is compiled from a source that contains a source map magic
332
+ * comment, this property will be set to the URL of the source map.
333
+ *
334
+ * ```js
335
+ * import vm from 'node:vm';
336
+ *
337
+ * const script = new vm.Script(`
338
+ * function myFunc() {}
339
+ * //# sourceMappingURL=sourcemap.json
340
+ * `);
341
+ *
342
+ * console.log(script.sourceMapURL);
343
+ * // Prints: sourcemap.json
344
+ * ```
345
+ * @since v19.1.0, v18.13.0
346
+ */
347
+ sourceMapURL?: string | undefined;
348
+ }
349
+ /**
350
+ * If given a `contextObject`, the `vm.createContext()` method will `prepare
351
+ * that object` so that it can be used in calls to {@link runInContext} or `script.runInContext()`. Inside such scripts,
352
+ * the `contextObject` will be the global object, retaining all of its existing
353
+ * properties but also having the built-in objects and functions any standard [global object](https://es5.github.io/#x15.1) has. Outside of scripts run by the vm module, global variables
354
+ * will remain unchanged.
355
+ *
356
+ * ```js
357
+ * const vm = require('node:vm');
358
+ *
359
+ * global.globalVar = 3;
360
+ *
361
+ * const context = { globalVar: 1 };
362
+ * vm.createContext(context);
363
+ *
364
+ * vm.runInContext('globalVar *= 2;', context);
365
+ *
366
+ * console.log(context);
367
+ * // Prints: { globalVar: 2 }
368
+ *
369
+ * console.log(global.globalVar);
370
+ * // Prints: 3
371
+ * ```
372
+ *
373
+ * If `contextObject` is omitted (or passed explicitly as `undefined`), a new,
374
+ * empty `contextified` object will be returned.
375
+ *
376
+ * The `vm.createContext()` method is primarily useful for creating a single
377
+ * context that can be used to run multiple scripts. For instance, if emulating a
378
+ * web browser, the method can be used to create a single context representing a
379
+ * window's global object, then run all `<script>` tags together within that
380
+ * context.
381
+ *
382
+ * The provided `name` and `origin` of the context are made visible through the
383
+ * Inspector API.
384
+ * @since v0.3.1
385
+ * @return contextified object.
386
+ */
387
+ function createContext(sandbox?: Context, options?: CreateContextOptions): Context;
388
+ /**
389
+ * Returns `true` if the given `object` object has been `contextified` using {@link createContext}.
390
+ * @since v0.11.7
391
+ */
392
+ function isContext(sandbox: Context): boolean;
393
+ /**
394
+ * The `vm.runInContext()` method compiles `code`, runs it within the context of
395
+ * the `contextifiedObject`, then returns the result. Running code does not have
396
+ * access to the local scope. The `contextifiedObject` object _must_ have been
397
+ * previously `contextified` using the {@link createContext} method.
398
+ *
399
+ * If `options` is a string, then it specifies the filename.
400
+ *
401
+ * The following example compiles and executes different scripts using a single `contextified` object:
402
+ *
403
+ * ```js
404
+ * const vm = require('node:vm');
405
+ *
406
+ * const contextObject = { globalVar: 1 };
407
+ * vm.createContext(contextObject);
408
+ *
409
+ * for (let i = 0; i < 10; ++i) {
410
+ * vm.runInContext('globalVar *= 2;', contextObject);
411
+ * }
412
+ * console.log(contextObject);
413
+ * // Prints: { globalVar: 1024 }
414
+ * ```
415
+ * @since v0.3.1
416
+ * @param code The JavaScript code to compile and run.
417
+ * @param contextifiedObject The `contextified` object that will be used as the `global` when the `code` is compiled and run.
418
+ * @return the result of the very last statement executed in the script.
419
+ */
420
+ function runInContext(code: string, contextifiedObject: Context, options?: RunningCodeOptions | string): any;
421
+ /**
422
+ * The `vm.runInNewContext()` first contextifies the given `contextObject` (or
423
+ * creates a new `contextObject` if passed as `undefined`), compiles the `code`,
424
+ * runs it within the created context, then returns the result. Running code
425
+ * does not have access to the local scope.
426
+ *
427
+ * If `options` is a string, then it specifies the filename.
428
+ *
429
+ * The following example compiles and executes code that increments a global
430
+ * variable and sets a new one. These globals are contained in the `contextObject`.
431
+ *
432
+ * ```js
433
+ * const vm = require('node:vm');
434
+ *
435
+ * const contextObject = {
436
+ * animal: 'cat',
437
+ * count: 2,
438
+ * };
439
+ *
440
+ * vm.runInNewContext('count += 1; name = "kitty"', contextObject);
441
+ * console.log(contextObject);
442
+ * // Prints: { animal: 'cat', count: 3, name: 'kitty' }
443
+ * ```
444
+ * @since v0.3.1
445
+ * @param code The JavaScript code to compile and run.
446
+ * @param contextObject An object that will be `contextified`. If `undefined`, a new object will be created.
447
+ * @return the result of the very last statement executed in the script.
448
+ */
449
+ function runInNewContext(
450
+ code: string,
451
+ contextObject?: Context,
452
+ options?: RunningCodeInNewContextOptions | string,
453
+ ): any;
454
+ /**
455
+ * `vm.runInThisContext()` compiles `code`, runs it within the context of the
456
+ * current `global` and returns the result. Running code does not have access to
457
+ * local scope, but does have access to the current `global` object.
458
+ *
459
+ * If `options` is a string, then it specifies the filename.
460
+ *
461
+ * The following example illustrates using both `vm.runInThisContext()` and
462
+ * the JavaScript [`eval()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval) function to run the same code:
463
+ *
464
+ * ```js
465
+ * const vm = require('node:vm');
466
+ * let localVar = 'initial value';
467
+ *
468
+ * const vmResult = vm.runInThisContext('localVar = "vm";');
469
+ * console.log(`vmResult: '${vmResult}', localVar: '${localVar}'`);
470
+ * // Prints: vmResult: 'vm', localVar: 'initial value'
471
+ *
472
+ * const evalResult = eval('localVar = "eval";');
473
+ * console.log(`evalResult: '${evalResult}', localVar: '${localVar}'`);
474
+ * // Prints: evalResult: 'eval', localVar: 'eval'
475
+ * ```
476
+ *
477
+ * Because `vm.runInThisContext()` does not have access to the local scope, `localVar` is unchanged. In contrast,
478
+ * [`eval()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval) _does_ have access to the
479
+ * local scope, so the value `localVar` is changed. In this way `vm.runInThisContext()` is much like an [indirect `eval()` call](https://es5.github.io/#x10.4.2), e.g.`(0,eval)('code')`.
480
+ *
481
+ * ## Example: Running an HTTP server within a VM
482
+ *
483
+ * When using either `script.runInThisContext()` or {@link runInThisContext}, the code is executed within the current V8 global
484
+ * context. The code passed to this VM context will have its own isolated scope.
485
+ *
486
+ * In order to run a simple web server using the `node:http` module the code passed
487
+ * to the context must either call `require('node:http')` on its own, or have a
488
+ * reference to the `node:http` module passed to it. For instance:
489
+ *
490
+ * ```js
491
+ * 'use strict';
492
+ * const vm = require('node:vm');
493
+ *
494
+ * const code = `
495
+ * ((require) => {
496
+ * const http = require('node:http');
497
+ *
498
+ * http.createServer((request, response) => {
499
+ * response.writeHead(200, { 'Content-Type': 'text/plain' });
500
+ * response.end('Hello World\\n');
501
+ * }).listen(8124);
502
+ *
503
+ * console.log('Server running at http://127.0.0.1:8124/');
504
+ * })`;
505
+ *
506
+ * vm.runInThisContext(code)(require);
507
+ * ```
508
+ *
509
+ * The `require()` in the above case shares the state with the context it is
510
+ * passed from. This may introduce risks when untrusted code is executed, e.g.
511
+ * altering objects in the context in unwanted ways.
512
+ * @since v0.3.1
513
+ * @param code The JavaScript code to compile and run.
514
+ * @return the result of the very last statement executed in the script.
515
+ */
516
+ function runInThisContext(code: string, options?: RunningCodeOptions | string): any;
517
+ /**
518
+ * Compiles the given code into the provided context (if no context is
519
+ * supplied, the current context is used), and returns it wrapped inside a
520
+ * function with the given `params`.
521
+ * @since v10.10.0
522
+ * @param code The body of the function to compile.
523
+ * @param params An array of strings containing all parameters for the function.
524
+ */
525
+ function compileFunction(
526
+ code: string,
527
+ params?: readonly string[],
528
+ options?: CompileFunctionOptions,
529
+ ): Function & {
530
+ cachedData?: Script["cachedData"] | undefined;
531
+ cachedDataProduced?: Script["cachedDataProduced"] | undefined;
532
+ cachedDataRejected?: Script["cachedDataRejected"] | undefined;
533
+ };
534
+ /**
535
+ * Measure the memory known to V8 and used by all contexts known to the
536
+ * current V8 isolate, or the main context.
537
+ *
538
+ * The format of the object that the returned Promise may resolve with is
539
+ * specific to the V8 engine and may change from one version of V8 to the next.
540
+ *
541
+ * The returned result is different from the statistics returned by `v8.getHeapSpaceStatistics()` in that `vm.measureMemory()` measure the
542
+ * memory reachable by each V8 specific contexts in the current instance of
543
+ * the V8 engine, while the result of `v8.getHeapSpaceStatistics()` measure
544
+ * the memory occupied by each heap space in the current V8 instance.
545
+ *
546
+ * ```js
547
+ * const vm = require('node:vm');
548
+ * // Measure the memory used by the main context.
549
+ * vm.measureMemory({ mode: 'summary' })
550
+ * // This is the same as vm.measureMemory()
551
+ * .then((result) => {
552
+ * // The current format is:
553
+ * // {
554
+ * // total: {
555
+ * // jsMemoryEstimate: 2418479, jsMemoryRange: [ 2418479, 2745799 ]
556
+ * // }
557
+ * // }
558
+ * console.log(result);
559
+ * });
560
+ *
561
+ * const context = vm.createContext({ a: 1 });
562
+ * vm.measureMemory({ mode: 'detailed', execution: 'eager' })
563
+ * .then((result) => {
564
+ * // Reference the context here so that it won't be GC'ed
565
+ * // until the measurement is complete.
566
+ * console.log(context.a);
567
+ * // {
568
+ * // total: {
569
+ * // jsMemoryEstimate: 2574732,
570
+ * // jsMemoryRange: [ 2574732, 2904372 ]
571
+ * // },
572
+ * // current: {
573
+ * // jsMemoryEstimate: 2438996,
574
+ * // jsMemoryRange: [ 2438996, 2768636 ]
575
+ * // },
576
+ * // other: [
577
+ * // {
578
+ * // jsMemoryEstimate: 135736,
579
+ * // jsMemoryRange: [ 135736, 465376 ]
580
+ * // }
581
+ * // ]
582
+ * // }
583
+ * console.log(result);
584
+ * });
585
+ * ```
586
+ * @since v13.10.0
587
+ * @experimental
588
+ */
589
+ function measureMemory(options?: MeasureMemoryOptions): Promise<MemoryMeasurement>;
590
+ interface ModuleEvaluateOptions {
591
+ timeout?: RunningScriptOptions["timeout"] | undefined;
592
+ breakOnSigint?: RunningScriptOptions["breakOnSigint"] | undefined;
593
+ }
594
+ type ModuleLinker = (
595
+ specifier: string,
596
+ referencingModule: Module,
597
+ extra: {
598
+ /** @deprecated Use `attributes` instead */
599
+ assert: ImportAttributes;
600
+ attributes: ImportAttributes;
601
+ },
602
+ ) => Module | Promise<Module>;
603
+ type ModuleStatus = "unlinked" | "linking" | "linked" | "evaluating" | "evaluated" | "errored";
604
+ /**
605
+ * This feature is only available with the `--experimental-vm-modules` command
606
+ * flag enabled.
607
+ *
608
+ * The `vm.Module` class provides a low-level interface for using
609
+ * ECMAScript modules in VM contexts. It is the counterpart of the `vm.Script` class that closely mirrors [Module Record](https://262.ecma-international.org/14.0/#sec-abstract-module-records) s as
610
+ * defined in the ECMAScript
611
+ * specification.
612
+ *
613
+ * Unlike `vm.Script` however, every `vm.Module` object is bound to a context from
614
+ * its creation. Operations on `vm.Module` objects are intrinsically asynchronous,
615
+ * in contrast with the synchronous nature of `vm.Script` objects. The use of
616
+ * 'async' functions can help with manipulating `vm.Module` objects.
617
+ *
618
+ * Using a `vm.Module` object requires three distinct steps: creation/parsing,
619
+ * linking, and evaluation. These three steps are illustrated in the following
620
+ * example.
621
+ *
622
+ * This implementation lies at a lower level than the `ECMAScript Module
623
+ * loader`. There is also no way to interact with the Loader yet, though
624
+ * support is planned.
625
+ *
626
+ * ```js
627
+ * import vm from 'node:vm';
628
+ *
629
+ * const contextifiedObject = vm.createContext({
630
+ * secret: 42,
631
+ * print: console.log,
632
+ * });
633
+ *
634
+ * // Step 1
635
+ * //
636
+ * // Create a Module by constructing a new `vm.SourceTextModule` object. This
637
+ * // parses the provided source text, throwing a `SyntaxError` if anything goes
638
+ * // wrong. By default, a Module is created in the top context. But here, we
639
+ * // specify `contextifiedObject` as the context this Module belongs to.
640
+ * //
641
+ * // Here, we attempt to obtain the default export from the module "foo", and
642
+ * // put it into local binding "secret".
643
+ *
644
+ * const bar = new vm.SourceTextModule(`
645
+ * import s from 'foo';
646
+ * s;
647
+ * print(s);
648
+ * `, { context: contextifiedObject });
649
+ *
650
+ * // Step 2
651
+ * //
652
+ * // "Link" the imported dependencies of this Module to it.
653
+ * //
654
+ * // The provided linking callback (the "linker") accepts two arguments: the
655
+ * // parent module (`bar` in this case) and the string that is the specifier of
656
+ * // the imported module. The callback is expected to return a Module that
657
+ * // corresponds to the provided specifier, with certain requirements documented
658
+ * // in `module.link()`.
659
+ * //
660
+ * // If linking has not started for the returned Module, the same linker
661
+ * // callback will be called on the returned Module.
662
+ * //
663
+ * // Even top-level Modules without dependencies must be explicitly linked. The
664
+ * // callback provided would never be called, however.
665
+ * //
666
+ * // The link() method returns a Promise that will be resolved when all the
667
+ * // Promises returned by the linker resolve.
668
+ * //
669
+ * // Note: This is a contrived example in that the linker function creates a new
670
+ * // "foo" module every time it is called. In a full-fledged module system, a
671
+ * // cache would probably be used to avoid duplicated modules.
672
+ *
673
+ * async function linker(specifier, referencingModule) {
674
+ * if (specifier === 'foo') {
675
+ * return new vm.SourceTextModule(`
676
+ * // The "secret" variable refers to the global variable we added to
677
+ * // "contextifiedObject" when creating the context.
678
+ * export default secret;
679
+ * `, { context: referencingModule.context });
680
+ *
681
+ * // Using `contextifiedObject` instead of `referencingModule.context`
682
+ * // here would work as well.
683
+ * }
684
+ * throw new Error(`Unable to resolve dependency: ${specifier}`);
685
+ * }
686
+ * await bar.link(linker);
687
+ *
688
+ * // Step 3
689
+ * //
690
+ * // Evaluate the Module. The evaluate() method returns a promise which will
691
+ * // resolve after the module has finished evaluating.
692
+ *
693
+ * // Prints 42.
694
+ * await bar.evaluate();
695
+ * ```
696
+ * @since v13.0.0, v12.16.0
697
+ * @experimental
698
+ */
699
+ class Module {
700
+ /**
701
+ * The specifiers of all dependencies of this module. The returned array is frozen
702
+ * to disallow any changes to it.
703
+ *
704
+ * Corresponds to the `[[RequestedModules]]` field of [Cyclic Module Record](https://tc39.es/ecma262/#sec-cyclic-module-records) s in
705
+ * the ECMAScript specification.
706
+ */
707
+ dependencySpecifiers: readonly string[];
708
+ /**
709
+ * If the `module.status` is `'errored'`, this property contains the exception
710
+ * thrown by the module during evaluation. If the status is anything else,
711
+ * accessing this property will result in a thrown exception.
712
+ *
713
+ * The value `undefined` cannot be used for cases where there is not a thrown
714
+ * exception due to possible ambiguity with `throw undefined;`.
715
+ *
716
+ * Corresponds to the `[[EvaluationError]]` field of [Cyclic Module Record](https://tc39.es/ecma262/#sec-cyclic-module-records) s
717
+ * in the ECMAScript specification.
718
+ */
719
+ error: any;
720
+ /**
721
+ * The identifier of the current module, as set in the constructor.
722
+ */
723
+ identifier: string;
724
+ context: Context;
725
+ /**
726
+ * The namespace object of the module. This is only available after linking
727
+ * (`module.link()`) has completed.
728
+ *
729
+ * Corresponds to the [GetModuleNamespace](https://tc39.es/ecma262/#sec-getmodulenamespace) abstract operation in the ECMAScript
730
+ * specification.
731
+ */
732
+ namespace: Object;
733
+ /**
734
+ * The current status of the module. Will be one of:
735
+ *
736
+ * * `'unlinked'`: `module.link()` has not yet been called.
737
+ * * `'linking'`: `module.link()` has been called, but not all Promises returned
738
+ * by the linker function have been resolved yet.
739
+ * * `'linked'`: The module has been linked successfully, and all of its
740
+ * dependencies are linked, but `module.evaluate()` has not yet been called.
741
+ * * `'evaluating'`: The module is being evaluated through a `module.evaluate()` on
742
+ * itself or a parent module.
743
+ * * `'evaluated'`: The module has been successfully evaluated.
744
+ * * `'errored'`: The module has been evaluated, but an exception was thrown.
745
+ *
746
+ * Other than `'errored'`, this status string corresponds to the specification's [Cyclic Module Record](https://tc39.es/ecma262/#sec-cyclic-module-records)'s `[[Status]]` field. `'errored'`
747
+ * corresponds to `'evaluated'` in the specification, but with `[[EvaluationError]]` set to a
748
+ * value that is not `undefined`.
749
+ */
750
+ status: ModuleStatus;
751
+ /**
752
+ * Evaluate the module.
753
+ *
754
+ * This must be called after the module has been linked; otherwise it will reject.
755
+ * It could be called also when the module has already been evaluated, in which
756
+ * case it will either do nothing if the initial evaluation ended in success
757
+ * (`module.status` is `'evaluated'`) or it will re-throw the exception that the
758
+ * initial evaluation resulted in (`module.status` is `'errored'`).
759
+ *
760
+ * This method cannot be called while the module is being evaluated
761
+ * (`module.status` is `'evaluating'`).
762
+ *
763
+ * Corresponds to the [Evaluate() concrete method](https://tc39.es/ecma262/#sec-moduleevaluation) field of [Cyclic Module Record](https://tc39.es/ecma262/#sec-cyclic-module-records) s in the
764
+ * ECMAScript specification.
765
+ * @return Fulfills with `undefined` upon success.
766
+ */
767
+ evaluate(options?: ModuleEvaluateOptions): Promise<void>;
768
+ /**
769
+ * Link module dependencies. This method must be called before evaluation, and
770
+ * can only be called once per module.
771
+ *
772
+ * The function is expected to return a `Module` object or a `Promise` that
773
+ * eventually resolves to a `Module` object. The returned `Module` must satisfy the
774
+ * following two invariants:
775
+ *
776
+ * * It must belong to the same context as the parent `Module`.
777
+ * * Its `status` must not be `'errored'`.
778
+ *
779
+ * If the returned `Module`'s `status` is `'unlinked'`, this method will be
780
+ * recursively called on the returned `Module` with the same provided `linker` function.
781
+ *
782
+ * `link()` returns a `Promise` that will either get resolved when all linking
783
+ * instances resolve to a valid `Module`, or rejected if the linker function either
784
+ * throws an exception or returns an invalid `Module`.
785
+ *
786
+ * The linker function roughly corresponds to the implementation-defined [HostResolveImportedModule](https://tc39.es/ecma262/#sec-hostresolveimportedmodule) abstract operation in the
787
+ * ECMAScript
788
+ * specification, with a few key differences:
789
+ *
790
+ * * The linker function is allowed to be asynchronous while [HostResolveImportedModule](https://tc39.es/ecma262/#sec-hostresolveimportedmodule) is synchronous.
791
+ *
792
+ * The actual [HostResolveImportedModule](https://tc39.es/ecma262/#sec-hostresolveimportedmodule) implementation used during module
793
+ * linking is one that returns the modules linked during linking. Since at
794
+ * that point all modules would have been fully linked already, the [HostResolveImportedModule](https://tc39.es/ecma262/#sec-hostresolveimportedmodule) implementation is fully synchronous per
795
+ * specification.
796
+ *
797
+ * Corresponds to the [Link() concrete method](https://tc39.es/ecma262/#sec-moduledeclarationlinking) field of [Cyclic Module Record](https://tc39.es/ecma262/#sec-cyclic-module-records) s in
798
+ * the ECMAScript specification.
799
+ */
800
+ link(linker: ModuleLinker): Promise<void>;
801
+ }
802
+ interface SourceTextModuleOptions {
803
+ /**
804
+ * String used in stack traces.
805
+ * @default 'vm:module(i)' where i is a context-specific ascending index.
806
+ */
807
+ identifier?: string | undefined;
808
+ cachedData?: ScriptOptions["cachedData"] | undefined;
809
+ context?: Context | undefined;
810
+ lineOffset?: BaseOptions["lineOffset"] | undefined;
811
+ columnOffset?: BaseOptions["columnOffset"] | undefined;
812
+ /**
813
+ * Called during evaluation of this module to initialize the `import.meta`.
814
+ */
815
+ initializeImportMeta?: ((meta: ImportMeta, module: SourceTextModule) => void) | undefined;
816
+ importModuleDynamically?: ScriptOptions["importModuleDynamically"] | undefined;
817
+ }
818
+ /**
819
+ * This feature is only available with the `--experimental-vm-modules` command
820
+ * flag enabled.
821
+ *
822
+ * The `vm.SourceTextModule` class provides the [Source Text Module Record](https://tc39.es/ecma262/#sec-source-text-module-records) as
823
+ * defined in the ECMAScript specification.
824
+ * @since v9.6.0
825
+ * @experimental
826
+ */
827
+ class SourceTextModule extends Module {
828
+ /**
829
+ * Creates a new `SourceTextModule` instance.
830
+ * @param code JavaScript Module code to parse
831
+ */
832
+ constructor(code: string, options?: SourceTextModuleOptions);
833
+ }
834
+ interface SyntheticModuleOptions {
835
+ /**
836
+ * String used in stack traces.
837
+ * @default 'vm:module(i)' where i is a context-specific ascending index.
838
+ */
839
+ identifier?: string | undefined;
840
+ /**
841
+ * The contextified object as returned by the `vm.createContext()` method, to compile and evaluate this module in.
842
+ */
843
+ context?: Context | undefined;
844
+ }
845
+ /**
846
+ * This feature is only available with the `--experimental-vm-modules` command
847
+ * flag enabled.
848
+ *
849
+ * The `vm.SyntheticModule` class provides the [Synthetic Module Record](https://heycam.github.io/webidl/#synthetic-module-records) as
850
+ * defined in the WebIDL specification. The purpose of synthetic modules is to
851
+ * provide a generic interface for exposing non-JavaScript sources to ECMAScript
852
+ * module graphs.
853
+ *
854
+ * ```js
855
+ * const vm = require('node:vm');
856
+ *
857
+ * const source = '{ "a": 1 }';
858
+ * const module = new vm.SyntheticModule(['default'], function() {
859
+ * const obj = JSON.parse(source);
860
+ * this.setExport('default', obj);
861
+ * });
862
+ *
863
+ * // Use `module` in linking...
864
+ * ```
865
+ * @since v13.0.0, v12.16.0
866
+ * @experimental
867
+ */
868
+ class SyntheticModule extends Module {
869
+ /**
870
+ * Creates a new `SyntheticModule` instance.
871
+ * @param exportNames Array of names that will be exported from the module.
872
+ * @param evaluateCallback Called when the module is evaluated.
873
+ */
874
+ constructor(
875
+ exportNames: string[],
876
+ evaluateCallback: (this: SyntheticModule) => void,
877
+ options?: SyntheticModuleOptions,
878
+ );
879
+ /**
880
+ * This method is used after the module is linked to set the values of exports. If
881
+ * it is called before the module is linked, an `ERR_VM_MODULE_STATUS` error
882
+ * will be thrown.
883
+ *
884
+ * ```js
885
+ * import vm from 'node:vm';
886
+ *
887
+ * const m = new vm.SyntheticModule(['x'], () => {
888
+ * m.setExport('x', 1);
889
+ * });
890
+ *
891
+ * await m.link(() => {});
892
+ * await m.evaluate();
893
+ *
894
+ * assert.strictEqual(m.namespace.x, 1);
895
+ * ```
896
+ * @since v13.0.0, v12.16.0
897
+ * @param name Name of the export to set.
898
+ * @param value The value to set the export to.
899
+ */
900
+ setExport(name: string, value: any): void;
901
+ }
902
+ /**
903
+ * Returns an object containing commonly used constants for VM operations.
904
+ * @since v20.12.0
905
+ */
906
+ namespace constants {
907
+ /**
908
+ * Stability: 1.1 - Active development
909
+ *
910
+ * A constant that can be used as the `importModuleDynamically` option to `vm.Script`
911
+ * and `vm.compileFunction()` so that Node.js uses the default ESM loader from the main
912
+ * context to load the requested module.
913
+ *
914
+ * For detailed information, see [Support of dynamic `import()` in compilation APIs](https://nodejs.org/docs/latest-v20.x/api/vm.html#support-of-dynamic-import-in-compilation-apis).
915
+ */
916
+ const USE_MAIN_CONTEXT_DEFAULT_LOADER: number;
917
+ }
918
+ }
919
+ declare module "node:vm" {
920
+ export * from "vm";
921
+ }