resolve(specifier, context, nextResolve)


稳定性: 1.2 - 发布候选版

  • specifier <string>
  • context <Object>
    • conditions <string[]> 导出相关 package.json 的条件
    • importAttributes <Object> 一个对象,其键值对表示要导入模块的属性
    • parentURL <string> | <undefined> 导入此模块的模块,或者如果这是 Node.js 的入口点,则为 undefined
  • nextResolve <Function> 链中后续的 resolve 钩子,或在最后一个用户提供的 resolve 钩子之后的 Node.js 默认 resolve 钩子
  • 返回:<Object> | <Promise>
    • format <string> | <null> | <undefined> 对加载钩子的提示(可能会被忽略) 'builtin' | 'commonjs' | 'json' | 'module' | 'wasm'
    • importAttributes <Object> | <undefined> 缓存模块时使用的导入属性(可选;如果省略,则使用输入)
    • shortCircuit <undefined> | <boolean> 一个信号,表示此钩子打算终止 resolve 钩子的链条。默认值: false
    • url <string> 此输入解析后的绝对 URL

警告 尽管支持返回 Promise 和异步函数,但调用 resolve 可能会阻塞主线程,从而影响性能。

resolve 钩子链负责告诉 Node.js 在哪里查找以及如何缓存给定的 import 语句或表达式,或 require 调用。它可以选择性地返回一个格式(例如 'module')作为 load 钩子的提示。如果指定了格式,load 钩子最终负责提供最终的 format 值(并且可以忽略 resolve 提供的提示);如果 resolve 提供了 format,即使只是为了将该值传递给 Node.js 的默认 load 钩子,也需要自定义 load 钩子。

【The resolve hook chain is responsible for telling Node.js where to find and how to cache a given import statement or expression, or require call. It can optionally return a format (such as 'module') as a hint to the load hook. If a format is specified, the load hook is ultimately responsible for providing the final format value (and it is free to ignore the hint provided by resolve); if resolve provides a format, a custom load hook is required even if only to pass the value to the Node.js default load hook.】

导入类型属性是将加载的模块保存到内部模块缓存中的缓存键的一部分。如果模块应以不同于源代码中存在的属性进行缓存,resolve 钩子负责返回一个 importAttributes 对象。

【Import type attributes are part of the cache key for saving loaded modules into the internal module cache. The resolve hook is responsible for returning an importAttributes object if the module should be cached with different attributes than were present in the source code.】

context 中的 conditions 属性是一个适用于此解析请求的 包导出条件 条件数组。它们可以用于在其他地方查找条件映射,或者在调用默认解析逻辑时修改列表。

【The conditions property in context is an array of conditions for package exports conditions that apply to this resolution request. They can be used for looking up conditional mappings elsewhere or to modify the list when calling the default resolution logic.】

当前的 包导出条件 总是包含在传入 hook 的 context.conditions 数组中。为了在调用 defaultResolve 时保证 默认的 Node.js 模块指定符解析行为,传递给它的 context.conditions 数组 必须 包含最初传入 resolve hook 的 context.conditions 数组的 所有 元素。

【The current package exports conditions are always in the context.conditions array passed into the hook. To guarantee default Node.js module specifier resolution behavior when calling defaultResolve, the context.conditions array passed to it must include all elements of the context.conditions array originally passed into the resolve hook.】

export async function resolve(specifier, context, nextResolve) {
  const { parentURL = null } = context;

  if (Math.random() > 0.5) { // Some condition.
    // For some or all specifiers, do some custom logic for resolving.
    // Always return an object of the form {url: <string>}.
    return {
      shortCircuit: true,
      url: parentURL ?
        new URL(specifier, parentURL).href :
        new URL(specifier).href,
    };
  }

  if (Math.random() < 0.5) { // Another condition.
    // When calling `defaultResolve`, the arguments can be modified. In this
    // case it's adding another value for matching conditional exports.
    return nextResolve(specifier, {
      ...context,
      conditions: [...context.conditions, 'another-condition'],
    });
  }

  // Defer to the next hook in the chain, which would be the
  // Node.js default resolve if this is the last user-specified loader.
  return nextResolve(specifier);
}