Rename aliasType... to type...

rbuckton · rbuckton · commit addc97372f18 · 2019-06-09T23:07:41.000-07:00
diff --git a/apps/api-documenter/src/yaml/IYamlApiFile.ts b/apps/api-documenter/src/yaml/IYamlApiFile.ts
@@ -27,7 +27,7 @@ export interface IYamlException {
  * Part of the IYamlApiFile structure.  Represents the type of an IYamlItem.
  */
 export type YamlTypeId = 'class' | 'constructor' | 'enum' | 'field' | 'function' | 'interface'
-  | 'method' | 'package' | 'property' | 'event';
+  | 'method' | 'package' | 'property' | 'event' | 'typealias' | 'variable';
 
 /**
  * Part of the IYamlApiFile structure.  Represents basic API elements such as
diff --git a/apps/api-documenter/src/yaml/typescript.schema.json b/apps/api-documenter/src/yaml/typescript.schema.json
@@ -129,7 +129,7 @@
 					"$ref": "#/definitions/syntax"
 				},
 				"type": {
-					"enum": [ "class", "constructor", "enum", "field", "function", "interface", "method", "package", "property", "event" ]
+					"enum": [ "class", "constructor", "enum", "field", "function", "interface", "method", "package", "property", "event", "typealias", "variable" ]
 				},
 				"uid": {
 					"type": "string",
diff --git a/apps/api-extractor-model/src/model/ApiTypeAlias.ts b/apps/api-extractor-model/src/model/ApiTypeAlias.ts
@@ -18,13 +18,13 @@ export interface IApiTypeAliasOptions extends
   IApiReleaseTagMixinOptions,
   IApiDeclaredItemOptions,
   IApiTypeParameterListMixinOptions {
-  aliasTypeTokenRange: IExcerptTokenRange;
+  typeTokenRange: IExcerptTokenRange;
 }
 
 export interface IApiTypeAliasJson extends
   IApiDeclaredItemJson,
   IApiTypeParameterListMixinJson {
-  aliasTypeTokenRange: IExcerptTokenRange;
+  typeTokenRange: IExcerptTokenRange;
 }
 
 /**
@@ -65,15 +65,15 @@ export class ApiTypeAlias extends ApiTypeParameterListMixin(ApiNameMixin(ApiRele
    * export type Boxed<T> = T extends any[] ? BoxedArray<T[number]> : BoxedValue<T>;
    * ```
    */
-  public readonly aliasTypeExcerpt: Excerpt;
+  public readonly typeExcerpt: Excerpt;
 
   /** @override */
   public static onDeserializeInto(options: Partial<IApiTypeAliasOptions>, jsonObject: IApiTypeAliasJson): void {
     super.onDeserializeInto(options, jsonObject);
 
     // NOTE: This did not exist in the initial release, so we apply a default
     //       in the event it doesn't exist in 'jsonObject'.
-    options.aliasTypeTokenRange = jsonObject.aliasTypeTokenRange || { startIndex: 0, endIndex: 0 };
+    options.typeTokenRange = jsonObject.typeTokenRange || { startIndex: 0, endIndex: 0 };
   }
 
   public static getCanonicalReference(name: string): string {
@@ -83,7 +83,7 @@ export class ApiTypeAlias extends ApiTypeParameterListMixin(ApiNameMixin(ApiRele
   public constructor(options: IApiTypeAliasOptions) {
     super(options);
 
-    this.aliasTypeExcerpt = this.buildExcerpt(options.aliasTypeTokenRange);
+    this.typeExcerpt = this.buildExcerpt(options.typeTokenRange);
   }
 
   /** @override */
@@ -100,6 +100,6 @@ export class ApiTypeAlias extends ApiTypeParameterListMixin(ApiNameMixin(ApiRele
   public serializeInto(jsonObject: Partial<IApiTypeAliasJson>): void {
     super.serializeInto(jsonObject);
 
-    jsonObject.aliasTypeTokenRange = this.aliasTypeExcerpt.tokenRange;
+    jsonObject.typeTokenRange = this.typeExcerpt.tokenRange;
   }
 }
diff --git a/apps/api-extractor/src/generators/ApiModelGenerator.ts b/apps/api-extractor/src/generators/ApiModelGenerator.ts
@@ -687,8 +687,8 @@ export class ApiModelGenerator {
       const typeParameters: IApiTypeParameterOptions[] = this._captureTypeParameters(nodesToCapture,
         typeAliasDeclaration.typeParameters);
 
-      const aliasTypeTokenRange: IExcerptTokenRange = ExcerptBuilder.createEmptyTokenRange();
-      nodesToCapture.push({ node: typeAliasDeclaration.type, tokenRange: aliasTypeTokenRange });
+      const typeTokenRange: IExcerptTokenRange = ExcerptBuilder.createEmptyTokenRange();
+      nodesToCapture.push({ node: typeAliasDeclaration.type, tokenRange: typeTokenRange });
 
       const excerptTokens: IExcerptToken[] = ExcerptBuilder.build({
         startingNode: astDeclaration.declaration,
@@ -698,7 +698,7 @@ export class ApiModelGenerator {
       const releaseTag: ReleaseTag = this._collector.fetchMetadata(astDeclaration.astSymbol).releaseTag;
 
       apiTypeAlias = new ApiTypeAlias({ name, docComment, typeParameters, releaseTag, excerptTokens,
-        aliasTypeTokenRange });
+        typeTokenRange });
 
       parentApiItem.addMember(apiTypeAlias);
     }
diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.json b/build-tests/api-documenter-test/etc/api-documenter-test.api.json
@@ -1568,7 +1568,7 @@
           ],
           "releaseTag": "Public",
           "name": "ExampleTypeAlias",
-          "aliasTypeTokenRange": {
+          "typeTokenRange": {
             "startIndex": 3,
             "endIndex": 5
           }
diff --git a/common/reviews/api/api-extractor-model.api.md b/common/reviews/api/api-extractor-model.api.md
@@ -500,7 +500,6 @@ export namespace ApiStaticMixin {
 // @public
 export class ApiTypeAlias extends ApiTypeAlias_base {
     constructor(options: IApiTypeAliasOptions);
-    readonly aliasTypeExcerpt: Excerpt;
     // @override (undocumented)
     readonly canonicalReference: string;
     // (undocumented)
@@ -513,6 +512,7 @@ export class ApiTypeAlias extends ApiTypeAlias_base {
     static onDeserializeInto(options: Partial<IApiTypeAliasOptions>, jsonObject: IApiTypeAliasJson): void;
     // @override (undocumented)
     serializeInto(jsonObject: Partial<IApiTypeAliasJson>): void;
+    readonly typeExcerpt: Excerpt;
 }
 
 // @public
@@ -743,7 +743,7 @@ export interface IApiStaticMixinOptions extends IApiItemOptions {
 // @public
 export interface IApiTypeAliasOptions extends IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions, IApiTypeParameterListMixinOptions {
     // (undocumented)
-    aliasTypeTokenRange: IExcerptTokenRange;
+    typeTokenRange: IExcerptTokenRange;
 }
 
 // @public

Original file line number	Diff line number	Diff line change
`@@ -1568,7 +1568,7 @@`
`1568`	`1568`	`],`
`1569`	`1569`	`"releaseTag": "Public",`
`1570`	`1570`	`"name": "ExampleTypeAlias",`
`1571`		`- "aliasTypeTokenRange": {`
	`1571`	`+ "typeTokenRange": {`
`1572`	`1572`	`"startIndex": 3,`
`1573`	`1573`	`"endIndex": 5`
`1574`	`1574`	`}`