Omit injected props from WithSizes return type

The output component after the HOC has been applied should not support the same props that are injected by it. Even if it did support them, they would be overwritten by the HOC. More details on this can be found in the original draft for these types: renatorib/react-sizes#13 (comment)
pinn3 · Feb 27, 2021 · ded7965 · ded7965
1 parent fb89400
commit ded7965
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/types/react-sizes/index.d.ts b/types/react-sizes/index.d.ts
@@ -10,7 +10,7 @@ export interface Sizes {
 }
 
 export function WithSizes<SP extends object, P extends SP>(
-    mapSizesToProps: (sizes: Sizes) => SP
-): (component: React.ComponentType<P>) => React.ComponentType<P>;
+    mapSizesToProps: (sizes: Sizes) => SP,
+): (component: React.ComponentType<P>) => React.ComponentType<Omit<P, keyof SP>>;
 
 export default WithSizes;
diff --git a/types/react-sizes/react-sizes-tests.tsx b/types/react-sizes/react-sizes-tests.tsx
@@ -7,8 +7,7 @@ interface TestProps {
     height: number;
 }
 
-const mapSizesToProps = ({ width, height }: Sizes): TestProps => ({
-    foo: 'foo',
+const mapSizesToProps = ({ width, height }: Sizes) => ({
     width,
     height,
 });
@@ -26,4 +25,4 @@ const TestComponent: React.ComponentType<TestProps> = ({ foo, width, height }) =
     );
 };
 
-WithSizes(mapSizesToProps)(TestComponent); // $ExpectType ComponentType<TestProps>
+WithSizes<ReturnType<typeof mapSizesToProps>, TestProps>(mapSizesToProps)(TestComponent); // $ExpectType ComponentType<Pick<TestProps, "foo">>