aboutsummaryrefslogtreecommitdiffstats
path: root/packages/react-docs/example
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-07 22:19:59 +0800
committerFabio Berger <me@fabioberger.com>2018-03-07 22:19:59 +0800
commit9aec1feae30870b3e6c8a778051877c83aacbe58 (patch)
treee49064325db9c51cc82acc5e177866ad806f7862 /packages/react-docs/example
parent8517de128b591c67f059d6c47722dfa81eeb9828 (diff)
downloaddexon-sol-tools-9aec1feae30870b3e6c8a778051877c83aacbe58.tar
dexon-sol-tools-9aec1feae30870b3e6c8a778051877c83aacbe58.tar.gz
dexon-sol-tools-9aec1feae30870b3e6c8a778051877c83aacbe58.tar.bz2
dexon-sol-tools-9aec1feae30870b3e6c8a778051877c83aacbe58.tar.lz
dexon-sol-tools-9aec1feae30870b3e6c8a778051877c83aacbe58.tar.xz
dexon-sol-tools-9aec1feae30870b3e6c8a778051877c83aacbe58.tar.zst
dexon-sol-tools-9aec1feae30870b3e6c8a778051877c83aacbe58.zip
Move remaining type configs to topLevel DocsInfoConfigs
Diffstat (limited to 'packages/react-docs/example')
-rw-r--r--packages/react-docs/example/ts/docs.tsx32
1 files changed, 29 insertions, 3 deletions
diff --git a/packages/react-docs/example/ts/docs.tsx b/packages/react-docs/example/ts/docs.tsx
index c4b165c13..f1c4a31bd 100644
--- a/packages/react-docs/example/ts/docs.tsx
+++ b/packages/react-docs/example/ts/docs.tsx
@@ -32,9 +32,6 @@ const docsInfoConfig: DocsInfoConfig = {
sectionNameToMarkdown: {
[docSections.introduction]: IntroMarkdown,
},
- // Note: This needs to be kept in sync with the types exported in index.ts. Unfortunately there is
- // currently no way to extract the re-exported types from index.ts via TypeDoc :(
- publicTypes: ['TxData', 'TransactionReceipt', 'RawLogEntry'],
sectionNameToModulePath: {
[docSections.web3Wrapper]: ['"web3-wrapper/src/index"'],
[docSections.types]: ['"types/src/index"'],
@@ -42,6 +39,35 @@ const docsInfoConfig: DocsInfoConfig = {
menuSubsectionToVersionWhenIntroduced: {},
sections: docSections,
visibleConstructors: [docSections.web3Wrapper],
+ typeConfigs: {
+ // Note: This needs to be kept in sync with the types exported in index.ts. Unfortunately there is
+ // currently no way to extract the re-exported types from index.ts via TypeDoc :(
+ publicTypes: ['TxData', 'TransactionReceipt', 'RawLogEntry'],
+ typeNameToExternalLink: {
+ Web3: 'https://github.com/ethereum/wiki/wiki/JavaScript-API',
+ Provider: 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L123',
+ BigNumber: 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L127',
+ DecodedLogEntryEvent: 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L150',
+ LogEntryEvent: 'http://mikemcl.github.io/bignumber.js',
+ CallData: 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L348',
+ BlockWithoutTransactionData:
+ 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L314',
+ LogEntry: 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L366',
+ FilterObject: 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L109',
+ ['Web3.BlockParam']: 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L278',
+ ['Web3.ContractAbi']: 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L47',
+ },
+ typeNameToPrefix: {
+ Provider: 'Web3',
+ CallData: 'Web3',
+ BlockWithoutTransactionData: 'Web3',
+ LogEntry: 'Web3',
+ FilterObject: 'Web3',
+ },
+ typeNameToDocSection: {
+ Web3Wrapper: docSections.web3Wrapper,
+ },
+ },
};
const docsInfo = new DocsInfo(docsInfoConfig);