Skip to content

docs: suggest import mapping for newer versions #114

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 2 commits into
base: dev
Choose a base branch
from
Open

docs: suggest import mapping for newer versions #114

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09b5f5f
docs: suggest import mapping for newer versions
Nytelife26 Feb 21, 2021
76681ff
docs: format & more examples
Nytelife26 Feb 22, 2021
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
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,21 @@ import module from 'my_private_module'

**WARNING:** If you are going to use this package within another NPM package, please read [Using within another NPM package](#using-within-another-npm-package) first to be aware of potential caveats.

## IMPORTANT - Node v14.6.0+

**WARNING:** If you are using Node v14.6.0 or above, you do not need this
package. A feature was added in Node v14.6.0 called import mapping - you can
find more at the [documentation]. This enables you to map from both import paths
AND dependencies, for both `require` and ESM `import` statements, without
potentially breaking the module resolution order for other packages in a project
(which makes it fully suitable for libraries and a better alternative to this
package).

We will not be deprecating this package so people can still use it for older
versions of Node.

[documentation]: https://nodejs.org/api/packages.html#packages_imports

## Install

```
Expand Down Expand Up @@ -169,6 +184,8 @@ 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).

See [the aforementioned section](#important---node-v1460) for more information
and if you wish to avoid this behaviour (Node 14.6.0+ only).

## Known incompatibilities

Expand Down