From 90bc246b2dfdc832d9bb12f35f18cdcf30e6a637 Mon Sep 17 00:00:00 2001
From: Joshua Smithrud <54606601+Josmithr@users.noreply.github.com>
Date: Wed, 8 Jan 2025 12:15:26 -0800
Subject: [PATCH] fix(api-markdown-documenter): Fix `minimumReleaseLevel`
property typing (#23506)
The property was incorrectly using `Omit` instead of `Exclude`, the
latter being the correct options for excluding a member of a type union.
---
.../api-report/api-markdown-documenter.alpha.api.md | 2 +-
.../api-report/api-markdown-documenter.beta.api.md | 2 +-
.../api-report/api-markdown-documenter.public.api.md | 2 +-
.../src/api-item-transforms/configuration/DocumentationSuite.ts | 2 +-
4 files changed, 4 insertions(+), 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
index 048d96b1e324..62d1934aa871 100644
--- 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
index d7c3c4006493..648210647a72 100644
--- 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
index cb0b02f27518..a424cca00739 100644
--- 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
index b0982296cbc2..711bc396bbe8 100644
--- 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>;
}
/**