feat(dts): strip internal by default, add dts compiler overrides option #11
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.
Changes
@internal
jsdoc tag. See the relevant documentation.Note to library authors
If you use the
@internal
JSDoc tag, this will likely result in a breaking change for your library as those types will no longer be included in the final output.If you wish to continue including those internal types as to avoid a breaking change, pass the following to the configuration which will override the new default option.
A word of caution
If one of your exports depends on something that is marked with an
@internal
tag, this will result in an error during type compilation. This should be caught during lib-check, so do not disable that option.