suggest dynamic import() as a viable alternative to importing ESM

remix-run · Apr 23, 2023 · e2e7e92 · e2e7e92
1 parent 605b580
commit e2e7e92
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/pages/gotchas.md b/docs/pages/gotchas.md
@@ -116,6 +116,15 @@ module.exports = {
 };
 ```
 
+In rare circumstances, some Node.js packages are ESM-only and does not work properly when bundled. In such cases, you can use dynamic import to import the module. For example:
+
+```js filename=index.js
+export const loader = async (args: LoaderArgs) => {
+  const lib = await import('that-esm-only-lib-that-shall-not-be-bundled')
+  return lib.handleRequest(args.request)
+}
+```
+
 > Why does this happen?
 
 Remix compiles your server build to CJS and doesn't bundle your node modules. CJS modules can't import ESM modules.