How to Use require Instead of import in JavaScript and Access Property Variables Easily

---

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: How do I use require instead of import, while still being able to access properties of the variable?

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Understanding the Difference Between import and require

In the world of JavaScript, you are bound to encounter two primary ways to include external modules into your projects: import and require. While both methods allow you to use external libraries, they operate in different contexts and have distinct functionalities. This can lead to confusion, especially when trying to access specific properties of exported modules. This guide resolves a common issue faced by developers when transitioning from import to require but still wanting to access properties of the variable.

The Problem Explained

Imagine that you're using the -nut-tree/nut-js package in your JavaScript project. You write code that looks something like this when using import:

[[See Video to Reveal this Text or Code Snippet]]

In this example, you're successfully importing the keyboard object and modifying one of its properties. However, when you try to achieve the same result with require, you might run into trouble:

[[See Video to Reveal this Text or Code Snippet]]

The second snippet generates an error: TypeError: Cannot set properties of undefined. Why does this happen? Let’s dig deeper.

Understanding the Issue

The discrepancy stems from how require retrieves the exported module:

The Solution

To correctly access the keyboard configuration property when using require, you need to modify your code slightly. Rather than referencing keyboard as a standalone variable, you must drill down to the correct sub-property directly upon requiring:

[[See Video to Reveal this Text or Code Snippet]]

Steps to Resolve the Issue

Import the Module: Use require to import the module while referencing the specific export you need.

[[See Video to Reveal this Text or Code Snippet]]

Modify the Property: Now that you have the keyboard object, you can access its properties without encountering errors.

[[See Video to Reveal this Text or Code Snippet]]

Wrap Up

Now you're all set to dive deeper into your JavaScript projects with confidence!