@rio-cloud/cdk-v2-constructs 8.2.0 → 8.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (179) hide show
  1. package/.jsii +2 -2
  2. package/node_modules/@types/node/README.md +3 -3
  3. package/node_modules/@types/node/assert/strict.d.ts +105 -2
  4. package/node_modules/@types/node/assert.d.ts +211 -92
  5. package/node_modules/@types/node/async_hooks.d.ts +103 -19
  6. package/node_modules/@types/node/buffer.buffer.d.ts +472 -0
  7. package/node_modules/@types/node/buffer.d.ts +88 -516
  8. package/node_modules/@types/node/child_process.d.ts +167 -231
  9. package/node_modules/@types/node/cluster.d.ts +172 -26
  10. package/node_modules/@types/node/compatibility/iterators.d.ts +21 -0
  11. package/node_modules/@types/node/console.d.ts +66 -28
  12. package/node_modules/@types/node/constants.d.ts +14 -12
  13. package/node_modules/@types/node/crypto.d.ts +1458 -497
  14. package/node_modules/@types/node/dgram.d.ts +44 -30
  15. package/node_modules/@types/node/diagnostics_channel.d.ts +389 -4
  16. package/node_modules/@types/node/dns/promises.d.ts +120 -42
  17. package/node_modules/@types/node/dns.d.ts +209 -95
  18. package/node_modules/@types/node/domain.d.ts +14 -18
  19. package/node_modules/@types/node/events.d.ts +245 -113
  20. package/node_modules/@types/node/fs/promises.d.ts +194 -96
  21. package/node_modules/@types/node/fs.d.ts +695 -270
  22. package/node_modules/@types/node/globals.d.ts +97 -308
  23. package/node_modules/@types/node/globals.typedarray.d.ts +41 -0
  24. package/node_modules/@types/node/http.d.ts +363 -97
  25. package/node_modules/@types/node/http2.d.ts +684 -231
  26. package/node_modules/@types/node/https.d.ts +122 -87
  27. package/node_modules/@types/node/index.d.ts +24 -11
  28. package/node_modules/@types/node/inspector.d.ts +220 -2690
  29. package/node_modules/@types/node/inspector.generated.d.ts +4239 -0
  30. package/node_modules/@types/node/module.d.ts +705 -149
  31. package/node_modules/@types/node/net.d.ts +178 -54
  32. package/node_modules/@types/node/os.d.ts +47 -17
  33. package/node_modules/@types/node/package.json +22 -97
  34. package/node_modules/@types/node/path.d.ts +12 -3
  35. package/node_modules/@types/node/perf_hooks.d.ts +500 -97
  36. package/node_modules/@types/node/process.d.ts +657 -87
  37. package/node_modules/@types/node/punycode.d.ts +5 -5
  38. package/node_modules/@types/node/querystring.d.ts +24 -13
  39. package/node_modules/@types/node/readline/promises.d.ts +25 -14
  40. package/node_modules/@types/node/readline.d.ts +102 -41
  41. package/node_modules/@types/node/repl.d.ts +38 -30
  42. package/node_modules/@types/node/sea.d.ts +162 -0
  43. package/node_modules/@types/node/sqlite.d.ts +1040 -0
  44. package/node_modules/@types/node/stream/consumers.d.ts +33 -7
  45. package/node_modules/@types/node/stream/promises.d.ts +8 -1
  46. package/node_modules/@types/node/stream/web.d.ts +251 -28
  47. package/node_modules/@types/node/stream.d.ts +1060 -1055
  48. package/node_modules/@types/node/string_decoder.d.ts +8 -8
  49. package/node_modules/@types/node/test.d.ts +2133 -1166
  50. package/node_modules/@types/node/timers/promises.d.ts +31 -16
  51. package/node_modules/@types/node/timers.d.ts +159 -114
  52. package/node_modules/@types/node/tls.d.ts +232 -163
  53. package/node_modules/@types/node/trace_events.d.ts +43 -28
  54. package/node_modules/@types/node/ts5.6/buffer.buffer.d.ts +468 -0
  55. package/node_modules/@types/node/ts5.6/compatibility/float16array.d.ts +71 -0
  56. package/node_modules/@types/node/ts5.6/globals.typedarray.d.ts +36 -0
  57. package/node_modules/@types/node/ts5.6/index.d.ts +103 -0
  58. package/node_modules/@types/node/ts5.7/compatibility/float16array.d.ts +72 -0
  59. package/node_modules/@types/node/ts5.7/index.d.ts +103 -0
  60. package/node_modules/@types/node/tty.d.ts +9 -9
  61. package/node_modules/@types/node/url.d.ts +236 -84
  62. package/node_modules/@types/node/util.d.ts +562 -412
  63. package/node_modules/@types/node/v8.d.ts +368 -21
  64. package/node_modules/@types/node/vm.d.ts +443 -149
  65. package/node_modules/@types/node/wasi.d.ts +62 -18
  66. package/node_modules/@types/node/web-globals/abortcontroller.d.ts +34 -0
  67. package/node_modules/@types/node/web-globals/crypto.d.ts +32 -0
  68. package/node_modules/@types/node/web-globals/domexception.d.ts +68 -0
  69. package/node_modules/@types/node/web-globals/events.d.ts +97 -0
  70. package/node_modules/@types/node/web-globals/fetch.d.ts +62 -0
  71. package/node_modules/@types/node/web-globals/navigator.d.ts +25 -0
  72. package/node_modules/@types/node/web-globals/storage.d.ts +24 -0
  73. package/node_modules/@types/node/web-globals/streams.d.ts +22 -0
  74. package/node_modules/@types/node/worker_threads.d.ts +310 -107
  75. package/node_modules/@types/node/zlib.d.ts +301 -73
  76. package/node_modules/undici-types/LICENSE +21 -0
  77. package/node_modules/undici-types/agent.d.ts +13 -12
  78. package/node_modules/undici-types/api.d.ts +26 -26
  79. package/node_modules/undici-types/balanced-pool.d.ts +19 -7
  80. package/node_modules/undici-types/cache-interceptor.d.ts +173 -0
  81. package/node_modules/undici-types/client-stats.d.ts +15 -0
  82. package/node_modules/undici-types/client.d.ts +26 -15
  83. package/node_modules/undici-types/connector.d.ts +2 -2
  84. package/node_modules/undici-types/cookies.d.ts +2 -0
  85. package/node_modules/undici-types/diagnostics-channel.d.ts +19 -12
  86. package/node_modules/undici-types/dispatcher.d.ts +148 -113
  87. package/node_modules/undici-types/env-http-proxy-agent.d.ts +22 -0
  88. package/node_modules/undici-types/errors.d.ts +79 -46
  89. package/node_modules/undici-types/eventsource.d.ts +66 -0
  90. package/node_modules/undici-types/fetch.d.ts +41 -39
  91. package/node_modules/undici-types/formdata.d.ts +8 -8
  92. package/node_modules/undici-types/global-dispatcher.d.ts +4 -4
  93. package/node_modules/undici-types/global-origin.d.ts +5 -5
  94. package/node_modules/undici-types/h2c-client.d.ts +73 -0
  95. package/node_modules/undici-types/handlers.d.ts +11 -5
  96. package/node_modules/undici-types/header.d.ts +157 -1
  97. package/node_modules/undici-types/index.d.ts +68 -43
  98. package/node_modules/undici-types/interceptors.d.ts +71 -3
  99. package/node_modules/undici-types/mock-agent.d.ts +36 -18
  100. package/node_modules/undici-types/mock-call-history.d.ts +111 -0
  101. package/node_modules/undici-types/mock-client.d.ts +6 -4
  102. package/node_modules/undici-types/mock-errors.d.ts +3 -3
  103. package/node_modules/undici-types/mock-interceptor.d.ts +24 -23
  104. package/node_modules/undici-types/mock-pool.d.ts +6 -4
  105. package/node_modules/undici-types/package.json +1 -1
  106. package/node_modules/undici-types/patch.d.ts +0 -42
  107. package/node_modules/undici-types/pool-stats.d.ts +8 -8
  108. package/node_modules/undici-types/pool.d.ts +21 -8
  109. package/node_modules/undici-types/proxy-agent.d.ts +5 -6
  110. package/node_modules/undici-types/readable.d.ts +24 -17
  111. package/node_modules/undici-types/retry-agent.d.ts +8 -0
  112. package/node_modules/undici-types/retry-handler.d.ts +125 -0
  113. package/node_modules/undici-types/round-robin-pool.d.ts +41 -0
  114. package/node_modules/undici-types/snapshot-agent.d.ts +109 -0
  115. package/node_modules/undici-types/util.d.ts +18 -0
  116. package/node_modules/undici-types/utility.d.ts +7 -0
  117. package/node_modules/undici-types/webidl.d.ts +157 -36
  118. package/node_modules/undici-types/websocket.d.ts +67 -12
  119. package/package.json +9 -60
  120. package/version.json +1 -1
  121. package/node_modules/@types/node/dom-events.d.ts +0 -122
  122. package/node_modules/@types/node/globals.global.d.ts +0 -1
  123. package/node_modules/@types/node/ts4.8/assert/strict.d.ts +0 -8
  124. package/node_modules/@types/node/ts4.8/assert.d.ts +0 -996
  125. package/node_modules/@types/node/ts4.8/async_hooks.d.ts +0 -539
  126. package/node_modules/@types/node/ts4.8/buffer.d.ts +0 -2362
  127. package/node_modules/@types/node/ts4.8/child_process.d.ts +0 -1540
  128. package/node_modules/@types/node/ts4.8/cluster.d.ts +0 -432
  129. package/node_modules/@types/node/ts4.8/console.d.ts +0 -415
  130. package/node_modules/@types/node/ts4.8/constants.d.ts +0 -19
  131. package/node_modules/@types/node/ts4.8/crypto.d.ts +0 -4455
  132. package/node_modules/@types/node/ts4.8/dgram.d.ts +0 -586
  133. package/node_modules/@types/node/ts4.8/diagnostics_channel.d.ts +0 -191
  134. package/node_modules/@types/node/ts4.8/dns/promises.d.ts +0 -425
  135. package/node_modules/@types/node/ts4.8/dns.d.ts +0 -809
  136. package/node_modules/@types/node/ts4.8/dom-events.d.ts +0 -122
  137. package/node_modules/@types/node/ts4.8/domain.d.ts +0 -170
  138. package/node_modules/@types/node/ts4.8/events.d.ts +0 -796
  139. package/node_modules/@types/node/ts4.8/fs/promises.d.ts +0 -1232
  140. package/node_modules/@types/node/ts4.8/fs.d.ts +0 -4289
  141. package/node_modules/@types/node/ts4.8/globals.d.ts +0 -381
  142. package/node_modules/@types/node/ts4.8/globals.global.d.ts +0 -1
  143. package/node_modules/@types/node/ts4.8/http.d.ts +0 -1888
  144. package/node_modules/@types/node/ts4.8/http2.d.ts +0 -2382
  145. package/node_modules/@types/node/ts4.8/https.d.ts +0 -550
  146. package/node_modules/@types/node/ts4.8/index.d.ts +0 -88
  147. package/node_modules/@types/node/ts4.8/inspector.d.ts +0 -2747
  148. package/node_modules/@types/node/ts4.8/module.d.ts +0 -287
  149. package/node_modules/@types/node/ts4.8/net.d.ts +0 -949
  150. package/node_modules/@types/node/ts4.8/os.d.ts +0 -477
  151. package/node_modules/@types/node/ts4.8/path.d.ts +0 -191
  152. package/node_modules/@types/node/ts4.8/perf_hooks.d.ts +0 -639
  153. package/node_modules/@types/node/ts4.8/process.d.ts +0 -1532
  154. package/node_modules/@types/node/ts4.8/punycode.d.ts +0 -117
  155. package/node_modules/@types/node/ts4.8/querystring.d.ts +0 -141
  156. package/node_modules/@types/node/ts4.8/readline/promises.d.ts +0 -150
  157. package/node_modules/@types/node/ts4.8/readline.d.ts +0 -539
  158. package/node_modules/@types/node/ts4.8/repl.d.ts +0 -430
  159. package/node_modules/@types/node/ts4.8/stream/consumers.d.ts +0 -12
  160. package/node_modules/@types/node/ts4.8/stream/promises.d.ts +0 -83
  161. package/node_modules/@types/node/ts4.8/stream/web.d.ts +0 -350
  162. package/node_modules/@types/node/ts4.8/stream.d.ts +0 -1701
  163. package/node_modules/@types/node/ts4.8/string_decoder.d.ts +0 -67
  164. package/node_modules/@types/node/ts4.8/test.d.ts +0 -1382
  165. package/node_modules/@types/node/ts4.8/timers/promises.d.ts +0 -93
  166. package/node_modules/@types/node/ts4.8/timers.d.ts +0 -240
  167. package/node_modules/@types/node/ts4.8/tls.d.ts +0 -1210
  168. package/node_modules/@types/node/ts4.8/trace_events.d.ts +0 -182
  169. package/node_modules/@types/node/ts4.8/tty.d.ts +0 -208
  170. package/node_modules/@types/node/ts4.8/url.d.ts +0 -927
  171. package/node_modules/@types/node/ts4.8/util.d.ts +0 -2186
  172. package/node_modules/@types/node/ts4.8/v8.d.ts +0 -635
  173. package/node_modules/@types/node/ts4.8/vm.d.ts +0 -901
  174. package/node_modules/@types/node/ts4.8/wasi.d.ts +0 -158
  175. package/node_modules/@types/node/ts4.8/worker_threads.d.ts +0 -691
  176. package/node_modules/@types/node/ts4.8/zlib.d.ts +0 -517
  177. package/node_modules/argparse/CHANGELOG.md +0 -216
  178. package/node_modules/undici-types/file.d.ts +0 -39
  179. package/node_modules/undici-types/filereader.d.ts +0 -54
@@ -1,901 +0,0 @@
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 { ImportAssertions } 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, importAssertions: ImportAssertions) => 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
- assert: Object;
597
- },
598
- ) => Module | Promise<Module>;
599
- type ModuleStatus = "unlinked" | "linking" | "linked" | "evaluating" | "evaluated" | "errored";
600
- /**
601
- * This feature is only available with the `--experimental-vm-modules` command
602
- * flag enabled.
603
- *
604
- * The `vm.Module` class provides a low-level interface for using
605
- * ECMAScript modules in VM contexts. It is the counterpart of the `vm.Script`class that closely mirrors [Module Record](https://www.ecma-international.org/ecma-262/#sec-abstract-module-records)
606
- * s as defined in the ECMAScript
607
- * specification.
608
- *
609
- * Unlike `vm.Script` however, every `vm.Module` object is bound to a context from
610
- * its creation. Operations on `vm.Module` objects are intrinsically asynchronous,
611
- * in contrast with the synchronous nature of `vm.Script` objects. The use of
612
- * 'async' functions can help with manipulating `vm.Module` objects.
613
- *
614
- * Using a `vm.Module` object requires three distinct steps: creation/parsing,
615
- * linking, and evaluation. These three steps are illustrated in the following
616
- * example.
617
- *
618
- * This implementation lies at a lower level than the `ECMAScript Module
619
- * loader`. There is also no way to interact with the Loader yet, though
620
- * support is planned.
621
- *
622
- * ```js
623
- * import vm from 'node:vm';
624
- *
625
- * const contextifiedObject = vm.createContext({
626
- * secret: 42,
627
- * print: console.log,
628
- * });
629
- *
630
- * // Step 1
631
- * //
632
- * // Create a Module by constructing a new `vm.SourceTextModule` object. This
633
- * // parses the provided source text, throwing a `SyntaxError` if anything goes
634
- * // wrong. By default, a Module is created in the top context. But here, we
635
- * // specify `contextifiedObject` as the context this Module belongs to.
636
- * //
637
- * // Here, we attempt to obtain the default export from the module "foo", and
638
- * // put it into local binding "secret".
639
- *
640
- * const bar = new vm.SourceTextModule(`
641
- * import s from 'foo';
642
- * s;
643
- * print(s);
644
- * `, { context: contextifiedObject });
645
- *
646
- * // Step 2
647
- * //
648
- * // "Link" the imported dependencies of this Module to it.
649
- * //
650
- * // The provided linking callback (the "linker") accepts two arguments: the
651
- * // parent module (`bar` in this case) and the string that is the specifier of
652
- * // the imported module. The callback is expected to return a Module that
653
- * // corresponds to the provided specifier, with certain requirements documented
654
- * // in `module.link()`.
655
- * //
656
- * // If linking has not started for the returned Module, the same linker
657
- * // callback will be called on the returned Module.
658
- * //
659
- * // Even top-level Modules without dependencies must be explicitly linked. The
660
- * // callback provided would never be called, however.
661
- * //
662
- * // The link() method returns a Promise that will be resolved when all the
663
- * // Promises returned by the linker resolve.
664
- * //
665
- * // Note: This is a contrived example in that the linker function creates a new
666
- * // "foo" module every time it is called. In a full-fledged module system, a
667
- * // cache would probably be used to avoid duplicated modules.
668
- *
669
- * async function linker(specifier, referencingModule) {
670
- * if (specifier === 'foo') {
671
- * return new vm.SourceTextModule(`
672
- * // The "secret" variable refers to the global variable we added to
673
- * // "contextifiedObject" when creating the context.
674
- * export default secret;
675
- * `, { context: referencingModule.context });
676
- *
677
- * // Using `contextifiedObject` instead of `referencingModule.context`
678
- * // here would work as well.
679
- * }
680
- * throw new Error(`Unable to resolve dependency: ${specifier}`);
681
- * }
682
- * await bar.link(linker);
683
- *
684
- * // Step 3
685
- * //
686
- * // Evaluate the Module. The evaluate() method returns a promise which will
687
- * // resolve after the module has finished evaluating.
688
- *
689
- * // Prints 42.
690
- * await bar.evaluate();
691
- * ```
692
- * @since v13.0.0, v12.16.0
693
- * @experimental
694
- */
695
- class Module {
696
- /**
697
- * The specifiers of all dependencies of this module. The returned array is frozen
698
- * to disallow any changes to it.
699
- *
700
- * Corresponds to the `[[RequestedModules]]` field of [Cyclic Module Record](https://tc39.es/ecma262/#sec-cyclic-module-records) s in
701
- * the ECMAScript specification.
702
- */
703
- dependencySpecifiers: readonly string[];
704
- /**
705
- * If the `module.status` is `'errored'`, this property contains the exception
706
- * thrown by the module during evaluation. If the status is anything else,
707
- * accessing this property will result in a thrown exception.
708
- *
709
- * The value `undefined` cannot be used for cases where there is not a thrown
710
- * exception due to possible ambiguity with `throw undefined;`.
711
- *
712
- * Corresponds to the `[[EvaluationError]]` field of [Cyclic Module Record](https://tc39.es/ecma262/#sec-cyclic-module-records) s
713
- * in the ECMAScript specification.
714
- */
715
- error: any;
716
- /**
717
- * The identifier of the current module, as set in the constructor.
718
- */
719
- identifier: string;
720
- context: Context;
721
- /**
722
- * The namespace object of the module. This is only available after linking
723
- * (`module.link()`) has completed.
724
- *
725
- * Corresponds to the [GetModuleNamespace](https://tc39.es/ecma262/#sec-getmodulenamespace) abstract operation in the ECMAScript
726
- * specification.
727
- */
728
- namespace: Object;
729
- /**
730
- * The current status of the module. Will be one of:
731
- *
732
- * * `'unlinked'`: `module.link()` has not yet been called.
733
- * * `'linking'`: `module.link()` has been called, but not all Promises returned
734
- * by the linker function have been resolved yet.
735
- * * `'linked'`: The module has been linked successfully, and all of its
736
- * dependencies are linked, but `module.evaluate()` has not yet been called.
737
- * * `'evaluating'`: The module is being evaluated through a `module.evaluate()` on
738
- * itself or a parent module.
739
- * * `'evaluated'`: The module has been successfully evaluated.
740
- * * `'errored'`: The module has been evaluated, but an exception was thrown.
741
- *
742
- * 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'`
743
- * corresponds to`'evaluated'` in the specification, but with `[[EvaluationError]]` set to a
744
- * value that is not `undefined`.
745
- */
746
- status: ModuleStatus;
747
- /**
748
- * Evaluate the module.
749
- *
750
- * This must be called after the module has been linked; otherwise it will reject.
751
- * It could be called also when the module has already been evaluated, in which
752
- * case it will either do nothing if the initial evaluation ended in success
753
- * (`module.status` is `'evaluated'`) or it will re-throw the exception that the
754
- * initial evaluation resulted in (`module.status` is `'errored'`).
755
- *
756
- * This method cannot be called while the module is being evaluated
757
- * (`module.status` is `'evaluating'`).
758
- *
759
- * 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
760
- * ECMAScript specification.
761
- * @return Fulfills with `undefined` upon success.
762
- */
763
- evaluate(options?: ModuleEvaluateOptions): Promise<void>;
764
- /**
765
- * Link module dependencies. This method must be called before evaluation, and
766
- * can only be called once per module.
767
- *
768
- * The function is expected to return a `Module` object or a `Promise` that
769
- * eventually resolves to a `Module` object. The returned `Module` must satisfy the
770
- * following two invariants:
771
- *
772
- * * It must belong to the same context as the parent `Module`.
773
- * * Its `status` must not be `'errored'`.
774
- *
775
- * If the returned `Module`'s `status` is `'unlinked'`, this method will be
776
- * recursively called on the returned `Module` with the same provided `linker`function.
777
- *
778
- * `link()` returns a `Promise` that will either get resolved when all linking
779
- * instances resolve to a valid `Module`, or rejected if the linker function either
780
- * throws an exception or returns an invalid `Module`.
781
- *
782
- * The linker function roughly corresponds to the implementation-defined [HostResolveImportedModule](https://tc39.es/ecma262/#sec-hostresolveimportedmodule) abstract operation in the
783
- * ECMAScript
784
- * specification, with a few key differences:
785
- *
786
- * * The linker function is allowed to be asynchronous while [HostResolveImportedModule](https://tc39.es/ecma262/#sec-hostresolveimportedmodule) is synchronous.
787
- *
788
- * The actual [HostResolveImportedModule](https://tc39.es/ecma262/#sec-hostresolveimportedmodule) implementation used during module
789
- * linking is one that returns the modules linked during linking. Since at
790
- * that point all modules would have been fully linked already, the [HostResolveImportedModule](https://tc39.es/ecma262/#sec-hostresolveimportedmodule) implementation is fully synchronous per
791
- * specification.
792
- *
793
- * 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
794
- * the ECMAScript specification.
795
- */
796
- link(linker: ModuleLinker): Promise<void>;
797
- }
798
- interface SourceTextModuleOptions {
799
- /**
800
- * String used in stack traces.
801
- * @default 'vm:module(i)' where i is a context-specific ascending index.
802
- */
803
- identifier?: string | undefined;
804
- cachedData?: ScriptOptions["cachedData"] | undefined;
805
- context?: Context | undefined;
806
- lineOffset?: BaseOptions["lineOffset"] | undefined;
807
- columnOffset?: BaseOptions["columnOffset"] | undefined;
808
- /**
809
- * Called during evaluation of this module to initialize the `import.meta`.
810
- */
811
- initializeImportMeta?: ((meta: ImportMeta, module: SourceTextModule) => void) | undefined;
812
- importModuleDynamically?: ScriptOptions["importModuleDynamically"] | undefined;
813
- }
814
- /**
815
- * This feature is only available with the `--experimental-vm-modules` command
816
- * flag enabled.
817
- *
818
- * The `vm.SourceTextModule` class provides the [Source Text Module Record](https://tc39.es/ecma262/#sec-source-text-module-records) as
819
- * defined in the ECMAScript specification.
820
- * @since v9.6.0
821
- * @experimental
822
- */
823
- class SourceTextModule extends Module {
824
- /**
825
- * Creates a new `SourceTextModule` instance.
826
- * @param code JavaScript Module code to parse
827
- */
828
- constructor(code: string, options?: SourceTextModuleOptions);
829
- }
830
- interface SyntheticModuleOptions {
831
- /**
832
- * String used in stack traces.
833
- * @default 'vm:module(i)' where i is a context-specific ascending index.
834
- */
835
- identifier?: string | undefined;
836
- /**
837
- * The contextified object as returned by the `vm.createContext()` method, to compile and evaluate this module in.
838
- */
839
- context?: Context | undefined;
840
- }
841
- /**
842
- * This feature is only available with the `--experimental-vm-modules` command
843
- * flag enabled.
844
- *
845
- * The `vm.SyntheticModule` class provides the [Synthetic Module Record](https://heycam.github.io/webidl/#synthetic-module-records) as
846
- * defined in the WebIDL specification. The purpose of synthetic modules is to
847
- * provide a generic interface for exposing non-JavaScript sources to ECMAScript
848
- * module graphs.
849
- *
850
- * ```js
851
- * const vm = require('node:vm');
852
- *
853
- * const source = '{ "a": 1 }';
854
- * const module = new vm.SyntheticModule(['default'], function() {
855
- * const obj = JSON.parse(source);
856
- * this.setExport('default', obj);
857
- * });
858
- *
859
- * // Use `module` in linking...
860
- * ```
861
- * @since v13.0.0, v12.16.0
862
- * @experimental
863
- */
864
- class SyntheticModule extends Module {
865
- /**
866
- * Creates a new `SyntheticModule` instance.
867
- * @param exportNames Array of names that will be exported from the module.
868
- * @param evaluateCallback Called when the module is evaluated.
869
- */
870
- constructor(
871
- exportNames: string[],
872
- evaluateCallback: (this: SyntheticModule) => void,
873
- options?: SyntheticModuleOptions,
874
- );
875
- /**
876
- * This method is used after the module is linked to set the values of exports. If
877
- * it is called before the module is linked, an `ERR_VM_MODULE_STATUS` error
878
- * will be thrown.
879
- *
880
- * ```js
881
- * import vm from 'node:vm';
882
- *
883
- * const m = new vm.SyntheticModule(['x'], () => {
884
- * m.setExport('x', 1);
885
- * });
886
- *
887
- * await m.link(() => {});
888
- * await m.evaluate();
889
- *
890
- * assert.strictEqual(m.namespace.x, 1);
891
- * ```
892
- * @since v13.0.0, v12.16.0
893
- * @param name Name of the export to set.
894
- * @param value The value to set the export to.
895
- */
896
- setExport(name: string, value: any): void;
897
- }
898
- }
899
- declare module "node:vm" {
900
- export * from "vm";
901
- }