lib/util/lazyModule.js - main - githubmirror/webpack

lib/util/lazyModule.js

56 строк2 KB

Alexander Akait

perf: load webpack's own modules only when a build needs them (#21652)

10 авг 2026, 07:32

10 авг 2026, 07:328e28763

/*
	MIT License http://www.opensource.org/licenses/mit-license.php
	Author Alexander Akait @alexander-akait
*/

"use strict";

/**
 * Declares a module that loads on first use, in the shape a dynamic `import()`
 * has: the accessor resolves to the module and the caller awaits it. The thunk
 * is a `require` until `lib/` moves to ecma modules, which changes that keyword
 * and nothing else — `Promise.resolve` already passes an `import()` promise
 * through. It is never called outside the promise, so nothing here needs a
 * synchronous load.
 *
 * `loaded` reads the module back for a consumer with nowhere to await — a
 * synchronous hook, a dependency template, a generator. It throws until an
 * awaited call has resolved, so every such consumer must sit behind one
 * (`NormalModuleFactory`'s `prepareModuleType`, `Compilation`'s pending runtime
 * modules). A module with no such boundary is required at the top of its file
 * instead of being declared here.
 * @template T
 * @param {() => T | Promise<T>} load loads the module
 * @returns {LazyModuleAccessor<T>} resolves the module, loading it once
 */
const lazyModule = (load) => {
	/** @type {Promise<T> | undefined} */
	let promise;
	/** @type {T | undefined} */
	let value;
	const get = () => {
		if (promise === undefined) {
			promise = Promise.resolve(load()).then((module) => (value = module));
			// release the loader and everything it holds
			/** @type {(() => T | Promise<T>) | undefined} */
			(load) = undefined;
		}
		return promise;
	};
	get.loaded = () => {
		if (value === undefined) {
			throw new Error(
				"Lazy module was read before an awaited call resolved it; preload it at the nearest async boundary"
			);
		}
		return value;
	};
	return get;
};

/**
 * @template T
 * @typedef {(() => Promise<T>) & { loaded: () => T }} LazyModuleAccessor
 */

module.exports = lazyModule;