Discussion: How to document inferred types using TSDoc
Open
Nobody has claimed this yet.
general discussion
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
I have a complex type that is inferred from yup schema, so something like:
export type Config = y.InferType<typeof isConfig>
How would one ts-doc its properties manually?
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
Review the issue's TypeScript example and the TSDoc documentation or specification for inferred types and manually documented properties. Done would require a settled, project-appropriate answer or documentation guidance; the issue names no files or tests to run.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100