Functions showing as "unknown" when encased in parentheses

Open
#994 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
42/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
react, typescript
Domain
documentation

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.

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

Dominant language
TypeScript
Stars
3.8k
Forks
316
Avg merge
3h 28m
Merged PRs (30d)
6

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from reactjs/react-docgen

All issues in reactjs/react-docgen

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.