Adds description property to schema types (#381)

markdoc · May 12, 2023 · e8b6db6 · e8b6db6
1 parent bc387e3
commit e8b6db6
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/types.ts b/src/types.ts
@@ -107,6 +107,7 @@ export type Schema<C extends Config = Config, R = string> = {
   inline?: boolean;
   transform?(node: Node, config: C): MaybePromise<RenderableTreeNodes>;
   validate?(node: Node, config: C): MaybePromise<ValidationError[]>;
+  description?: string;
 };
 
 export type SchemaAttribute = {
@@ -117,6 +118,7 @@ export type SchemaAttribute = {
   matches?: SchemaMatches | ((config: Config) => SchemaMatches);
   validate?(value: any, config: Config): ValidationError[];
   errorLevel?: ValidationError['level'];
+  description?: string;
 };
 
 export type SchemaMatches = RegExp | string[] | null;