aboutsummaryrefslogtreecommitdiffstats
path: root/packages/react-docs/src/components/interface.tsx
diff options
context:
space:
mode:
authorBrandon Millman <brandon.millman@gmail.com>2018-03-15 05:36:04 +0800
committerBrandon Millman <brandon.millman@gmail.com>2018-03-15 05:36:04 +0800
commit380e51ca505a880e1ac24f46b3ba7e1a736f693e (patch)
tree95e0311485834d8181171da821f258dd46a2d258 /packages/react-docs/src/components/interface.tsx
parent6a8c2cb7172be9b0aadb34904d1d9b3348bed0cc (diff)
parentaea7207b9f9865a279243889a5f9ca1638ddc739 (diff)
downloaddexon-sol-tools-380e51ca505a880e1ac24f46b3ba7e1a736f693e.tar
dexon-sol-tools-380e51ca505a880e1ac24f46b3ba7e1a736f693e.tar.gz
dexon-sol-tools-380e51ca505a880e1ac24f46b3ba7e1a736f693e.tar.bz2
dexon-sol-tools-380e51ca505a880e1ac24f46b3ba7e1a736f693e.tar.lz
dexon-sol-tools-380e51ca505a880e1ac24f46b3ba7e1a736f693e.tar.xz
dexon-sol-tools-380e51ca505a880e1ac24f46b3ba7e1a736f693e.tar.zst
dexon-sol-tools-380e51ca505a880e1ac24f46b3ba7e1a736f693e.zip
Merge branch 'development' into feature/utils/console-log
* development: (25 commits) Enable coverage for all other packages with tests Fix parallel coverage results reporting Fix linter issuesx Remove outdated comment Add script copying to build command Add postpublish script to sol-cov Move configuration into package.json configs section Transform input data before encoding for callAsync and getABIEncodedTransactionData Consolidate docs generation and uploading logic Use async/await instead of promise syntax Move changelog entry remove unneeded include remove unused dep Fix lint issues Re-add linter to monorepo-scripts but with tslint-config dep at earlier version to avoid cyclical dependency small fixes move scripts to monorepro-scripts Fix gitignore Move abi-gen scripts to src Add missing dep ...
Diffstat (limited to 'packages/react-docs/src/components/interface.tsx')
-rw-r--r--packages/react-docs/src/components/interface.tsx63
1 files changed, 63 insertions, 0 deletions
diff --git a/packages/react-docs/src/components/interface.tsx b/packages/react-docs/src/components/interface.tsx
new file mode 100644
index 000000000..01f4942ef
--- /dev/null
+++ b/packages/react-docs/src/components/interface.tsx
@@ -0,0 +1,63 @@
+import * as _ from 'lodash';
+import * as React from 'react';
+
+import { DocsInfo } from '../docs_info';
+import { CustomType, TypeDocTypes } from '../types';
+
+import { MethodSignature } from './method_signature';
+import { Type } from './type';
+
+export interface InterfaceProps {
+ type: CustomType;
+ sectionName: string;
+ docsInfo: DocsInfo;
+}
+
+export function Interface(props: InterfaceProps) {
+ const type = props.type;
+ const properties = _.map(type.children, property => {
+ return (
+ <span key={`property-${property.name}-${property.type}-${type.name}`}>
+ {property.name}:{' '}
+ {property.type.typeDocType !== TypeDocTypes.Reflection ? (
+ <Type type={property.type} sectionName={props.sectionName} docsInfo={props.docsInfo} />
+ ) : (
+ <MethodSignature
+ method={property.type.method}
+ sectionName={props.sectionName}
+ shouldHideMethodName={true}
+ shouldUseArrowSyntax={true}
+ docsInfo={props.docsInfo}
+ />
+ )},
+ </span>
+ );
+ });
+ const hasIndexSignature = !_.isUndefined(type.indexSignature);
+ if (hasIndexSignature) {
+ const is = type.indexSignature;
+ const param = (
+ <span key={`indexSigParams-${is.keyName}-${is.keyType}-${type.name}`}>
+ {is.keyName}: <Type type={is.keyType} sectionName={props.sectionName} docsInfo={props.docsInfo} />
+ </span>
+ );
+ properties.push(
+ <span key={`indexSignature-${type.name}-${is.keyType.name}`}>
+ [{param}]: {is.valueName},
+ </span>,
+ );
+ }
+ const propertyList = _.reduce(properties, (prev: React.ReactNode, curr: React.ReactNode) => {
+ return [prev, '\n\t', curr];
+ });
+ return (
+ <span>
+ {`{`}
+ <br />
+ {'\t'}
+ {propertyList}
+ <br />
+ {`}`}
+ </span>
+ );
+}