reactjs / reactjs/react-docgen
With Typescript Omit Union types get lost
Open
Nobody has claimed this yet.
new feature
typescript
- Dominant language
- TypeScript
- Stars
- 3.8k
- Forks
- 316
- Avg merge
- 5h 7m
- Merged PRs (30d)
- 4
Description
Hello together,
with the following code the union type of name gets lost:
interface FullProps {
/** The name to greet */
name: "world" | "hello";
title: string;
}
type Props = Omit<FullProps, "title">
/**
* Hello world component
*/
const MyComponent = ({name = 'world'}: Props) => {
return <div />;
}
I have similar problems with Extract and Pick.
Is it possible to support these typescript function?
Thanks in regards
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
Start with the TypeScript example in the issue and reproduce the behavior for Omit, then compare it with the similar Extract and Pick cases. Trace how react-docgen handles these utility types and verify that the union "world" | "hello" is preserved in the extracted component information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100