This change updates the usage instructions in the README to explain the workaround required to use this module. As userland modules do not hide core modules, a trailing slash is required to have Node.js use this module over the built-in.
Note: I personally think this is confusing, but since this is the preferred workaround (per this comment) and this module is what the official Node.js docs recommend,[1] it is worth clarifying.
mathiasbynens
commented
3 years ago
Refs #79
This change updates the usage instructions in the README to explain the workaround required to use this module. As userland modules do not hide core modules, a trailing slash is required to have Node.js use this module over the built-in.
I copied the warning text from the
node/no-deprecated-apidocs.Note: I personally think this is confusing, but since this is the preferred workaround (per this comment) and this module is what the official Node.js docs recommend,[1] it is worth clarifying.