[docs] Document the Omit type removal + alternative

mui · Feb 8, 2021 · d3e2487 · d3e2487
1 parent 1567dba
commit d3e2487
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/src/pages/guides/migration-v4/migration-v4.md b/docs/src/pages/guides/migration-v4/migration-v4.md
@@ -1266,3 +1266,12 @@ As the core components use emotion as a styled engine, the props used by emotion
     },
   });
   ```
+
+### `@material-ui/types`
+
+- Rename the exported `Omit` type in `@material-ui/types`. The module is now called `DistributiveOmit`. The change removes the confusion with the built-in `Omit` helper introduced in TypeScript v3.5. The built-in `Omit`, while similar, is non-distributive.  This leads to differences when applied to union types. [See this StackOverflow answer for further details](https://stackoverflow.com/a/57103940/1009797).
+
+```diff
+-import { Omit } from '@material-ui/types';
++import { DistributiveOmit } from '@material-ui/types';
+```