Method for "extending" existing ES Module documentation?
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
Say I have a package that has typescript types but they have no jsdoc/tsdoc so I only get basic intellisense without descriptions. Does TSDoc support a way for me to write my own docs and have them merged with the existing types from the package? Assuming esmodules with import syntax
Can @packageDocumentation be used this way without defining new types? Interface merges perhaps?
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 reviewing the question about extending existing TypeScript package types with TSDoc comments under ES module imports. Determine whether @packageDocumentation or interface merging addresses this use case, and document the supported approach or the missing capability.
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
- 20/100