Skip to content

Change JSDoc @typedef to not apply to following expression #42949

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

Closed
5 tasks done
thesoftwarephilosopher opened this issue Feb 24, 2021 · 3 comments
Closed
5 tasks done
Assignees
Labels
Needs Investigation This issue needs a team member to investigate its status.

Comments

@thesoftwarephilosopher
Copy link

Suggestion

πŸ” Search Terms

βœ… Viability Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

Change JSDoc @typedef to not apply to following expression

πŸ“ƒ Motivating Example

Using @typedef like interface is great for JS files. But if any expression comes after it, TypeScript tries to apply that typedef to that expression. This means we have to make sure to put it at the end of a file and make sure nothing comes after it. Not ideal.

πŸ’» Use Cases

See above.

@RyanCavanaugh RyanCavanaugh added the Needs Investigation This issue needs a team member to investigate its status. label Feb 25, 2021
@RyanCavanaugh
Copy link
Member

@sandersn plausibility check?

@kungfooman
Copy link

I don't understand this, can you make a full example?

@sandersn
Copy link
Member

@typedef is usually supposed to be independent of the following statement, except for grabbing its name if you leave it off. It definitely should not apply the defined type to the following expression.

Any example I can think of is a bug, so please do post any you find.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs Investigation This issue needs a team member to investigate its status.
Projects
None yet
Development

No branches or pull requests

4 participants