Skip to content

📝 Documentation: Clarify supported TypeScript version range #712

Open
@JoshuaKGoldberg

Description

@JoshuaKGoldberg

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.

💖

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: documentationImprovements or additions to docs 📝status: in discussionNot yet ready for implementation or a pull request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions