Add beta flag

processing · Sep 14, 2024 · 0805397 · 0805397
1 parent 0182eaa
commit 0805397
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/src/content/reference/config.ts b/src/content/reference/config.ts
@@ -70,6 +70,7 @@ export const referenceSchema = z.object({
   itemtype: z.string().optional(),
   class: z.string().optional(),
   chainable: z.coerce.boolean().optional(),
+  beta: z.coerce.boolean().optional(),
   return: returnSchema.optional(),
   example: z.array(exampleSchema).optional(),
   relatedContent: relatedContent().optional(),

diff --git a/src/scripts/builders/reference.ts b/src/scripts/builders/reference.ts
@@ -293,6 +293,7 @@ const getMethodFrontmatter = (doc: ReferenceClassItemMethod) => {
     overloads,
     itemtype,
     chainable: doc.chainable === 1,
+    beta: doc.beta ? !!doc.beta : undefined,
   };
 };
 

diff --git a/types/parsers.interface.ts b/types/parsers.interface.ts
@@ -98,8 +98,12 @@ interface Return {
   type: string;
 }
 
+interface MaybeBeta {
+  beta?: number;
+}
+
 /* Represents a method within a class */
-export interface ReferenceClassItemMethod extends BaseClassItem, Chainable {
+export interface ReferenceClassItemMethod extends BaseClassItem, Chainable, MaybeBeta {
   params?: ReferenceParam[];
   return?: Return;
   example?: string[];