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