feat: add custom omit utility type (#2733)

contentful · Apr 29, 2024 · 80c7f67 · 80c7f67
1 parent 6f5c6b1
commit 80c7f67
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/.changeset/curvy-ladybugs-provide.md b/.changeset/curvy-ladybugs-provide.md
@@ -0,0 +1,5 @@
+---
+"@contentful/f36-core": patch
+---
+
+feat: add custom omit utility type
diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -71,3 +71,15 @@ export type PickUnion<UnionType, Keys> = Exclude<
   UnionType,
   Exclude<UnionType, Keys>
 >;
+
+/**
+ * Also known as homomorphic.
+ * Use this custom Omit utility type to preserve extended Record properties.
+ *
+ * Why? Using Omit on extended Records does not preserve the structure.
+ * - https://github.com/microsoft/TypeScript/issues/36981
+ * - https://github.com/microsoft/TypeScript/issues/54451
+ */
+export type MappedOmit<T, K extends keyof T> = {
+  [P in keyof T as P extends K ? never : P]: T[P];
+};