reactjs / reactjs/react-docgen
Functions showing as "unknown" when encased in parentheses
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3.8k
- Forks
- 316
- Avg merge
- 5h 7m
- Merged PRs (30d)
- 4
Description
I have a prop that is defined as propName: (() => string) | undefined and the function portion of it is showing as "unknown" for the tsType
Minimal input
interface Props {
name: (() => string) | undefined
}
const MyComponent = ({name}: Props) => {
return <div />;
}
Output:
[
{
"description": "",
"displayName": "MyComponent",
"methods": [],
"props": {
"name": {
"required": true,
"tsType": {
"name": "union",
"raw": "(() => string) | undefined",
"elements": [
{
"name": "unknown"
},
{
"name": "undefined"
}
]
},
"description": ""
}
}
}
]
Tested on v8.0.0
Contributor guide
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
Reproduce the issue using the provided Props interface and MyComponent example, then inspect how the reported tsType is produced for the parenthesized function type. Done means the function branch is identified instead of reported as "unknown" while the union still includes undefined; no file or test path is named in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100