feat(docs): Hide internal methods from API docs #2945
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
harbu
approved these changes
Dec 13, 2024
| @@ -748,6 +749,7 @@ export class StreamrClient { | |||
|
|
|||
| /** | |||
| * @deprecated This in an internal method | |||
| * @hidden | |||
| */ | |||
| getConfig(): StrictStreamrClientConfig { | |||
There was a problem hiding this comment.
Is there a good reason we've made this internal? I think it could be useful in practice to see the config that is in use?
There was a problem hiding this comment.
We can make it public in a follow-up pr if needed. Earlier discussion: #1859 (comment)
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.
Added
@hiddenTypeDoc annotation for internal methods:getNode()getConfig()This way these methods are not included in the API docs. The internal
StreamrClient#getOperator()was already annotated like this.Removed redundant
@internalannotations from theNetworkNodeStubas it is not used by any publicly available method anymore:NetworkNodeFacade#getNode()to returnPromise<Omit<NetworkNodeStub, 'start' | 'stop'>>as a consequence of removing the@internalannotations@internalannotation fromNetworkNodeFacade#setProxies()Note
It would be possible annotate those method with
@internal. But then the methods wouldn't be included to the generated.d.tsfiles (as we use"stripInternal": trueintsconfig.node.json). The type definitions are needed bynodeandcli-toolspackages which use these internal methods.