How to use the ‘main’ parameter in package.json?

by

From the npm documentation:

The main field is a module ID that is the primary entry point to your
program. That is, if your package is named foo, and a user installs
it, and then does require(“foo”), then your main module’s exports
object will be returned.

This should be a module ID relative to the root of your package
folder.

For most modules, it makes the most sense to have a main script and
often not much else.

To put it short:

  1. You only need a main parameter in your package.json if the entry point to your package differs from index.js in its root folder. For example, people often put the entry point to lib/index.js or lib/<packagename>.js, in this case the corresponding script must be described as main in package.json.
  2. You can’t have two scripts as main, simply because the entry point require('yourpackagename') must be defined unambiguously.

More Related Contents:

  1. access MONGODB on remote server [closed]
  2. Is it an anti-pattern to use async/await inside of a new Promise() constructor?
  3. “SyntaxError: Unexpected token < in JSON at position 0"
  4. Call async/await functions in parallel
  5. Understanding the Event Loop
  6. Callback after all asynchronous forEach callbacks are completed
  7. Are all javascript callbacks asynchronous? If not, how do I know which are?
  8. Asynchronous exception handling with bluebird promises
  9. How to return values from async functions using async-await from function? [duplicate]
  10. JavaScript, Node.js: is Array.forEach asynchronous?
  11. nodeJs callbacks simple example
  12. Best way to call an asynchronous function within map?
  13. How to avoid long nesting of asynchronous functions in Node.js
  14. Node JS Promise.all and forEach
  15. How to write asynchronous functions for Node.js
  16. Understanding Asynchronous Code in Layman’s terms
  17. How to wrap async function calls into a sync function in Node.js or Javascript?
  18. node.js async/await using with MySQL
  19. ‘await Unexpected identifier’ on Node.js 7.5
  20. Are all Node.js callback functions asynchronous?
  21. Understanding async/await on NodeJS
  22. using async await and .then together
  23. Node js socket explanation
  24. Asynchronous constructor
  25. Using mongoose promises with async/await
  26. javascript – Why is there a spec for sync and async modules?
  27. Why is node.js asynchronous?
  28. Does an async function always need to be called with await?
  29. Properly batch nested promises in Node
  30. JavaScript asynchronous programming: promises vs generators

Leave a Comment