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

treat default export as reference node #675

Open
crowlKats opened this issue Dec 11, 2024 · 1 comment
Open

treat default export as reference node #675

crowlKats opened this issue Dec 11, 2024 · 1 comment
Assignees

Comments

@crowlKats
Copy link
Member

No description provided.

@crowlKats crowlKats self-assigned this Dec 11, 2024
@tylersayshi
Copy link

I had the following example for this if it helps: (pasted from denoland/docs#1313)

I was working on a promise util library here: https://jsr.io/@tyler/[email protected]

I have documented my first util with jsdoc, but re-exporting this symbol from a top level default export seems to break the jsr auto-doc detection.

It seems like exporting as a single default object results in the wrong type output too, which seems related. The type of default is {}.

The index.ts is just like this:

import { map } from './map.ts';

export default { map };

I have since changed the library to export the symbols as named to get around the issue (and I also stylistically prefer named), but this does seem like a problem worth solving nonetheless.

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

2 participants