Use of require(lib) versus in Electron apps

by

Some libraries only expose their variables through a CommonJS interface. Others, like jQuery, will also expose them as global variables.

The reason you can’t just do <script src="https://stackoverflow.com/questions/37736836/..."></script> for a library that only exposes through CommonJS is that it won’t bind to the global space.

Binding with CommonJS

module.exports = myLibrary;

Bindings to the global scope

window.myLibrary = myLibrary;

If a library only does the former then you will not be able to access the value without using require. If a library only does the latter, then you will not be able to access it with require in the sense of const myLibrary = require('my-library')

In general, it’s a better idea to use CommonJS over global variables. Adding variables to the global scope can lead to name collisions and directly loading in your dependencies makes it easier for the next person to tell where that dependency came from. Not to mention, CommonJS allows static analysis tools to work better so you’re more likely to get relevant code completions and type definitions.

Using the example of jQuery, it would be better to use it like this.

// main.js
const $ = require('./js/jquery-2.2.4.min.js');
// could also be done like this if you install it as a Node dependency
// const $ = require('jquery');

$(document).ready(...);

<!-- index.html -->
...
<script src="https://stackoverflow.com/questions/37736836/main.js"></script>

TL;DR

Use require('my-library') when possible, load them as globals when it is not.

More Related Contents:

  1. Electron require() is not defined
  2. webpack dynamic module loader by require
  3. How to use preload.js properly in Electron
  4. What is the difference between const and const {} in JavaScript
  5. How to close electron app via javascript?
  6. NodeJs : TypeError: require(…) is not a function
  7. How does require() in node.js work?
  8. How to view a PDF in an Electron BrowserWindow?
  9. Electron nodeIntegration not working, also general weird Electron behavior [duplicate]
  10. How to decide when to use Node.js?
  11. return value after a promise [duplicate]
  12. garbage collection with node.js
  13. Javascript ES6 TypeError: Class constructor Client cannot be invoked without ‘new’
  14. async for loop in node.js
  15. Why do I need to await an async function when it is not supposedly returning a Promise?
  16. Discord bot on Heroku throws an error: agent ??= new https.Agent
  17. Are there still reasons to use promise libraries like Q or BlueBird now that we have ES6 promises? [closed]
  18. How to run Puppeteer code in any web browser?
  19. Proper way to skip a then function in Q Promises
  20. Uncaught TypeError: Object.values is not a function JavaScript
  21. How is Node.js inherently faster when it still relies on Threads internally?
  22. Failed to load resource from same directory when redirecting Javascript
  23. What does “this” mean in a nodejs module?
  24. multer – req.file always undefined
  25. Javascript’s .includes function not working correctly with array of objects [duplicate]
  26. node.js mongodb select document by _id node-mongodb-native
  27. Write objects into file with Node.js
  28. Using Async waterfall in node.js
  29. How to avoid access mutable variable from closure
  30. Approach to multiple MySQL queries with Node.js

Leave a Comment