support property type
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 206
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Description
Hello,
I have the following type definition
```
/**
* The database type.
* @typedef {Object} DB
* @property {String} folder - The path of the folder where the data files are stored.
* @property {Object} schemas - The schemas on the database.
*/
```
The type `DB` is shown on the documentation but the properties `folder` and `schemas` are shown without types. Is there any way to show types for these like shown for function arguments for exemple ?
Thank you,
Amine
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 reproducing the documented DB typedef from the issue and inspect the generated API documentation for the folder and schemas properties. Trace how typedef properties are parsed and rendered, then verify that their declared types appear in the output alongside the property names.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100