fix(api-markdown-documenter): Fix minimumReleaseLevel property typi…

…ng (#23506) The property was incorrectly using `Omit` instead of `Exclude`, the latter being the correct options for excluding a member of a type union.
microsoft · Jan 8, 2025 · 90bc246 · 90bc246
1 parent 61f2264
commit 90bc246
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/tools/api-markdown-documenter/api-report/api-markdown-documenter.alpha.api.md b/tools/api-markdown-documenter/api-report/api-markdown-documenter.alpha.api.md
@@ -315,7 +315,7 @@ export interface DocumentationSuiteConfiguration {
     readonly hierarchyBoundaries: HierarchyBoundaries;
     readonly includeBreadcrumb: boolean;
     readonly includeTopLevelDocumentHeading: boolean;
-    readonly minimumReleaseLevel: Omit<ReleaseTag, ReleaseTag.None>;
+    readonly minimumReleaseLevel: Exclude<ReleaseTag, ReleaseTag.None>;
     readonly skipPackage: (apiPackage: ApiPackage) => boolean;
 }
 

diff --git a/tools/api-markdown-documenter/api-report/api-markdown-documenter.beta.api.md b/tools/api-markdown-documenter/api-report/api-markdown-documenter.beta.api.md
@@ -315,7 +315,7 @@ export interface DocumentationSuiteConfiguration {
     readonly hierarchyBoundaries: HierarchyBoundaries;
     readonly includeBreadcrumb: boolean;
     readonly includeTopLevelDocumentHeading: boolean;
-    readonly minimumReleaseLevel: Omit<ReleaseTag, ReleaseTag.None>;
+    readonly minimumReleaseLevel: Exclude<ReleaseTag, ReleaseTag.None>;
     readonly skipPackage: (apiPackage: ApiPackage) => boolean;
 }
 

diff --git a/tools/api-markdown-documenter/api-report/api-markdown-documenter.public.api.md b/tools/api-markdown-documenter/api-report/api-markdown-documenter.public.api.md
@@ -315,7 +315,7 @@ export interface DocumentationSuiteConfiguration {
     readonly hierarchyBoundaries: HierarchyBoundaries;
     readonly includeBreadcrumb: boolean;
     readonly includeTopLevelDocumentHeading: boolean;
-    readonly minimumReleaseLevel: Omit<ReleaseTag, ReleaseTag.None>;
+    readonly minimumReleaseLevel: Exclude<ReleaseTag, ReleaseTag.None>;
     readonly skipPackage: (apiPackage: ApiPackage) => boolean;
 }
 

diff --git a/tools/api-markdown-documenter/src/api-item-transforms/configuration/DocumentationSuite.ts b/tools/api-markdown-documenter/src/api-item-transforms/configuration/DocumentationSuite.ts
@@ -234,7 +234,7 @@ export interface DocumentationSuiteConfiguration {
 	 * releaseLevel: ReleaseTag.Beta
 	 * ```
 	 */
-	readonly minimumReleaseLevel: Omit<ReleaseTag, ReleaseTag.None>;
+	readonly minimumReleaseLevel: Exclude<ReleaseTag, ReleaseTag.None>;
 }
 
 /**
-Original file line number
+Diff line change
@@ Expand Up / @@ -234,7 +234,7 @@ export interface DocumentationSuiteConfiguration { @@
     	 * releaseLevel: ReleaseTag.Beta
     	 * ```
     	 */
-    	readonly minimumReleaseLevel: Omit<ReleaseTag, ReleaseTag.None>;
+    	readonly minimumReleaseLevel: Exclude<ReleaseTag, ReleaseTag.None>;
     }
     /**
@@ Expand Down @@