diff options
author | Fabio Berger <me@fabioberger.com> | 2018-08-23 23:55:41 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2018-08-23 23:55:41 +0800 |
commit | 28f077b16f5fc5f08f95bb2ad00724e6ea89dd00 (patch) | |
tree | dba9e82409721d44ad41d7a434f3378f075486e9 /packages/react-docs | |
parent | 3563fabe8871f69799dd7c89b83ecea19951794c (diff) | |
download | dexon-0x-contracts-28f077b16f5fc5f08f95bb2ad00724e6ea89dd00.tar dexon-0x-contracts-28f077b16f5fc5f08f95bb2ad00724e6ea89dd00.tar.gz dexon-0x-contracts-28f077b16f5fc5f08f95bb2ad00724e6ea89dd00.tar.bz2 dexon-0x-contracts-28f077b16f5fc5f08f95bb2ad00724e6ea89dd00.tar.lz dexon-0x-contracts-28f077b16f5fc5f08f95bb2ad00724e6ea89dd00.tar.xz dexon-0x-contracts-28f077b16f5fc5f08f95bb2ad00724e6ea89dd00.tar.zst dexon-0x-contracts-28f077b16f5fc5f08f95bb2ad00724e6ea89dd00.zip |
Add support for rending the Tuple type
Diffstat (limited to 'packages/react-docs')
-rw-r--r-- | packages/react-docs/src/components/type.tsx | 22 | ||||
-rw-r--r-- | packages/react-docs/src/types.ts | 8 | ||||
-rw-r--r-- | packages/react-docs/src/utils/typedoc_utils.ts | 6 |
3 files changed, 36 insertions, 0 deletions
diff --git a/packages/react-docs/src/components/type.tsx b/packages/react-docs/src/components/type.tsx index 145c797a3..5f7601ce1 100644 --- a/packages/react-docs/src/components/type.tsx +++ b/packages/react-docs/src/components/type.tsx @@ -167,6 +167,28 @@ export const Type: React.SFC<TypeProps> = (props: TypeProps): any => { }); break; + case TypeDocTypes.Tuple: + const tupleTypes = _.map(type.tupleElements, t => { + return ( + <Type + key={`type-tuple-${t.name}-${t.typeDocType}`} + type={t} + sectionName={props.sectionName} + typeDefinitionByName={props.typeDefinitionByName} + docsInfo={props.docsInfo} + isInPopover={props.isInPopover} + /> + ); + }); + typeName = ( + <div> + [{_.reduce(tupleTypes, (prev: React.ReactNode, curr: React.ReactNode) => { + return [prev, ', ', curr]; + })}] + </div> + ); + break; + default: throw errorUtils.spawnSwitchErr('type.typeDocType', type.typeDocType); } diff --git a/packages/react-docs/src/types.ts b/packages/react-docs/src/types.ts index 7fd785e32..f9cb5e26a 100644 --- a/packages/react-docs/src/types.ts +++ b/packages/react-docs/src/types.ts @@ -31,6 +31,12 @@ export interface TypeDocType { declaration: TypeDocNode; elementType?: TypeDocType; indexSignature?: TypeDocNode; + elements?: TupleElement[]; +} + +export interface TupleElement { + type: string; + name: string; } export interface TypeDocFlags { @@ -78,6 +84,7 @@ export enum TypeDocTypes { Union = 'union', TypeParameter = 'typeParameter', Intersection = 'intersection', + Tuple = 'tuple', Unknown = 'unknown', } @@ -157,6 +164,7 @@ export interface Type { method?: TypescriptMethod; indexSignature?: IndexSignature; externalLink?: string; + tupleElements?: Type[]; } export interface ElementType { diff --git a/packages/react-docs/src/utils/typedoc_utils.ts b/packages/react-docs/src/utils/typedoc_utils.ts index b867b51b4..67e37e82d 100644 --- a/packages/react-docs/src/utils/typedoc_utils.ts +++ b/packages/react-docs/src/utils/typedoc_utils.ts @@ -457,6 +457,7 @@ export class TypeDocUtils { let indexSignatureIfExists; let methodIfExists; + let tupleElementsIfExists; const doesIndexSignatureExist = !_.isUndefined(entity.declaration) && !_.isUndefined(entity.declaration.indexSignature); if (doesIndexSignatureExist) { @@ -465,6 +466,10 @@ export class TypeDocUtils { } else if (!_.isUndefined(entity.declaration)) { const isConstructor = false; methodIfExists = this._convertMethod(entity.declaration, isConstructor, sectionName); + } else if (entity.type === TypeDocTypes.Tuple) { + tupleElementsIfExists = _.map(entity.elements, el => { + return { name: el.name, typeDocType: el.type as TypeDocTypes }; + }); } const elementTypeIfExists = !_.isUndefined(entity.elementType) @@ -484,6 +489,7 @@ export class TypeDocUtils { types, method: methodIfExists, indexSignature: indexSignatureIfExists, + tupleElements: tupleElementsIfExists, }; const externalLinkIfExists = this._externalTypeToLink[entity.name]; if (!_.isUndefined(externalLinkIfExists)) { |