-
Notifications
You must be signed in to change notification settings - Fork 182
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
property emits object
for its type instead of inlined typed
#733
Comments
Thank you. Full inoine object is now represented inside type arguments (as per prop C). Please note that where associated docs are included (as per prop D) then by default the keyword Hope that makes sense? This is perhaps not very obvious, so will review at some point, but hopefully this behaviour is acceptable for time being. |
Thanks for the quick fix @tgreyuk, greatly appreciated! Understood and makes sense on the decision to use Something to consider for future possibly is that I do think there is something to be said for having the default generated output as closely align with the default typedoc output (html format) except for in areas where it does not make any sense for markdown. All that said, as of v4.3.2 this is working by design now, thank you again! |
I will close this as fixed, but as noted will continue work with aligning with html theme when it makes sense to do so. |
What package is the bug related to?
typedoc-plugin-markdown
Describe the issue
The generated markdown contains
object
instead of the inlined type for properties of a type whose type is based on a typedef.Repro: https://stackblitz.com/edit/vitejs-vite-xwhbv4ro
Steps to reproduce
npm run docs:md
docs-md/interfaces/Foo.md
Actual Result
Additional Information
zod
, however I was unsuccessful despite several different ways of trying to achieve. It does not appear to be a zod problem since the html version emits as expected but apologies for not being able to narrow this down any further.object
problem in Unioned type for function param emitsobject
instead of inline type for type that is based on atypedef
#720TypeDoc configuration
typedoc: 0.27.3
typedoc-plugin-markdown: 4.3.1
typescript: 5.7.2
Expected behavior
The types for
Foo.c
andFoo.d
should be inlined.The text was updated successfully, but these errors were encountered: