Export IApiItemConstructor to eliminate the ae-forgotten-export warning

octogonz · octogonz · commit 01d92eb487ed · 2019-03-15T21:27:38.000-07:00
diff --git a/apps/api-extractor-model/src/index.ts b/apps/api-extractor-model/src/index.ts
@@ -24,7 +24,8 @@ export {
 export {
   ApiItemKind,
   IApiItemOptions,
-  ApiItem
+  ApiItem,
+  IApiItemConstructor
 } from './items/ApiItem';
 export {
   IApiPropertyItemOptions,
diff --git a/apps/api-extractor-model/src/items/ApiItem.ts b/apps/api-extractor-model/src/items/ApiItem.ts
@@ -194,5 +194,10 @@ export class ApiItem {
   }
 }
 
-// For mixins
+/**
+ * This abstraction is used by the mixin pattern.
+ * It describes a class type that inherits from {@link ApiItem}.
+ *
+ * @public
+ */
 export interface IApiItemConstructor extends Constructor<ApiItem>, PropertiesOf<typeof ApiItem> { }
diff --git a/apps/api-extractor-model/src/mixins/Mixin.ts b/apps/api-extractor-model/src/mixins/Mixin.ts
@@ -2,13 +2,16 @@
 // See LICENSE in the project root for license information.
 
 /**
+ * This abstraction is used by the mixin pattern.
+ * It describes a class constructor.
  * @public
  */
 export type Constructor<T = {}> = new (...args: any[]) => T; // tslint:disable-line:no-any
 
 /**
+ * This abstraction is used by the mixin pattern.
+ * It describes the "static side" of a class.
+ *
  * @public
  */
 export type PropertiesOf<T> = { [K in keyof T]: T[K] };
-
-export type Mixin<TBase, TMixin> = TBase & Constructor<TMixin>;
diff --git a/common/reviews/api/api-extractor-model.api.md b/common/reviews/api/api-extractor-model.api.md
@@ -241,8 +241,6 @@ declare class ApiItem {
     serializeInto(jsonObject: Partial<IApiItemJson>): void;
 }
 
-// Warning: (ae-forgotten-export) The symbol "IApiItemConstructor" needs to be exported by the entry point index.d.ts
-// 
 // @public
 declare function ApiItemContainerMixin<TBaseClass extends IApiItemConstructor>(baseClass: TBaseClass): TBaseClass & (new (...args: any[]) => ApiItemContainerMixin);
 
@@ -530,7 +528,7 @@ declare class ApiVariable extends ApiVariable_base {
     readonly variableTypeExcerpt: Excerpt;
 }
 
-// @public (undocumented)
+// @public
 declare type Constructor<T = {}> = new (...args: any[]) => T;
 
 // @public
@@ -632,6 +630,10 @@ interface IApiInterfaceOptions extends IApiItemContainerMixinOptions, IApiNameMi
     extendsTokenRanges: IExcerptTokenRange[];
 }
 
+// @public
+interface IApiItemConstructor extends Constructor<ApiItem>, PropertiesOf<typeof ApiItem> {
+}
+
 // @public
 interface IApiItemContainerMixinOptions extends IApiItemOptions {
     // (undocumented)
@@ -765,7 +767,7 @@ declare class Parameter {
     readonly tsdocParamBlock: tsdoc.DocParamBlock | undefined;
 }
 
-// @public (undocumented)
+// @public
 declare type PropertiesOf<T> = {
     [K in keyof T]: T[K];
 };

Original file line number	Diff line number	Diff line change
`@@ -194,5 +194,10 @@ export class ApiItem {`
`194`	`194`	`}`
`195`	`195`	`}`
`196`	`196`
`197`		`-// For mixins`
	`197`	`+/**`
	`198`	`+ * This abstraction is used by the mixin pattern.`
	`199`	`+ * It describes a class type that inherits from {@link ApiItem}.`
	`200`	`+ *`
	`201`	`+ * @public`
	`202`	`+ */`
`198`	`203`	`export interface IApiItemConstructor extends Constructor<ApiItem>, PropertiesOf<typeof ApiItem> { }`