-
Notifications
You must be signed in to change notification settings - Fork 679
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Ability to handle union of object literals #2554
Comments
This is... super ugly to actually implement. TypeDoc already copies comments to the reflections for both instances of |
Search Terms
react component, union
Problem
When the param is a union of object literals,
@param
fails to document the property names. For example, typedoc would not output the doc afteroptions.northPole
andoptions.southPole
.Context
This is possible to encounter likely in a React component. One possible solution is to rewrite the above as overloads. However, depending on the context, it may not be desirable to do so. In fact, the ESLint typescript plugin has a rule "unified signatures" that disfavor splitting into overloads.
The text was updated successfully, but these errors were encountered: