Skip to content
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

Promises that return an object #268

Closed
roaringUnicorn opened this issue Nov 16, 2021 · 3 comments
Closed

Promises that return an object #268

roaringUnicorn opened this issue Nov 16, 2021 · 3 comments

Comments

@roaringUnicorn
Copy link

roaringUnicorn commented Nov 16, 2021

In case a promise resolves in an object, the plugin will not render a full object description, but will only show Object
Repro case: https://github.com/roaringUnicorn/typedoc-plugin-markdown-repro

Without the plugin

Returns Promise<{ data: string; id: string }>

With typedoc-plugin-markdown plugin

`Promise`<`Object`\>
@arantes555
Copy link

arantes555 commented Nov 19, 2021

I am also seeing the same behavior. Also, when a function returns an Object, there is a weird >} after the return type:

image

EDIT: I figured out this >} : it is because I specify return types in the JSDoc, which TypeDoc does not support, but for parameters they are ignored correctly, however for return types it appears they are not.

tgreyuk added a commit that referenced this issue Nov 20, 2021
@tgreyuk
Copy link
Member

tgreyuk commented Nov 20, 2021

@roaringUnicorn thanks for test repo. please try typedoc-plugin-markdown@3.11.7

Screenshot 2021-11-20 at 10 08 45

@roaringUnicorn
Copy link
Author

Works fine, thanks for the quick fix !

@tgreyuk tgreyuk closed this as completed Nov 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants