Skip to content

docs(utils): document bundle module loader #5903

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

Merged
killagu merged 2 commits into from
May 2, 2026
+16 −0
Merged

docs(utils): document bundle module loader #5903

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8edff8d
docs(utils): document bundle module loader
killagu Apr 30, 2026
17fa28b
docs(utils): clarify bundle loader input
killagu Apr 30, 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
16 changes: 16 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,22 @@ npm i @eggjs/utils
- {String} baseDir - the current directory of application
- {String} framework - the directory of framework

### `setBundleModuleLoader(loader)`

Register a module loader hook for bundled Egg apps. The hook runs before the
normal `importModule()` resolution path.

- {Function | undefined} loader - a synchronous function that receives the
original `filepath` argument passed to `importModule()` after POSIX separator
normalization, or a virtual specifier. It does not receive the resolved
absolute file path from `importResolve()`. Return `undefined` to fall back to
the normal import path.

The bundle loader is stored on `globalThis`, so bundled and external copies of
`@eggjs/utils` share the same loader. Non-`undefined` results follow the same
default export unwrapping rules as `importModule()`, including
`importDefaultOnly`.

## License

[MIT](LICENSE)
Expand Down
Loading