Skip to content

docs: document setBundleModuleLoader API #5900

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

Draft
killagu wants to merge 1 commit into
base: next
Choose a base branch
from
Draft

docs: document setBundleModuleLoader API #5900

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 21 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,27 @@ npm i @eggjs/utils
- {String} baseDir - the current directory of application
- {String} framework - the directory of framework

### `setBundleModuleLoader(loader)`

Register a custom module loader for bundled Egg applications.

- {Function|undefined} loader - receives a POSIX-normalized filepath or virtual specifier before normal module resolution
- Return `undefined` from the loader to fall through to the default `importModule()` behavior
- Non-`undefined` return values are treated as module exports and keep the same `importDefaultOnly` and `__esModule` compatibility handling as normal imports
- Pass `undefined` to clear the registered loader

```ts
import { importModule, setBundleModuleLoader } from '@eggjs/utils';

setBundleModuleLoader((filepath) => {
if (filepath === 'virtual/config') {
return { default: { name: 'egg' } };
}
});

const config = await importModule('virtual/config', { importDefaultOnly: true });
```

## License

[MIT](LICENSE)
Expand Down
Loading