Fix Documentation type

reactjs · Mar 4, 2023 · 98a1138 · 98a1138
1 parent cc94da2
commit 98a1138
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/.changeset/polite-pandas-push.md b/.changeset/polite-pandas-push.md
@@ -0,0 +1,5 @@
+---
+'react-docgen': patch
+---
+
+Add `displayName` and `description` to Doccumentation type
diff --git a/packages/react-docgen/src/Documentation.ts b/packages/react-docgen/src/Documentation.ts
@@ -1,15 +1,17 @@
 export interface DocumentationObject {
-  props?: Record<string, PropDescriptor>;
-  context?: Record<string, PropDescriptor>;
   childContext?: Record<string, PropDescriptor>;
   composes?: string[];
+  context?: Record<string, PropDescriptor>;
+  description?: string;
+  displayName?: string;
   methods?: MethodDescriptor[];
+  props?: Record<string, PropDescriptor>;
 }
 
 export interface MethodParameter {
   name: string;
-  type?: TypeDescriptor<FunctionSignatureType> | null;
   optional: boolean;
+  type?: TypeDescriptor<FunctionSignatureType> | null;
 }
 
 export interface MethodReturn {
@@ -162,6 +164,7 @@ export default class Documentation {
     this.#data.set(key, value);
   }
 
+  get<T>(key: string): T | null;
   get(key: string): unknown {
     return this.#data.get(key);
   }