What methods can be used to conceal internal-only modules from users and consumers of a module?

Question

What methods can be used to conceal internal-only modules from users and consumers of a module?

I have been creating various node packages utilizing ES Modules. Within these packages, some modules are meant to be utilized externally by other packages, while certain module exports are intended for internal use only within my own package.

From my understanding, there is currently no built-in method to designate certain modules as strictly internal in ES modules. Are there any established best practices or guidelines that developers follow when developing node packages to discourage the utilization of internally designated modules?

The need for this arises because my packages are coded in TypeScript and the automatic generation of declaration files by TypeScript includes exports for modules that are intended for internal use only.

javascript typescript

Answer 1

Answer №1

With the release of Node version 18 and above, the introduction of the exports attribute has made it possible to specify a precise list of modules to export:

{
  "name: "my-package",
  "version": "1.0.0",

  "exports": {
    ".": "./dist/main.js",
    "./common": "./dist/common.js",
    "./other.js": "./dist/other.js"
  }
}

The use of this feature in Node.js ESM implementation mandates accuracy with file extensions. With the configuration mentioned above, the imports in the consuming application will look like this:

// Importing from `.`
import {} from 'my-package';

// Importing from `./common`
import {} from 'my-package/common';

// Importing from `./other.js`
import {} from 'my-package/other.js

Answer 2

With the release of Node version 18 and above, the introduction of the exports attribute has made it possible to specify a precise list of modules to export:

{
  "name: "my-package",
  "version": "1.0.0",

  "exports": {
    ".": "./dist/main.js",
    "./common": "./dist/common.js",
    "./other.js": "./dist/other.js"
  }
}

The use of this feature in Node.js ESM implementation mandates accuracy with file extensions. With the configuration mentioned above, the imports in the consuming application will look like this:

// Importing from `.`
import {} from 'my-package';

// Importing from `./common`
import {} from 'my-package/common';

// Importing from `./other.js`
import {} from 'my-package/other.js

What methods can be used to conceal internal-only modules from users and consumers of a module?

Answer №1

Similar questions

The Ultimate Showdown: Backbone.js Model versus View Battle

Using css with display:none and display:block is not allowed

Disable sorting options in the Datatable ColumnFilterWidget

What steps can be taken to prompt an action before a URL is loaded in a specific browser?

Comparing identical elements in JavaScript

Dealing with prolonged response times when creating a web page using PHP HttpRequest

Switching views in AngularJS by using a controller to control the content displayed in the

Identifying Changes in ReactJS Pages

Scaling and mapping textures onto meshes using Three.js TextureLoader

Is it possible to swap out images using srcset attribute?

Angular 2 validation issue not functioning as anticipated

Missing from the TypeScript compilation are Angular5's polyfills.ts and main.ts files

A guide on using wrapAll within an each loop in jQuery

Resolving React JS API call problem with 400 Error

Unallocated functions found within Web Sockets Objects

Upon subscribing to an observable, the initial value is invariably null

Issue with Vue.js: "Load more data" button functionality malfunctioning

The NodeJS application experiences a crash if incorrect parameters are provided to the API

You are able to use a null type as an index in angular.ts(2538) error message occurred

What is the best way to handle .jsx files in my library bundling process with Rollup?