How to deprecate generic type parameters on class/interface?
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
I found https://github.com/microsoft/tsdoc/issues/131 and that approach will work for generic type parameters on functions inside interfaces/classes.
But how can we mark the below generic type parameter DEPRECATED as @deprecated?
interface Foo<T, DEPRECATED> {}
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked TSDoc issue 131 and the TypeScript example for interface Foo<T, DEPRECATED>. Determine whether TSDoc has a syntax or specification path for deprecating a generic type parameter, and document the decided approach and its expected rendering or interpretation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100