Skip to content

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

@sdegutis

Description

@sdegutis

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.

Metadata

Metadata

Assignees

Labels

Needs InvestigationThis issue needs a team member to investigate its status.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions