Skip to content

Doc update: include "Usage with esm" #107

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

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Doc update: include "Usage with esm" #107

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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,14 @@ You can use `module-alias` within another NPM package, however there are a few t
Here is an [example project](https://github.com/Kehrlann/module-alias-library).


## Usage with esm

[esm](https://www.npmjs.com/package/esm) tries to handle all imports when parsing a file, before actually loading any module. This means module-alias' `register` call will not be processed in time. To make `module-alias` work with `esm`, please consider using:

```
node -r module-alias/register -r esm index.js
```

## Known incompatibilities

This module does not play well with:
Expand Down