Skip to content

📝 Documentation: Clarify supported TypeScript version range #712

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

Open
2 tasks done
JoshuaKGoldberg opened this issue Mar 19, 2025 · 0 comments
Open
2 tasks done
Labels
area: documentation Improvements or additions to docs 📝 status: in discussion Not yet ready for implementation or a pull request

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

Overview

Neither the README.md nor https://joshuakgoldberg.github.io/ts-api-utils/stable/ mention what the supported versions of TypeScript are. We should really make that clear:

  • Consumers shouldn't be surprised if their relatively old TS version doesn't work with ts-api-utils
  • Dependents of ts-api-utils might have their own support ranges, and need to know if they match up

Per package.json, currently it's >=4.8.4:

"peerDependencies": {
"typescript": ">=4.8.4"
},

Additional Info

Relevant to #711, which is on a feature not supported in older TS versions.

💖

@JoshuaKGoldberg JoshuaKGoldberg added area: documentation Improvements or additions to docs 📝 status: in discussion Not yet ready for implementation or a pull request labels Mar 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Improvements or additions to docs 📝 status: in discussion Not yet ready for implementation or a pull request
Projects
None yet
Development

No branches or pull requests

1 participant