Skip to content

Commit b1336d1

Browse files
committed
Handle change to deprecation message format
1 parent b802236 commit b1336d1

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

src/scripts/builders/reference.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -415,6 +415,8 @@ const convertDocsToMDX = async (
415415
doc.example = correctRelativeLinksToExampleAssets(
416416
doc.example,
417417
) as string[];
418+
// @ts-ignore
419+
doc.deprecated = doc.deprecated ? (doc.deprecationMessage ?? true) : undefined;
418420
const mdx = await convertToMDX(doc);
419421

420422
return mdx ? { mdx, savePath, name: doc.name } : null;

types/parsers.interface.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,8 @@ interface Chainable {
9393
}
9494

9595
interface Deprecatable {
96-
deprecated?: string; // If this item is deprecated, a description of why.
96+
deprecated?: boolean; // If this item is deprecated, a description of why.
97+
deprecatedMessage?: string; // If this item is deprecated, a description of why.
9798
}
9899

99100
/* Represents the return value of a method or constructor */

0 commit comments

Comments
 (0)