aboutsummaryrefslogtreecommitdiffstats
path: root/packages/react-docs/src/types.ts
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-08-16 02:36:45 +0800
committerFabio Berger <me@fabioberger.com>2018-08-16 02:36:45 +0800
commita8d44ccc48a7177e749f534a237afb7b9c0f2f2b (patch)
tree35e931893e7d73c32b54fa42ca31930e2fd4540d /packages/react-docs/src/types.ts
parent3b8a343711e0b23a453a1466411e2b9ca68eb0b2 (diff)
downloaddexon-sol-tools-a8d44ccc48a7177e749f534a237afb7b9c0f2f2b.tar
dexon-sol-tools-a8d44ccc48a7177e749f534a237afb7b9c0f2f2b.tar.gz
dexon-sol-tools-a8d44ccc48a7177e749f534a237afb7b9c0f2f2b.tar.bz2
dexon-sol-tools-a8d44ccc48a7177e749f534a237afb7b9c0f2f2b.tar.lz
dexon-sol-tools-a8d44ccc48a7177e749f534a237afb7b9c0f2f2b.tar.xz
dexon-sol-tools-a8d44ccc48a7177e749f534a237afb7b9c0f2f2b.tar.zst
dexon-sol-tools-a8d44ccc48a7177e749f534a237afb7b9c0f2f2b.zip
Move external types to link mapping to doc generation util and refactor typedocUtils to be a class to avoid excessive param passing
Diffstat (limited to 'packages/react-docs/src/types.ts')
-rw-r--r--packages/react-docs/src/types.ts12
1 files changed, 6 insertions, 6 deletions
diff --git a/packages/react-docs/src/types.ts b/packages/react-docs/src/types.ts
index c39dfcba8..0155685e0 100644
--- a/packages/react-docs/src/types.ts
+++ b/packages/react-docs/src/types.ts
@@ -11,12 +11,6 @@ export interface DocsInfoConfig {
markdownSections: SectionsMap;
sectionNameToMarkdownByVersion: SectionNameToMarkdownByVersion;
contractsByVersionByNetworkId?: ContractsByVersionByNetworkId;
- typeConfigs?: DocsInfoTypeConfigs;
-}
-
-export interface DocsInfoTypeConfigs {
- typeNameToExternalLink?: { [typeName: string]: string };
- typeNameToPrefix?: { [typeName: string]: string };
}
export interface DocsMenu {
@@ -160,6 +154,7 @@ export interface Type {
types?: Type[];
method?: TypescriptMethod;
indexSignature?: IndexSignature;
+ externalLink?: string;
}
export interface ElementType {
@@ -297,9 +292,14 @@ export interface ExportNameToTypedocNames {
[exportName: string]: string[];
}
+export interface ExternalTypeToLink {
+ [externalTypeName: string]: string;
+}
+
export interface Metadata {
exportPathToTypedocNames: ExportNameToTypedocNames;
exportPathOrder: string[];
+ externalTypeToLink: ExternalTypeToLink;
}
export interface GeneratedDocJson {