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

support event types in jsdoc #165

Closed
43081j opened this issue May 10, 2020 · 0 comments
Closed

support event types in jsdoc #165

43081j opened this issue May 10, 2020 · 0 comments

Comments

@43081j
Copy link
Contributor

43081j commented May 10, 2020

The JSDoc parsing function:

function parseJsDocTagString(str: string): JsDocTagParsed {

assumes types are of this format:

/**
  @param {someType} someName someDescription
*/

which is fine, except for events. a common pattern when defining an event in JSDoc is:

/**
  @fires some-name {someType}
*/

for example, mwc does this. i do too.


related problem: if we have @fires my-event {MouseEvent}, it seems this function won't bother with it and will return any.

is there any chance at some point this could be able to somehow resolve global types? or would that be lit-analyzer's job to lookup in its store?

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

1 participant