Skip to content

Wiki page "Using the Type Checker" only cursorily describes how to use the type checker API #55760

@JoshuaKGoldberg

Description

@JoshuaKGoldberg

Acknowledgement

  • I acknowledge that issues using this template may be closed without further explanation at the maintainer's discretion.

Comment

Like #28003, but less severe. https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API#using-the-type-checker does actually show usage of the type checker. But it doesn't explain...

  • ...what is a "type checker"?
  • ...what are some of the the commonly used, relevant APIs?
  • ...what is a "symbol"?
  • ...what is a "type"?

If we could add that preliminary info to the page, community resources could then link to it more confidently. Context: typescript-eslint/typescript-eslint#7659

Edit: and, I'm not sure where this issue belongs. Seems like other wiki issues on this repo have had traction? But the wiki has its own issues tracker? 🤷

Metadata

Metadata

Assignees

No one assigned

    Labels

    Help WantedYou can do thisPossible ImprovementThe current behavior isn't wrong, but it's possible to see that it might be better in some cases

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions