Follow

Keep Up to Date with the Most Important News

By pressing the Subscribe button, you confirm that you have read and are agreeing to our Privacy Policy and Terms of Use
Contact

Hide specific exports in the npm package

I am new to creating npm packages.
I would not want users to be able to import everything from my package, such as the Utils class.

export class Utils implements IUtils {
  // ......
}

How do I avoid it?

MEDevel.com: Open-source for Healthcare and Education

Collecting and validating open-source software for healthcare, education, enterprise, development, medical imaging, medical records, and digital pathology.

Visit Medevel

>Solution :

You can specify the exports key in your package.json. When this is set, only the specified paths can be accessed from the module.

Docs: https://nodejs.org/api/packages.html#exports

The way I usually do this is to create an index.js or index.ts and add that to the exports. Then, anything I want to expose publicly, I export via the index file.

For example:

// index.ts
export { MyPublicClass } from './MyPublicClass'
Add a comment

Leave a Reply

Keep Up to Date with the Most Important News

By pressing the Subscribe button, you confirm that you have read and are agreeing to our Privacy Policy and Terms of Use

Discover more from Dev solutions

Subscribe now to keep reading and get access to the full archive.

Continue reading