YamlDocumenter now supports MethodSignature, PropertySignature, and enumMember.initializerExcerpt

pgonzal · pgonzal · commit 25d834c962c6 · 2018-11-28T15:15:52.000-08:00
diff --git a/apps/api-documenter/src/documenters/YamlDocumenter.ts b/apps/api-documenter/src/documenters/YamlDocumenter.ts
@@ -26,7 +26,8 @@ import {
   ApiPropertySignature,
   ApiItemContainerMixin,
   ApiPackage,
-  ApiFunctionLikeMixin
+  ApiFunctionLikeMixin,
+  ApiEnumMember
 } from '@microsoft/api-extractor';
 
 import {
@@ -296,16 +297,12 @@ export class YamlDocumenter {
         break;
       case ApiItemKind.EnumMember:
         yamlItem.type = 'field';
-        /*
         const enumMember: ApiEnumMember = apiItem as ApiEnumMember;
-        if (enumMember.value) {
-          // NOTE: In TypeScript, enum members can be strings or integers.
-          // If it is an integer, then enumMember.value will be a string representation of the integer.
-          // If it is a string, then enumMember.value will include the quotation marks.
-          // Enum values can also be calculated numbers, however this is not implemented yet.
-          yamlItem.numericValue = enumMember.value as any; // tslint:disable-line:no-any
+
+        if (enumMember.initializerExcerpt.text.length > 0) {
+          yamlItem.numericValue = enumMember.initializerExcerpt.text;
         }
-        */
+
         break;
       case ApiItemKind.Class:
         yamlItem.type = 'class';
@@ -316,6 +313,7 @@ export class YamlDocumenter {
         this._populateYamlClassOrInterface(yamlItem, apiItem);
         break;
       case ApiItemKind.Method:
+      case ApiItemKind.MethodSignature:
         yamlItem.type = 'method';
         this._populateYamlFunctionLike(yamlItem, apiItem as ApiMethod);
         break;
@@ -329,6 +327,7 @@ export class YamlDocumenter {
         yamlItem.type = 'package';
         break;
       case ApiItemKind.Property:
+      case ApiItemKind.PropertySignature:
         const apiProperty: ApiPropertyItem = apiItem as ApiPropertyItem;
         if (apiProperty.isEventProperty) {
           yamlItem.type = 'event';
diff --git a/apps/api-documenter/src/yaml/IYamlApiFile.ts b/apps/api-documenter/src/yaml/IYamlApiFile.ts
@@ -45,7 +45,12 @@ export interface IYamlItem {
   isPreview?: boolean;
   langs?: string[];
   name?: string;
-  numericValue?: number;
+  /**
+   * NOTE: In TypeScript, enum members can be strings or integers.
+   * If it is an integer, then enumMember.value will be a string representation of the integer.
+   * If it is a string, then enumMember.value will include the quotation marks.
+   */
+  numericValue?: string;
   package?: string;
   source?: IYamlSource;
   summary?: string;
diff --git a/apps/api-extractor/src/api/mixins/Excerpt.ts b/apps/api-extractor/src/api/mixins/Excerpt.ts
@@ -52,13 +52,18 @@ export class Excerpt {
 
   public readonly tokens: ReadonlyArray<ExcerptToken>;
 
+  private _text: string | undefined;
+
   public constructor(tokens: ReadonlyArray<ExcerptToken>, tokenRange: IExcerptTokenRange) {
     this.tokens = tokens;
     this.tokenRange = tokenRange;
   }
 
   public get text(): string {
-    return this.tokens.slice(this.tokenRange.startIndex, this.tokenRange.endIndex)
+    if (this._text === undefined) {
+      this._text = this.tokens.slice(this.tokenRange.startIndex, this.tokenRange.endIndex)
       .map(x => x.text).join('');
+    }
+    return this._text;
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -52,13 +52,18 @@ export class Excerpt {`
`52`	`52`
`53`	`53`	`public readonly tokens: ReadonlyArray<ExcerptToken>;`
`54`	`54`
	`55`	`+ private _text: string \| undefined;`
	`56`	`+`
`55`	`57`	`public constructor(tokens: ReadonlyArray<ExcerptToken>, tokenRange: IExcerptTokenRange) {`
`56`	`58`	`this.tokens = tokens;`
`57`	`59`	`this.tokenRange = tokenRange;`
`58`	`60`	`}`
`59`	`61`
`60`	`62`	`public get text(): string {`
`61`		`- return this.tokens.slice(this.tokenRange.startIndex, this.tokenRange.endIndex)`
	`63`	`+ if (this._text === undefined) {`
	`64`	`+ this._text = this.tokens.slice(this.tokenRange.startIndex, this.tokenRange.endIndex)`
`62`	`65`	`.map(x => x.text).join('');`
	`66`	`+ }`
	`67`	`+ return this._text;`
`63`	`68`	`}`
`64`	`69`	`}`