Node.js vm.runInThisContext(code[, options])用法及代碼示例

vm.runInThisContext(code[, options])

參數

• code <string> 要編譯和運行的 JavaScript 代碼。
• options <Object>|<string>
  • filename <string> 指定此腳本生成的堆棧跟蹤中使用的文件名。 默認： 'evalmachine.<anonymous>' 。
  • lineOffset <number> 指定在此腳本生成的堆棧跟蹤中顯示的行號偏移量。 默認： 0 。
  • columnOffset <number> 指定在此腳本生成的堆棧跟蹤中顯示的first-line 列號偏移量。 默認： 0 。
  • displayErrors <boolean> 當 true 時，如果在編譯 code 時發生 Error ，則導致錯誤的代碼行附加到堆棧跟蹤。 默認： true 。
  • timeout <integer> 指定在終止執行之前執行 code 的毫秒數。如果執行終止，將拋出 Error 。該值必須是嚴格的正整數。
  • breakOnSigint <boolean>如果true， 接收SIGINT(Ctrl+C) 將終止執行並拋出一個Error.已通過以下方式附加的事件的現有處理程序process.on('SIGINT')在腳本執行期間被禁用，但之後繼續工作。默認： false.
  • cachedData <Buffer> | <TypedArray> | <DataView> 為提供的源提供可選的 Buffer 或 TypedArray 或 DataView 以及 V8 的代碼緩存數據。提供時，cachedDataRejected 值將根據 V8 對數據的接受情況設置為 true 或 false。
  • produceCachedData <boolean>什麽時候true和不cachedData存在時，V8 將嘗試為code.成功後，一個Buffer使用 V8 的代碼緩存數據將被生成並存儲在cachedData歸還的屬性vm.Script實例。這cachedDataProduced值將設置為true或者false取決於代碼緩存數據是否產生成功。這個選項是已棄用有利於script.createCachedData().默認： false.
  • importModuleDynamically <Function>在評估此模塊時調用import()叫做。如果未指定此選項，則調用import()會拒絕ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING.此選項是實驗模塊 API 的一部分。我們不建議在生產環境中使用它。
    • specifier <string> 說明符傳遞給 import()
    • script <vm.Script>
    • importAssertions <Object> "assert" 值傳遞給 optionsExpression 可選參數，如果未提供值，則為空對象。
    • 返回： <Module Namespace Object> | <vm.Module> 建議返回 vm.Module 以利用錯誤跟蹤，並避免包含 then 函數導出的命名空間出現問題。
• 返回： <any> 腳本中執行的最後一條語句的結果。

vm.runInThisContext() 編譯 code ，在當前 global 的上下文中運行它並返回結果。運行代碼無權訪問本地範圍，但可以訪問當前的global 對象。

如果options 是字符串，則它指定文件名。

以下示例說明了使用 vm.runInThisContext() 和 JavaScript eval() 函數來運行相同的代碼：

const vm = require('node:vm');
let localVar = 'initial value';

const vmResult = vm.runInThisContext('localVar = "vm";');
console.log(`vmResult: '${vmResult}', localVar: '${localVar}'`);
// Prints: vmResult: 'vm', localVar: 'initial value'

const evalResult = eval('localVar = "eval";');
console.log(`evalResult: '${evalResult}', localVar: '${localVar}'`);
// Prints: evalResult: 'eval', localVar: 'eval'

因為vm.runInThisContext()無權訪問本地範圍，localVar不變。相比之下，eval()確實可以訪問本地範圍，所以值localVar被改變。這樣vm.runInThisContext()很像一個間接 eval() 調用，例如(0,eval)('code').