Skip to content

docs(utils): document bundle module loader #5899

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
killagu wants to merge 2 commits into from
+12 −0
Closed

docs(utils): document bundle module loader #5899

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0ff522
docs(utils): document bundle module loader
killagu Apr 26, 2026
a49016f
docs(utils): clarify bundle module loader docs
killagu Apr 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions packages/utils/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,18 @@ npm i @eggjs/utils
- {String} baseDir - the current directory of application
- {String} framework - the directory of framework

### `setBundleModuleLoader(loader)`

Register a bundle module loader for `importModule()`. The loader is shared globally via `globalThis` across all instances of `@eggjs/utils` in the same process.

- {Function|undefined} loader - a synchronous hook called with a POSIX-normalized filepath or virtual specifier before normal module resolution.

Return `undefined` from the loader to fall back to standard module resolution. Otherwise, return the module exports synchronously; any non-`undefined` return value is treated as a bundle hit and uses the same default export handling as `importModule()`, including `importDefaultOnly` and double-default `__esModule` compatibility.

The loader must not be an `async` function or return a `Promise`, because `importModule()` does not `await` the hook.

Pass `undefined` to clear the registered loader.

## License

[MIT](LICENSE)
Expand Down
Loading