Switch @api private to official JSDoc #2018
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shadowspawn
added
the
pending release
shadowspawn
removed
the
pending release
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
Problem
Commander uses
@api privatewhich didn't make it into official JSDoc, although supported in some implementations.See: #1949
Solution
Switch to
@private, or@packagefor routines that are intended for internal use (or happen to be used internally!).Made
.attributeName()public in the JSDoc to match the TypeScript, which is the intended visibility as needed to look up option values.(I targeted v12 in case breaks some client use in an environment which actually starts warning about use of private routines.)