Skip to content

Commit

Permalink
Doc update: include "Usage with esm"
Browse files Browse the repository at this point in the history
- Closes #99
  • Loading branch information
Kehrlann committed Sep 27, 2020
1 parent 0d946df commit 0ab998c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
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

0 comments on commit 0ab998c

Please sign in to comment.