What is the “module” package.json field for?

by

Update: April 2022

The module field is not officially defined by Node.js and support is not planned. Instead, the Node.js community settled on package exports which they believe is more versatile.

For practical reasons JavaScript bundlers will continue to support the module field. The esbuild docs explain when to use module as well as related fields main and browser.

Original Answer

Is "module" an official npm property or is this a convention of some kind?

It’s a proposal, but likely to be supported due to de facto usage.

Is there documentation for this somewhere?

There is, in fact, and it can be found right here and later removed here.

What’s it for?

ES6 Module Interoperability in Node. Additional discussion can be found here and here. And here’s a blog post from Rich Harris talking more about it.

More Related Contents:

  1. How do I completely uninstall Node.js, and reinstall from beginning (Mac OS X)
  2. Node.js – SyntaxError: Unexpected token import
  3. Sending command line arguments to npm script
  4. SyntaxError: Cannot use import statement outside a module
  5. What is the meaning of the “at” (@) prefix on npm packages?
  6. Difference between npx and npm?
  7. How do we or can we use node modules via npm with Meteor?
  8. Module not found: Error: Can’t resolve ‘crypto’
  9. Deleting `package-lock.json` to Resolve Conflicts quickly
  10. What does ‘x packages are looking for funding’ mean when running `npm install`?
  11. Appending .js extension on relative import statements during Typescript compilation (ES6 modules)
  12. Background tasks in Meteor
  13. How to use npm module in DENO?
  14. `npm build` doesn’t run the script named “build” in package.json
  15. Angular 2 – How to pass URL parameters?
  16. Node.js Port 3000 already in use but it actually isn’t?
  17. How to publish a module written in ES6 to NPM?
  18. Webpack output is empty object
  19. How to close electron app via javascript?
  20. Fix the upstream dependency conflict installing NPM packages
  21. How to Set port in next.js
  22. “unexpected token import” in Nodejs5 and babel?
  23. create-react-app: How do I “npm start” with a specific browser?
  24. Yarn global command not working
  25. JavaScript dependency management: npm vs. bower vs. volo [closed]
  26. How can I manage client-side JavaScript dependencies? [closed]
  27. Error: Cannot find module ‘../lib/cli’
  28. Using Async waterfall in node.js
  29. How to use npm modules in browser? is possible to use them even in local (PC)?
  30. Error installing node-gyp on ubuntu

Leave a Comment