aboutsummaryrefslogtreecommitdiffstats
path: root/packages/react-docs/src/types.ts
diff options
context:
space:
mode:
Diffstat (limited to 'packages/react-docs/src/types.ts')
-rw-r--r--packages/react-docs/src/types.ts29
1 files changed, 21 insertions, 8 deletions
diff --git a/packages/react-docs/src/types.ts b/packages/react-docs/src/types.ts
index cbc774c2e..18c386a2b 100644
--- a/packages/react-docs/src/types.ts
+++ b/packages/react-docs/src/types.ts
@@ -7,21 +7,16 @@ export interface DocsInfoConfig {
type: SupportedDocJson;
displayName: string;
packageUrl: string;
- menu: DocsMenu;
- sections: SectionsMap;
+ markdownMenu: DocsMenu;
+ markdownSections: SectionsMap;
sectionNameToMarkdownByVersion: SectionNameToMarkdownByVersion;
- visibleConstructors: string[];
- sectionNameToModulePath?: { [sectionName: string]: string[] };
- menuSubsectionToVersionWhenIntroduced?: { [sectionName: string]: string };
contractsByVersionByNetworkId?: ContractsByVersionByNetworkId;
typeConfigs?: DocsInfoTypeConfigs;
}
export interface DocsInfoTypeConfigs {
typeNameToExternalLink?: { [typeName: string]: string };
- publicTypes?: string[];
typeNameToPrefix?: { [typeName: string]: string };
- typeNameToDocSection?: { [typeName: string]: string };
}
export interface DocsMenu {
@@ -40,6 +35,7 @@ export interface TypeDocType {
typeArguments?: TypeDocType[];
declaration: TypeDocNode;
elementType?: TypeDocType;
+ indexSignature?: TypeDocNode;
}
export interface TypeDocFlags {
@@ -69,7 +65,7 @@ export interface TypeDocNode {
returns?: string;
declaration: TypeDocNode;
flags?: TypeDocFlags;
- indexSignature?: TypeDocNode | TypeDocNode[]; // TypeDocNode in TypeDoc <V0.9.0, TypeDocNode[] in >V0.9.0
+ indexSignature?: TypeDocNode;
signatures?: TypeDocNode[];
parameters?: TypeDocNode[];
typeParameter?: TypeDocNode[];
@@ -128,6 +124,7 @@ export interface TypescriptMethod extends BaseMethod {
export interface TypescriptFunction extends BaseFunction {
source?: Source;
typeParameter?: TypeParameter;
+ callPath: string;
}
export interface SolidityMethod extends BaseMethod {
@@ -161,6 +158,7 @@ export interface Type {
elementType?: ElementType;
types?: Type[];
method?: TypescriptMethod;
+ indexSignature?: IndexSignature;
}
export interface ElementType {
@@ -207,6 +205,7 @@ export interface Property {
type: Type;
source?: Source;
comment?: string;
+ callPath?: string;
}
export interface BaseMethod {
@@ -292,3 +291,17 @@ export enum AbiTypes {
Function = 'function',
Event = 'event',
}
+
+export interface ExportNameToTypedocNames {
+ [exportName: string]: string[];
+}
+
+export interface Metadata {
+ exportPathToTypedocNames: ExportNameToTypedocNames;
+ exportPathOrder: string[];
+}
+
+export interface GeneratedDocJson {
+ metadata: Metadata;
+ typedocJson: TypeDocNode;
+}