Skip to content
This repository has been archived by the owner on Feb 27, 2022. It is now read-only.

Hide internal modules. #8

Closed
Fishrock123 opened this issue Aug 24, 2016 · 2 comments
Closed

Hide internal modules. #8

Fishrock123 opened this issue Aug 24, 2016 · 2 comments

Comments

@Fishrock123
Copy link

Fishrock123 commented Aug 24, 2016

To prevent people depending on internal/ modules, this module should hide them form direct use.

If not, it should be clearly marked as "DO NOT USE", should link to https://github.com/nodejs/node/blob/master/lib/internal/readme.md, and state that dependants can and will break at any time when access internals with no support for those APIs from the Node Core team.

(If people need access to something normally only covered by those APIs, we should expose a proper API we can maintain for it.)

@vkurchatkin
Copy link

To prevent people depending on internal/ modules, this module should hide them form direct use

I'm not sure there is a point. Whether people use internal/ or not, it's still unsupported.

@isaacs
Copy link
Owner

isaacs commented Aug 25, 2016

Literally everything about this module is unsupported, and the majority of the readme is devoted to explaining this as explicitly as possible.

I would be happy to include a link in the readme to a statement from the CTC or you personally saying that this is a bad idea. I say it's a bad idea in the docs.

I believe that is sufficient warning. it's unlikely anyone will be able to find or use this module without seeing the readme at least once.

@isaacs isaacs closed this as completed Aug 25, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants