Node.js globalPreload()用法及代码示例

globalPreload()

• 返回： <string>

有时可能需要在应用程序运行所在的同一全局范围内运行一些代码。此钩子允许返回一个字符串，该字符串在启动时作为 sloppy-mode 脚本运行。

与CommonJS 包装器的工作方式类似，代码在隐式函数范围内运行。唯一的参数是一个类似于 require 的函数，可用于加载像 "fs": getBuiltin(request: string) 这样的内置函数。

如果代码需要更高级的 require 函数，则必须使用 module.createRequire() 构建自己的 require。

/**
 * @param {{
     port: MessagePort,
   }} utilities Things that preload code might find useful
 * @returns {string} Code to run before application startup
 */
export function globalPreload(utilities) {
  return `\
globalThis.someInjectedProperty = 42;
console.log('I just set some globals!');

const { createRequire } = getBuiltin('module');
const { cwd } = getBuiltin('process');

const require = createRequire(cwd() + '/<preload>');
// [...]
`;
}

为了允许应用程序和加载程序之间进行通信，预加载代码提供了另一个参数：port。这可作为 loader 钩子的参数和钩子返回的源文本内部使用。必须注意正确调用 port.ref() 和 port.unref() 以防止进程处于无法正常关闭的状态。

/**
 * This example has the application context send a message to the loader
 * and sends the message back to the application context
 * @param {{
     port: MessagePort,
   }} utilities Things that preload code might find useful
 * @returns {string} Code to run before application startup
 */
export function globalPreload({ port }) {
  port.onmessage = (evt) => {
    port.postMessage(evt.data);
  };
  return `\
    port.postMessage('console.log("I went to the Loader and back");');
    port.onmessage = (evt) => {
      eval(evt.data);
    };
  `;
}