Repository navigation
Missing support for Pick<> and Omit<> #925
Description
Whenever an interface is using the typescript features Pick or Omit, then we don't get any props from these interfaces/types.
In the case of an interface like this:
import { type LinkProps } from "next/link";
interface MyComponentProps
extends Pick<LinkProps, "prefetch" | "replace" | "scroll" | "shallow"> {
children?: React.ReactNode;
}
export const MyComponent: FunctionComponent<MyComponentProps> = () => {
return <>My Component</>;
};-> in this case it will only find "children" as prop.
import { type LinkProps } from "next/link";
interface MyComponentProps
extends Pick<LinkProps, "prefetch" | "replace" | "scroll" | "shallow"> {
children?: React.ReactNode;
}
export const MyComponent: FunctionComponent<MyComponentProps> = () => {
return <>My Component</>;
};The same with Omit<>:
import { type LinkProps } from "next/link";
interface MyComponentProps
extends Omit<LinkProps, "prefetch" | "replace" | "scroll" | "shallow"> {
children?: React.ReactNode;
}
export const MyComponent: FunctionComponent<MyComponentProps> = () => {
return <>My Component</>;
};
Activity
michalkopanski commentedon Aug 7, 2024
Especially bummed about this one, because it works great up until the point we need to use either of these features.
As we start to refactor our types and share them between components while using
Pick<>orOmit<>, we also start to lose out on the benefit of havingreact-docgenin the first place.dimitur2204 commentedon Sep 28, 2024
+1
StefanFeser commentedon Aug 28, 2025
We found out that using
react-docgen-typescriptinstead ofreact-docgenCLI fixes this issue.