Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

With Typescript Omit Union types get lost

Open
#882 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
documentation

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.

Description

new feature typescript

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

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.