ForNeVeR / ForNeVeR/catberry-ts
Complex parameter types
- Dominant language
- TypeScript
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Some parameters may contain `.` in their names. For example,
``` js
/**
* Sets cookie to this wrapper.
* @param {Object} cookieSetup Cookie setup object.
* @param {string} cookieSetup.key Cookie key.
* @param {string} cookieSetup.value Cookie value.
* @param {number?} cookieSetup.maxAge Max cookie age in seconds.
* @param {Date?} cookieSetup.expires Expire date.
* @param {string?} cookieSetup.path URI path for cookie.
* @param {string?} cookieSetup.domain Cookie domain.
* @param {boolean?} cookieSetup.secure Is cookie secured.
* @param {boolean?} cookieSetup.httpOnly Is cookie HTTP only.
* @returns {string} Cookie setup string.
*/
CookieWrapper.prototype.set = function (cookieSetup) {
...
}
```
Currently these complex types are ignored. They should instead be parsed and added to output.
Contributor guide
No contributing guide indexed for this repository
Research direction
Find the code that parses JSDoc @param entries and produces TypeScript definitions, then compare its handling of simple parameters with the dotted names in the CookieWrapper example. Update the parsing behavior so nested parameter names and their types appear in the output, and verify the generated result against the example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100