Add the API docs

pages/api/api-documenter.iapidocumenterpluginmanifest.features.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [IApiDocumenterPluginManifest](./api-documenter.iapidocumenterpluginmanifest.md) &gt; [features](./api-documenter.iapidocumenterpluginmanifest.features.md)
+
+## IApiDocumenterPluginManifest.features property
+
+The list of features provided by this plugin.
+
+<b>Signature:</b>
+
+```typescript
+features: IFeatureDefinition[];
+```

pages/api/api-documenter.iapidocumenterpluginmanifest.manifestversion.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [IApiDocumenterPluginManifest](./api-documenter.iapidocumenterpluginmanifest.md) &gt; [manifestVersion](./api-documenter.iapidocumenterpluginmanifest.manifestversion.md)
+
+## IApiDocumenterPluginManifest.manifestVersion property
+
+The manifest version number. For now, this must always be `1000`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+manifestVersion: 1000;
+```

pages/api/api-documenter.iapidocumenterpluginmanifest.md

@@ -0,0 +1,52 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [IApiDocumenterPluginManifest](./api-documenter.iapidocumenterpluginmanifest.md)
+
+## IApiDocumenterPluginManifest interface
+
+The manifest for an API Documenter plugin.
+
+<b>Signature:</b>
+
+```typescript
+export interface IApiDocumenterPluginManifest 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [features](./api-documenter.iapidocumenterpluginmanifest.features.md) | <code>IFeatureDefinition[]</code> | The list of features provided by this plugin. |
+|  [manifestVersion](./api-documenter.iapidocumenterpluginmanifest.manifestversion.md) | <code>1000</code> | The manifest version number. For now, this must always be <code>1000</code>. |
+
+## Remarks
+
+An API documenter plugin is an NPM package. By convention, the NPM package name should have the prefix `doc-plugin-`<!-- -->. Its main entry point should export an object named `apiDocumenterPluginManifest` which implements the `IApiDocumenterPluginManifest` interface.
+
+For example:
+
+```ts
+class MyMarkdownDocumenter extends MarkdownDocumenterFeature {
+  public onInitialized(): void {
+    console.log('MyMarkdownDocumenter: onInitialized()');
+  }
+}
+
+export const apiDocumenterPluginManifest: IApiDocumenterPluginManifest = {
+  manifestVersion: 1000,
+  features: [
+    {
+      featureName: 'my-markdown-documenter',
+      kind: 'MarkdownDocumenterFeature',
+      subclass: MyMarkdownDocumenter
+    }
+  ]
+};
+
+```
+

pages/api/api-documenter.ifeaturedefinition.featurename.md

@@ -0,0 +1,20 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [IFeatureDefinition](./api-documenter.ifeaturedefinition.md) &gt; [featureName](./api-documenter.ifeaturedefinition.featurename.md)
+
+## IFeatureDefinition.featureName property
+
+The name of this feature, as it will appear in the config file.
+
+The name should consist of one or more words separated by hyphens. Each word should consist of lower case letters and numbers. Example: `my-feature`
+
+<b>Signature:</b>
+
+```typescript
+featureName: string;
+```

pages/api/api-documenter.ifeaturedefinition.kind.md

@@ -0,0 +1,23 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [IFeatureDefinition](./api-documenter.ifeaturedefinition.md) &gt; [kind](./api-documenter.ifeaturedefinition.kind.md)
+
+## IFeatureDefinition.kind property
+
+Determines the kind of feature. The specified value is the name of the base class that `subclass` inherits from.
+
+<b>Signature:</b>
+
+```typescript
+kind: 'MarkdownDocumenterFeature';
+```
+
+## Remarks
+
+For now, `MarkdownDocumenterFeature` is the only supported value.
+

pages/api/api-documenter.ifeaturedefinition.md

@@ -0,0 +1,27 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [IFeatureDefinition](./api-documenter.ifeaturedefinition.md)
+
+## IFeatureDefinition interface
+
+Defines a "feature" that is provided by an API Documenter plugin. A feature is a user-defined module that customizes the behavior of API Documenter.
+
+<b>Signature:</b>
+
+```typescript
+export interface IFeatureDefinition 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [featureName](./api-documenter.ifeaturedefinition.featurename.md) | <code>string</code> | The name of this feature, as it will appear in the config file.<!-- -->The name should consist of one or more words separated by hyphens. Each word should consist of lower case letters and numbers. Example: <code>my-feature</code> |
+|  [kind](./api-documenter.ifeaturedefinition.kind.md) | <code>'MarkdownDocumenterFeature'</code> | Determines the kind of feature. The specified value is the name of the base class that <code>subclass</code> inherits from. |
+|  [subclass](./api-documenter.ifeaturedefinition.subclass.md) | <code>{</code><br/><code>        new (initialization: PluginFeatureInitialization): MarkdownDocumenterFeature;</code><br/><code>    }</code> | Your subclass that extends from the base class. |
+

pages/api/api-documenter.ifeaturedefinition.subclass.md

@@ -0,0 +1,20 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [IFeatureDefinition](./api-documenter.ifeaturedefinition.md) &gt; [subclass](./api-documenter.ifeaturedefinition.subclass.md)
+
+## IFeatureDefinition.subclass property
+
+Your subclass that extends from the base class.
+
+<b>Signature:</b>
+
+```typescript
+subclass: {
+        new (initialization: PluginFeatureInitialization): MarkdownDocumenterFeature;
+    };
+```

pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.apiitem.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [IMarkdownDocumenterFeatureOnBeforeWritePageArgs](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.md) &gt; [apiItem](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.apiitem.md)
+
+## IMarkdownDocumenterFeatureOnBeforeWritePageArgs.apiItem property
+
+The API item corresponding to this page.
+
+<b>Signature:</b>
+
+```typescript
+readonly apiItem: ApiItem;
+```

pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.md

@@ -0,0 +1,27 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [IMarkdownDocumenterFeatureOnBeforeWritePageArgs](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.md)
+
+## IMarkdownDocumenterFeatureOnBeforeWritePageArgs interface
+
+Event arguments for MarkdownDocumenterFeature.onBeforeWritePage()
+
+<b>Signature:</b>
+
+```typescript
+export interface IMarkdownDocumenterFeatureOnBeforeWritePageArgs 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [apiItem](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.apiitem.md) | <code>ApiItem</code> | The API item corresponding to this page. |
+|  [outputFilename](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.outputfilename.md) | <code>string</code> | The filename where the output will be written. |
+|  [pageContent](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.pagecontent.md) | <code>string</code> | The page content. The onBeforeWritePage() handler can reassign this string to customize the page appearance. |
+

pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.outputfilename.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [IMarkdownDocumenterFeatureOnBeforeWritePageArgs](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.md) &gt; [outputFilename](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.outputfilename.md)
+
+## IMarkdownDocumenterFeatureOnBeforeWritePageArgs.outputFilename property
+
+The filename where the output will be written.
+
+<b>Signature:</b>
+
+```typescript
+readonly outputFilename: string;
+```

pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.pagecontent.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [IMarkdownDocumenterFeatureOnBeforeWritePageArgs](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.md) &gt; [pageContent](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.pagecontent.md)
+
+## IMarkdownDocumenterFeatureOnBeforeWritePageArgs.pageContent property
+
+The page content. The onBeforeWritePage() handler can reassign this string to customize the page appearance.
+
+<b>Signature:</b>
+
+```typescript
+pageContent: string;
+```

pages/api/api-documenter.imarkdowndocumenterfeatureonfinishedargs.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [IMarkdownDocumenterFeatureOnFinishedArgs](./api-documenter.imarkdowndocumenterfeatureonfinishedargs.md)
+
+## IMarkdownDocumenterFeatureOnFinishedArgs interface
+
+Event arguments for MarkdownDocumenterFeature.onFinished()
+
+<b>Signature:</b>
+
+```typescript
+export interface IMarkdownDocumenterFeatureOnFinishedArgs 
+```

pages/api/api-documenter.markdowndocumenteraccessor.getlinkforapiitem.md

@@ -0,0 +1,31 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [MarkdownDocumenterAccessor](./api-documenter.markdowndocumenteraccessor.md) &gt; [getLinkForApiItem](./api-documenter.markdowndocumenteraccessor.getlinkforapiitem.md)
+
+## MarkdownDocumenterAccessor.getLinkForApiItem() method
+
+For a given `ApiItem`<!-- -->, return its markdown hyperlink.
+
+<b>Signature:</b>
+
+```typescript
+getLinkForApiItem(apiItem: ApiItem): string | undefined;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  apiItem | <code>ApiItem</code> |  |
+
+<b>Returns:</b>
+
+`string | undefined`
+
+The hyperlink, or `undefined` if the `ApiItem` object does not have a hyperlink.
+

pages/api/api-documenter.markdowndocumenteraccessor.md

@@ -0,0 +1,29 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [MarkdownDocumenterAccessor](./api-documenter.markdowndocumenteraccessor.md)
+
+## MarkdownDocumenterAccessor class
+
+Provides access to the documenter that is generating the output.
+
+<b>Signature:</b>
+
+```typescript
+export declare class MarkdownDocumenterAccessor 
+```
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [getLinkForApiItem(apiItem)](./api-documenter.markdowndocumenteraccessor.getlinkforapiitem.md) |  | For a given <code>ApiItem</code>, return its markdown hyperlink. |
+
+## Remarks
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MarkdownDocumenterAccessor` class.
+

pages/api/api-documenter.markdowndocumenterfeature.context.md

@@ -0,0 +1,16 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [MarkdownDocumenterFeature](./api-documenter.markdowndocumenterfeature.md) &gt; [context](./api-documenter.markdowndocumenterfeature.context.md)
+
+## MarkdownDocumenterFeature.context property
+
+<b>Signature:</b>
+
+```typescript
+context: MarkdownDocumenterFeatureContext;
+```

pages/api/api-documenter.markdowndocumenterfeature.md

@@ -0,0 +1,32 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [MarkdownDocumenterFeature](./api-documenter.markdowndocumenterfeature.md)
+
+## MarkdownDocumenterFeature class
+
+Inherit from this base class to implement an API Documenter plugin feature that customizes the generation of markdown output.
+
+<b>Signature:</b>
+
+```typescript
+export declare class MarkdownDocumenterFeature extends PluginFeature 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [context](./api-documenter.markdowndocumenterfeature.context.md) |  | <code>MarkdownDocumenterFeatureContext</code> |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [onBeforeWritePage(eventArgs)](./api-documenter.markdowndocumenterfeature.onbeforewritepage.md) |  | This event occurs before each markdown file is written. It provides an opportunity to customize the content of the file. |
+|  [onFinished(eventArgs)](./api-documenter.markdowndocumenterfeature.onfinished.md) |  | This event occurs after all output files have been written. |
+

pages/api/api-documenter.markdowndocumenterfeature.onbeforewritepage.md

@@ -0,0 +1,30 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [MarkdownDocumenterFeature](./api-documenter.markdowndocumenterfeature.md) &gt; [onBeforeWritePage](./api-documenter.markdowndocumenterfeature.onbeforewritepage.md)
+
+## MarkdownDocumenterFeature.onBeforeWritePage() method
+
+This event occurs before each markdown file is written. It provides an opportunity to customize the content of the file.
+
+<b>Signature:</b>
+
+```typescript
+/** @virtual */
+onBeforeWritePage(eventArgs: IMarkdownDocumenterFeatureOnBeforeWritePageArgs): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  eventArgs | <code>IMarkdownDocumenterFeatureOnBeforeWritePageArgs</code> |  |
+
+<b>Returns:</b>
+
+`void`
+

pages/api/api-documenter.markdowndocumenterfeature.onfinished.md

@@ -0,0 +1,30 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [MarkdownDocumenterFeature](./api-documenter.markdowndocumenterfeature.md) &gt; [onFinished](./api-documenter.markdowndocumenterfeature.onfinished.md)
+
+## MarkdownDocumenterFeature.onFinished() method
+
+This event occurs after all output files have been written.
+
+<b>Signature:</b>
+
+```typescript
+/** @virtual */
+onFinished(eventArgs: IMarkdownDocumenterFeatureOnFinishedArgs): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  eventArgs | <code>IMarkdownDocumenterFeatureOnFinishedArgs</code> |  |
+
+<b>Returns:</b>
+
+`void`
+

pages/api/api-documenter.markdowndocumenterfeaturecontext.apimodel.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [MarkdownDocumenterFeatureContext](./api-documenter.markdowndocumenterfeaturecontext.md) &gt; [apiModel](./api-documenter.markdowndocumenterfeaturecontext.apimodel.md)
+
+## MarkdownDocumenterFeatureContext.apiModel property
+
+Provides access to the `ApiModel` for the documentation being generated.
+
+<b>Signature:</b>
+
+```typescript
+readonly apiModel: ApiModel;
+```

pages/api/api-documenter.markdowndocumenterfeaturecontext.documenter.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [MarkdownDocumenterFeatureContext](./api-documenter.markdowndocumenterfeaturecontext.md) &gt; [documenter](./api-documenter.markdowndocumenterfeaturecontext.documenter.md)
+
+## MarkdownDocumenterFeatureContext.documenter property
+
+Exposes functionality of the documenter.
+
+<b>Signature:</b>
+
+```typescript
+readonly documenter: MarkdownDocumenterAccessor;
+```

pages/api/api-documenter.markdowndocumenterfeaturecontext.md

@@ -0,0 +1,31 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [MarkdownDocumenterFeatureContext](./api-documenter.markdowndocumenterfeaturecontext.md)
+
+## MarkdownDocumenterFeatureContext class
+
+Context object for [MarkdownDocumenterFeature](./api-documenter.markdowndocumenterfeature.md)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export declare class MarkdownDocumenterFeatureContext 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [apiModel](./api-documenter.markdowndocumenterfeaturecontext.apimodel.md) |  | <code>ApiModel</code> | Provides access to the <code>ApiModel</code> for the documentation being generated. |
+|  [documenter](./api-documenter.markdowndocumenterfeaturecontext.documenter.md) |  | <code>MarkdownDocumenterAccessor</code> | Exposes functionality of the documenter. |
+|  [outputFolder](./api-documenter.markdowndocumenterfeaturecontext.outputfolder.md) |  | <code>string</code> | The full path to the output folder. |
+
+## Remarks
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MarkdownDocumenterFeatureContext` class.
+

pages/api/api-documenter.markdowndocumenterfeaturecontext.outputfolder.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [MarkdownDocumenterFeatureContext](./api-documenter.markdowndocumenterfeaturecontext.md) &gt; [outputFolder](./api-documenter.markdowndocumenterfeaturecontext.outputfolder.md)
+
+## MarkdownDocumenterFeatureContext.outputFolder property
+
+The full path to the output folder.
+
+<b>Signature:</b>
+
+```typescript
+readonly outputFolder: string;
+```

pages/api/api-documenter.md

@@ -0,0 +1,31 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md)
+
+## api-documenter package
+
+## Classes
+
+|  Class | Description |
+|  --- | --- |
+|  [MarkdownDocumenterAccessor](./api-documenter.markdowndocumenteraccessor.md) | Provides access to the documenter that is generating the output. |
+|  [MarkdownDocumenterFeature](./api-documenter.markdowndocumenterfeature.md) | Inherit from this base class to implement an API Documenter plugin feature that customizes the generation of markdown output. |
+|  [MarkdownDocumenterFeatureContext](./api-documenter.markdowndocumenterfeaturecontext.md) | Context object for [MarkdownDocumenterFeature](./api-documenter.markdowndocumenterfeature.md)<!-- -->. |
+|  [PluginFeature](./api-documenter.pluginfeature.md) | The abstract base class for all API Documenter plugin features. |
+|  [PluginFeatureContext](./api-documenter.pluginfeaturecontext.md) | Context object for [PluginFeature](./api-documenter.pluginfeature.md)<!-- -->. |
+|  [PluginFeatureInitialization](./api-documenter.pluginfeatureinitialization.md) | This is an internal part of the plugin infrastructure. |
+
+## Interfaces
+
+|  Interface | Description |
+|  --- | --- |
+|  [IApiDocumenterPluginManifest](./api-documenter.iapidocumenterpluginmanifest.md) | The manifest for an API Documenter plugin. |
+|  [IFeatureDefinition](./api-documenter.ifeaturedefinition.md) | Defines a "feature" that is provided by an API Documenter plugin. A feature is a user-defined module that customizes the behavior of API Documenter. |
+|  [IMarkdownDocumenterFeatureOnBeforeWritePageArgs](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.md) | Event arguments for MarkdownDocumenterFeature.onBeforeWritePage() |
+|  [IMarkdownDocumenterFeatureOnFinishedArgs](./api-documenter.imarkdowndocumenterfeatureonfinishedargs.md) | Event arguments for MarkdownDocumenterFeature.onFinished() |
+

pages/api/api-documenter.pluginfeature.context.md

@@ -0,0 +1,16 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [PluginFeature](./api-documenter.pluginfeature.md) &gt; [context](./api-documenter.pluginfeature.context.md)
+
+## PluginFeature.context property
+
+<b>Signature:</b>
+
+```typescript
+context: PluginFeatureContext;
+```

pages/api/api-documenter.pluginfeature.md

@@ -0,0 +1,35 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [PluginFeature](./api-documenter.pluginfeature.md)
+
+## PluginFeature class
+
+The abstract base class for all API Documenter plugin features.
+
+<b>Signature:</b>
+
+```typescript
+export declare abstract class PluginFeature 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [context](./api-documenter.pluginfeature.context.md) |  | <code>PluginFeatureContext</code> |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [onInitialized()](./api-documenter.pluginfeature.oninitialized.md) |  | This event function is called after the feature is initialized, but before any processing occurs. |
+
+## Remarks
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PluginFeature` class.
+

pages/api/api-documenter.pluginfeature.oninitialized.md

@@ -0,0 +1,23 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [PluginFeature](./api-documenter.pluginfeature.md) &gt; [onInitialized](./api-documenter.pluginfeature.oninitialized.md)
+
+## PluginFeature.onInitialized() method
+
+This event function is called after the feature is initialized, but before any processing occurs.
+
+<b>Signature:</b>
+
+```typescript
+/** @virtual */
+onInitialized(): void;
+```
+<b>Returns:</b>
+
+`void`
+

pages/api/api-documenter.pluginfeaturecontext.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [PluginFeatureContext](./api-documenter.pluginfeaturecontext.md)
+
+## PluginFeatureContext class
+
+Context object for [PluginFeature](./api-documenter.pluginfeature.md)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export declare class PluginFeatureContext 
+```

pages/api/api-documenter.pluginfeatureinitialization.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-documenter](./api-documenter.md) &gt; [PluginFeatureInitialization](./api-documenter.pluginfeatureinitialization.md)
+
+## PluginFeatureInitialization class
+
+This is an internal part of the plugin infrastructure.
+
+<b>Signature:</b>
+
+```typescript
+export declare class PluginFeatureInitialization 
+```
+
+## Remarks
+
+This object is the constructor parameter for API Documenter plugin features.
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PluginFeatureInitialization` class.
+

pages/api/api-extractor-model.apicallsignature._constructor_.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiCallSignature](./api-extractor-model.apicallsignature.md) &gt; [(constructor)](./api-extractor-model.apicallsignature._constructor_.md)
+
+## ApiCallSignature.(constructor)
+
+Constructs a new instance of the `ApiCallSignature` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: IApiCallSignatureOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | <code>IApiCallSignatureOptions</code> |  |
+

pages/api/api-extractor-model.apicallsignature.buildcanonicalreference.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiCallSignature](./api-extractor-model.apicallsignature.md) &gt; [buildCanonicalReference](./api-extractor-model.apicallsignature.buildcanonicalreference.md)
+
+## ApiCallSignature.buildCanonicalReference() method
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+buildCanonicalReference(): DeclarationReference;
+```
+<b>Returns:</b>
+
+`DeclarationReference`
+

pages/api/api-extractor-model.apicallsignature.containerkey.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiCallSignature](./api-extractor-model.apicallsignature.md) &gt; [containerKey](./api-extractor-model.apicallsignature.containerkey.md)
+
+## ApiCallSignature.containerKey property
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+readonly containerKey: string;
+```

pages/api/api-extractor-model.apicallsignature.getcontainerkey.md

@@ -0,0 +1,27 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiCallSignature](./api-extractor-model.apicallsignature.md) &gt; [getContainerKey](./api-extractor-model.apicallsignature.getcontainerkey.md)
+
+## ApiCallSignature.getContainerKey() method
+
+<b>Signature:</b>
+
+```typescript
+static getContainerKey(overloadIndex: number): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  overloadIndex | <code>number</code> |  |
+
+<b>Returns:</b>
+
+`string`
+

pages/api/api-extractor-model.apicallsignature.kind.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiCallSignature](./api-extractor-model.apicallsignature.md) &gt; [kind](./api-extractor-model.apicallsignature.kind.md)
+
+## ApiCallSignature.kind property
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+readonly kind: ApiItemKind;
+```

pages/api/api-extractor-model.apicallsignature.md

@@ -0,0 +1,62 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiCallSignature](./api-extractor-model.apicallsignature.md)
+
+## ApiCallSignature class
+
+Represents a TypeScript function call signature.
+
+<b>Signature:</b>
+
+```typescript
+export declare class ApiCallSignature extends ApiCallSignature_base 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./api-extractor-model.apicallsignature._constructor_.md) |  | Constructs a new instance of the <code>ApiCallSignature</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [containerKey](./api-extractor-model.apicallsignature.containerkey.md) |  | <code>string</code> |  |
+|  [kind](./api-extractor-model.apicallsignature.kind.md) |  | <code>ApiItemKind</code> |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [buildCanonicalReference()](./api-extractor-model.apicallsignature.buildcanonicalreference.md) |  | <b><i>(BETA)</i></b> |
+|  [getContainerKey(overloadIndex)](./api-extractor-model.apicallsignature.getcontainerkey.md) | <code>static</code> |  |
+
+## Remarks
+
+This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations.
+
+`ApiCallSignature` represents a TypeScript declaration such as `(x: number, y: number): number` in this example:
+
+```ts
+export interface IChooser {
+  // A call signature:
+  (x: number, y: number): number;
+
+  // Another overload for this call signature:
+  (x: string, y: string): string;
+}
+
+function chooseFirst<T>(x: T, y: T): T {
+  return x;
+}
+
+let chooser: IChooser = chooseFirst;
+
+```
+

pages/api/api-extractor-model.apiclass._constructor_.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiClass](./api-extractor-model.apiclass.md) &gt; [(constructor)](./api-extractor-model.apiclass._constructor_.md)
+
+## ApiClass.(constructor)
+
+Constructs a new instance of the `ApiClass` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: IApiClassOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | <code>IApiClassOptions</code> |  |
+

pages/api/api-extractor-model.apiclass.buildcanonicalreference.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiClass](./api-extractor-model.apiclass.md) &gt; [buildCanonicalReference](./api-extractor-model.apiclass.buildcanonicalreference.md)
+
+## ApiClass.buildCanonicalReference() method
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+buildCanonicalReference(): DeclarationReference;
+```
+<b>Returns:</b>
+
+`DeclarationReference`
+

pages/api/api-extractor-model.apiclass.containerkey.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiClass](./api-extractor-model.apiclass.md) &gt; [containerKey](./api-extractor-model.apiclass.containerkey.md)
+
+## ApiClass.containerKey property
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+readonly containerKey: string;
+```

pages/api/api-extractor-model.apiclass.extendstype.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiClass](./api-extractor-model.apiclass.md) &gt; [extendsType](./api-extractor-model.apiclass.extendstype.md)
+
+## ApiClass.extendsType property
+
+The base class that this class inherits from (using the `extends` keyword), or undefined if there is no base class.
+
+<b>Signature:</b>
+
+```typescript
+readonly extendsType: HeritageType | undefined;
+```

pages/api/api-extractor-model.apiclass.getcontainerkey.md

@@ -0,0 +1,27 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiClass](./api-extractor-model.apiclass.md) &gt; [getContainerKey](./api-extractor-model.apiclass.getcontainerkey.md)
+
+## ApiClass.getContainerKey() method
+
+<b>Signature:</b>
+
+```typescript
+static getContainerKey(name: string): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  name | <code>string</code> |  |
+
+<b>Returns:</b>
+
+`string`
+

pages/api/api-extractor-model.apiclass.implementstypes.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiClass](./api-extractor-model.apiclass.md) &gt; [implementsTypes](./api-extractor-model.apiclass.implementstypes.md)
+
+## ApiClass.implementsTypes property
+
+The list of interfaces that this class implements using the `implements` keyword.
+
+<b>Signature:</b>
+
+```typescript
+readonly implementsTypes: ReadonlyArray<HeritageType>;
+```

pages/api/api-extractor-model.apiclass.kind.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiClass](./api-extractor-model.apiclass.md) &gt; [kind](./api-extractor-model.apiclass.kind.md)
+
+## ApiClass.kind property
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+readonly kind: ApiItemKind;
+```

pages/api/api-extractor-model.apiclass.md

@@ -0,0 +1,54 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiClass](./api-extractor-model.apiclass.md)
+
+## ApiClass class
+
+Represents a TypeScript class declaration.
+
+<b>Signature:</b>
+
+```typescript
+export declare class ApiClass extends ApiClass_base 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./api-extractor-model.apiclass._constructor_.md) |  | Constructs a new instance of the <code>ApiClass</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [containerKey](./api-extractor-model.apiclass.containerkey.md) |  | <code>string</code> |  |
+|  [extendsType](./api-extractor-model.apiclass.extendstype.md) |  | <code>HeritageType &#124; undefined</code> | The base class that this class inherits from (using the <code>extends</code> keyword), or undefined if there is no base class. |
+|  [implementsTypes](./api-extractor-model.apiclass.implementstypes.md) |  | <code>ReadonlyArray&lt;HeritageType&gt;</code> | The list of interfaces that this class implements using the <code>implements</code> keyword. |
+|  [kind](./api-extractor-model.apiclass.kind.md) |  | <code>ApiItemKind</code> |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [buildCanonicalReference()](./api-extractor-model.apiclass.buildcanonicalreference.md) |  | <b><i>(BETA)</i></b> |
+|  [getContainerKey(name)](./api-extractor-model.apiclass.getcontainerkey.md) | <code>static</code> |  |
+|  [onDeserializeInto(options, context, jsonObject)](./api-extractor-model.apiclass.ondeserializeinto.md) | <code>static</code> |  |
+|  [serializeInto(jsonObject)](./api-extractor-model.apiclass.serializeinto.md) |  |  |
+
+## Remarks
+
+This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations.
+
+`ApiClass` represents a TypeScript declaration such as this:
+
+```ts
+export class X { }
+
+```
+

pages/api/api-extractor-model.apiclass.ondeserializeinto.md

@@ -0,0 +1,31 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiClass](./api-extractor-model.apiclass.md) &gt; [onDeserializeInto](./api-extractor-model.apiclass.ondeserializeinto.md)
+
+## ApiClass.onDeserializeInto() method
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+static onDeserializeInto(options: Partial<IApiClassOptions>, context: DeserializerContext, jsonObject: IApiClassJson): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | <code>Partial&lt;IApiClassOptions&gt;</code> |  |
+|  context | <code>DeserializerContext</code> |  |
+|  jsonObject | <code>IApiClassJson</code> |  |
+
+<b>Returns:</b>
+
+`void`
+

pages/api/api-extractor-model.apiclass.serializeinto.md

@@ -0,0 +1,29 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiClass](./api-extractor-model.apiclass.md) &gt; [serializeInto](./api-extractor-model.apiclass.serializeinto.md)
+
+## ApiClass.serializeInto() method
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+serializeInto(jsonObject: Partial<IApiClassJson>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  jsonObject | <code>Partial&lt;IApiClassJson&gt;</code> |  |
+
+<b>Returns:</b>
+
+`void`
+

pages/api/api-extractor-model.apiconstructor._constructor_.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiConstructor](./api-extractor-model.apiconstructor.md) &gt; [(constructor)](./api-extractor-model.apiconstructor._constructor_.md)
+
+## ApiConstructor.(constructor)
+
+Constructs a new instance of the `ApiConstructor` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: IApiConstructorOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | <code>IApiConstructorOptions</code> |  |
+

pages/api/api-extractor-model.apiconstructor.buildcanonicalreference.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiConstructor](./api-extractor-model.apiconstructor.md) &gt; [buildCanonicalReference](./api-extractor-model.apiconstructor.buildcanonicalreference.md)
+
+## ApiConstructor.buildCanonicalReference() method
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+buildCanonicalReference(): DeclarationReference;
+```
+<b>Returns:</b>
+
+`DeclarationReference`
+

pages/api/api-extractor-model.apiconstructor.containerkey.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiConstructor](./api-extractor-model.apiconstructor.md) &gt; [containerKey](./api-extractor-model.apiconstructor.containerkey.md)
+
+## ApiConstructor.containerKey property
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+readonly containerKey: string;
+```

pages/api/api-extractor-model.apiconstructor.getcontainerkey.md

@@ -0,0 +1,27 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiConstructor](./api-extractor-model.apiconstructor.md) &gt; [getContainerKey](./api-extractor-model.apiconstructor.getcontainerkey.md)
+
+## ApiConstructor.getContainerKey() method
+
+<b>Signature:</b>
+
+```typescript
+static getContainerKey(overloadIndex: number): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  overloadIndex | <code>number</code> |  |
+
+<b>Returns:</b>
+
+`string`
+

pages/api/api-extractor-model.apiconstructor.kind.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiConstructor](./api-extractor-model.apiconstructor.md) &gt; [kind](./api-extractor-model.apiconstructor.kind.md)
+
+## ApiConstructor.kind property
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+readonly kind: ApiItemKind;
+```

pages/api/api-extractor-model.apiconstructor.md

@@ -0,0 +1,60 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiConstructor](./api-extractor-model.apiconstructor.md)
+
+## ApiConstructor class
+
+Represents a TypeScript class constructor declaration that belongs to an `ApiClass`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export declare class ApiConstructor extends ApiConstructor_base 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./api-extractor-model.apiconstructor._constructor_.md) |  | Constructs a new instance of the <code>ApiConstructor</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [containerKey](./api-extractor-model.apiconstructor.containerkey.md) |  | <code>string</code> |  |
+|  [kind](./api-extractor-model.apiconstructor.kind.md) |  | <code>ApiItemKind</code> |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [buildCanonicalReference()](./api-extractor-model.apiconstructor.buildcanonicalreference.md) |  | <b><i>(BETA)</i></b> |
+|  [getContainerKey(overloadIndex)](./api-extractor-model.apiconstructor.getcontainerkey.md) | <code>static</code> |  |
+
+## Remarks
+
+This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations.
+
+`ApiConstructor` represents a declaration using the `constructor` keyword such as in this example:
+
+```ts
+export class Vector {
+  public x: number;
+  public y: number;
+
+  // A class constructor:
+  public constructor(x: number, y: number) {
+    this.x = x;
+    this.y = y;
+  }
+}
+
+```
+Compare with [ApiConstructSignature](./api-extractor-model.apiconstructsignature.md)<!-- -->, which describes the construct signature for a class constructor.
+

pages/api/api-extractor-model.apiconstructsignature._constructor_.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiConstructSignature](./api-extractor-model.apiconstructsignature.md) &gt; [(constructor)](./api-extractor-model.apiconstructsignature._constructor_.md)
+
+## ApiConstructSignature.(constructor)
+
+Constructs a new instance of the `ApiConstructSignature` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: IApiConstructSignatureOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | <code>IApiConstructSignatureOptions</code> |  |
+

pages/api/api-extractor-model.apiconstructsignature.buildcanonicalreference.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiConstructSignature](./api-extractor-model.apiconstructsignature.md) &gt; [buildCanonicalReference](./api-extractor-model.apiconstructsignature.buildcanonicalreference.md)
+
+## ApiConstructSignature.buildCanonicalReference() method
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+buildCanonicalReference(): DeclarationReference;
+```
+<b>Returns:</b>
+
+`DeclarationReference`
+

pages/api/api-extractor-model.apiconstructsignature.containerkey.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiConstructSignature](./api-extractor-model.apiconstructsignature.md) &gt; [containerKey](./api-extractor-model.apiconstructsignature.containerkey.md)
+
+## ApiConstructSignature.containerKey property
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+readonly containerKey: string;
+```

pages/api/api-extractor-model.apiconstructsignature.getcontainerkey.md

@@ -0,0 +1,27 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiConstructSignature](./api-extractor-model.apiconstructsignature.md) &gt; [getContainerKey](./api-extractor-model.apiconstructsignature.getcontainerkey.md)
+
+## ApiConstructSignature.getContainerKey() method
+
+<b>Signature:</b>
+
+```typescript
+static getContainerKey(overloadIndex: number): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  overloadIndex | <code>number</code> |  |
+
+<b>Returns:</b>
+
+`string`
+

pages/api/api-extractor-model.apiconstructsignature.kind.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiConstructSignature](./api-extractor-model.apiconstructsignature.md) &gt; [kind](./api-extractor-model.apiconstructsignature.kind.md)
+
+## ApiConstructSignature.kind property
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+readonly kind: ApiItemKind;
+```

pages/api/api-extractor-model.apiconstructsignature.md

@@ -0,0 +1,75 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiConstructSignature](./api-extractor-model.apiconstructsignature.md)
+
+## ApiConstructSignature class
+
+Represents a TypeScript construct signature that belongs to an `ApiInterface`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export declare class ApiConstructSignature extends ApiConstructSignature_base 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./api-extractor-model.apiconstructsignature._constructor_.md) |  | Constructs a new instance of the <code>ApiConstructSignature</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [containerKey](./api-extractor-model.apiconstructsignature.containerkey.md) |  | <code>string</code> |  |
+|  [kind](./api-extractor-model.apiconstructsignature.kind.md) |  | <code>ApiItemKind</code> |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [buildCanonicalReference()](./api-extractor-model.apiconstructsignature.buildcanonicalreference.md) |  | <b><i>(BETA)</i></b> |
+|  [getContainerKey(overloadIndex)](./api-extractor-model.apiconstructsignature.getcontainerkey.md) | <code>static</code> |  |
+
+## Remarks
+
+This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations.
+
+`ApiConstructSignature` represents a construct signature using the `new` keyword such as in this example:
+
+```ts
+export interface IVector {
+  x: number;
+  y: number;
+}
+
+export interface IVectorConstructor {
+  // A construct signature:
+  new(x: number, y: number): IVector;
+}
+
+export function createVector(vectorConstructor: IVectorConstructor,
+  x: number, y: number): IVector {
+  return new vectorConstructor(x, y);
+}
+
+class Vector implements IVector {
+  public x: number;
+  public y: number;
+  public constructor(x: number, y: number) {
+    this.x = x;
+    this.y = y;
+  }
+}
+
+let vector: Vector = createVector(Vector, 1, 2);
+
+```
+Compare with [ApiConstructor](./api-extractor-model.apiconstructor.md)<!-- -->, which describes the class constructor itself.
+

pages/api/api-extractor-model.apideclareditem._constructor_.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) &gt; [(constructor)](./api-extractor-model.apideclareditem._constructor_.md)
+
+## ApiDeclaredItem.(constructor)
+
+Constructs a new instance of the `ApiDeclaredItem` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: IApiDeclaredItemOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | <code>IApiDeclaredItemOptions</code> |  |
+

pages/api/api-extractor-model.apideclareditem.buildexcerpt.md

@@ -0,0 +1,29 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) &gt; [buildExcerpt](./api-extractor-model.apideclareditem.buildexcerpt.md)
+
+## ApiDeclaredItem.buildExcerpt() method
+
+Constructs a new [Excerpt](./api-extractor-model.excerpt.md) corresponding to the provided token range.
+
+<b>Signature:</b>
+
+```typescript
+buildExcerpt(tokenRange: IExcerptTokenRange): Excerpt;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  tokenRange | <code>IExcerptTokenRange</code> |  |
+
+<b>Returns:</b>
+
+`Excerpt`
+

pages/api/api-extractor-model.apideclareditem.excerpt.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) &gt; [excerpt](./api-extractor-model.apideclareditem.excerpt.md)
+
+## ApiDeclaredItem.excerpt property
+
+The source code excerpt where the API item is declared.
+
+<b>Signature:</b>
+
+```typescript
+readonly excerpt: Excerpt;
+```

pages/api/api-extractor-model.apideclareditem.excerpttokens.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) &gt; [excerptTokens](./api-extractor-model.apideclareditem.excerpttokens.md)
+
+## ApiDeclaredItem.excerptTokens property
+
+The individual source code tokens that comprise the main excerpt.
+
+<b>Signature:</b>
+
+```typescript
+readonly excerptTokens: ReadonlyArray<ExcerptToken>;
+```

pages/api/api-extractor-model.apideclareditem.getexcerptwithmodifiers.md

@@ -0,0 +1,22 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) &gt; [getExcerptWithModifiers](./api-extractor-model.apideclareditem.getexcerptwithmodifiers.md)
+
+## ApiDeclaredItem.getExcerptWithModifiers() method
+
+If the API item has certain important modifier tags such as `@sealed`<!-- -->, `@virtual`<!-- -->, or `@override`<!-- -->, this prepends them as a doc comment above the excerpt.
+
+<b>Signature:</b>
+
+```typescript
+getExcerptWithModifiers(): string;
+```
+<b>Returns:</b>
+
+`string`
+

pages/api/api-extractor-model.apideclareditem.md

@@ -0,0 +1,47 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiDeclaredItem](./api-extractor-model.apideclareditem.md)
+
+## ApiDeclaredItem class
+
+The base class for API items that have an associated source code excerpt containing a TypeScript declaration.
+
+<b>Signature:</b>
+
+```typescript
+export declare class ApiDeclaredItem extends ApiDocumentedItem 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./api-extractor-model.apideclareditem._constructor_.md) |  | Constructs a new instance of the <code>ApiDeclaredItem</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [excerpt](./api-extractor-model.apideclareditem.excerpt.md) |  | <code>Excerpt</code> | The source code excerpt where the API item is declared. |
+|  [excerptTokens](./api-extractor-model.apideclareditem.excerpttokens.md) |  | <code>ReadonlyArray&lt;ExcerptToken&gt;</code> | The individual source code tokens that comprise the main excerpt. |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [buildExcerpt(tokenRange)](./api-extractor-model.apideclareditem.buildexcerpt.md) |  | Constructs a new [Excerpt](./api-extractor-model.excerpt.md) corresponding to the provided token range. |
+|  [getExcerptWithModifiers()](./api-extractor-model.apideclareditem.getexcerptwithmodifiers.md) |  | If the API item has certain important modifier tags such as <code>@sealed</code>, <code>@virtual</code>, or <code>@override</code>, this prepends them as a doc comment above the excerpt. |
+|  [onDeserializeInto(options, context, jsonObject)](./api-extractor-model.apideclareditem.ondeserializeinto.md) | <code>static</code> |  |
+|  [serializeInto(jsonObject)](./api-extractor-model.apideclareditem.serializeinto.md) |  |  |
+
+## Remarks
+
+This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations.
+
+Most `ApiItem` subclasses have declarations and thus extend `ApiDeclaredItem`<!-- -->. Counterexamples include `ApiModel` and `ApiPackage`<!-- -->, which do not have any corresponding TypeScript source code.
+

pages/api/api-extractor-model.apideclareditem.ondeserializeinto.md

@@ -0,0 +1,31 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) &gt; [onDeserializeInto](./api-extractor-model.apideclareditem.ondeserializeinto.md)
+
+## ApiDeclaredItem.onDeserializeInto() method
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+static onDeserializeInto(options: Partial<IApiDeclaredItemOptions>, context: DeserializerContext, jsonObject: IApiDeclaredItemJson): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | <code>Partial&lt;IApiDeclaredItemOptions&gt;</code> |  |
+|  context | <code>DeserializerContext</code> |  |
+|  jsonObject | <code>IApiDeclaredItemJson</code> |  |
+
+<b>Returns:</b>
+
+`void`
+

pages/api/api-extractor-model.apideclareditem.serializeinto.md

@@ -0,0 +1,29 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) &gt; [serializeInto](./api-extractor-model.apideclareditem.serializeinto.md)
+
+## ApiDeclaredItem.serializeInto() method
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+serializeInto(jsonObject: Partial<IApiDeclaredItemJson>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  jsonObject | <code>Partial&lt;IApiDeclaredItemJson&gt;</code> |  |
+
+<b>Returns:</b>
+
+`void`
+

pages/api/api-extractor-model.apidocumenteditem._constructor_.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiDocumentedItem](./api-extractor-model.apidocumenteditem.md) &gt; [(constructor)](./api-extractor-model.apidocumenteditem._constructor_.md)
+
+## ApiDocumentedItem.(constructor)
+
+Constructs a new instance of the `ApiDocumentedItem` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: IApiDocumentedItemOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | <code>IApiDocumentedItemOptions</code> |  |
+

pages/api/api-extractor-model.apidocumenteditem.md

@@ -0,0 +1,42 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiDocumentedItem](./api-extractor-model.apidocumenteditem.md)
+
+## ApiDocumentedItem class
+
+An abstract base class for API declarations that can have an associated TSDoc comment.
+
+<b>Signature:</b>
+
+```typescript
+export declare class ApiDocumentedItem extends ApiItem 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./api-extractor-model.apidocumenteditem._constructor_.md) |  | Constructs a new instance of the <code>ApiDocumentedItem</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [tsdocComment](./api-extractor-model.apidocumenteditem.tsdoccomment.md) |  | <code>tsdoc.DocComment &#124; undefined</code> |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [onDeserializeInto(options, context, jsonObject)](./api-extractor-model.apidocumenteditem.ondeserializeinto.md) | <code>static</code> |  |
+|  [serializeInto(jsonObject)](./api-extractor-model.apidocumenteditem.serializeinto.md) |  |  |
+
+## Remarks
+
+This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations.
+

pages/api/api-extractor-model.apidocumenteditem.ondeserializeinto.md

@@ -0,0 +1,31 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiDocumentedItem](./api-extractor-model.apidocumenteditem.md) &gt; [onDeserializeInto](./api-extractor-model.apidocumenteditem.ondeserializeinto.md)
+
+## ApiDocumentedItem.onDeserializeInto() method
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+static onDeserializeInto(options: Partial<IApiDocumentedItemOptions>, context: DeserializerContext, jsonObject: IApiItemJson): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | <code>Partial&lt;IApiDocumentedItemOptions&gt;</code> |  |
+|  context | <code>DeserializerContext</code> |  |
+|  jsonObject | <code>IApiItemJson</code> |  |
+
+<b>Returns:</b>
+
+`void`
+

pages/api/api-extractor-model.apidocumenteditem.serializeinto.md

@@ -0,0 +1,29 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiDocumentedItem](./api-extractor-model.apidocumenteditem.md) &gt; [serializeInto](./api-extractor-model.apidocumenteditem.serializeinto.md)
+
+## ApiDocumentedItem.serializeInto() method
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+serializeInto(jsonObject: Partial<IApiDocumentedItemJson>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  jsonObject | <code>Partial&lt;IApiDocumentedItemJson&gt;</code> |  |
+
+<b>Returns:</b>
+
+`void`
+

pages/api/api-extractor-model.apidocumenteditem.tsdoccomment.md

@@ -0,0 +1,16 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiDocumentedItem](./api-extractor-model.apidocumenteditem.md) &gt; [tsdocComment](./api-extractor-model.apidocumenteditem.tsdoccomment.md)
+
+## ApiDocumentedItem.tsdocComment property
+
+<b>Signature:</b>
+
+```typescript
+readonly tsdocComment: tsdoc.DocComment | undefined;
+```

pages/api/api-extractor-model.apientrypoint._constructor_.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEntryPoint](./api-extractor-model.apientrypoint.md) &gt; [(constructor)](./api-extractor-model.apientrypoint._constructor_.md)
+
+## ApiEntryPoint.(constructor)
+
+Constructs a new instance of the `ApiEntryPoint` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: IApiEntryPointOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | <code>IApiEntryPointOptions</code> |  |
+

pages/api/api-extractor-model.apientrypoint.buildcanonicalreference.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEntryPoint](./api-extractor-model.apientrypoint.md) &gt; [buildCanonicalReference](./api-extractor-model.apientrypoint.buildcanonicalreference.md)
+
+## ApiEntryPoint.buildCanonicalReference() method
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+buildCanonicalReference(): DeclarationReference;
+```
+<b>Returns:</b>
+
+`DeclarationReference`
+

pages/api/api-extractor-model.apientrypoint.containerkey.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEntryPoint](./api-extractor-model.apientrypoint.md) &gt; [containerKey](./api-extractor-model.apientrypoint.containerkey.md)
+
+## ApiEntryPoint.containerKey property
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+readonly containerKey: string;
+```

pages/api/api-extractor-model.apientrypoint.importpath.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEntryPoint](./api-extractor-model.apientrypoint.md) &gt; [importPath](./api-extractor-model.apientrypoint.importpath.md)
+
+## ApiEntryPoint.importPath property
+
+The module path for this entry point, relative to the parent `ApiPackage`<!-- -->. In the current implementation, this is always the empty string, indicating the default entry point.
+
+<b>Signature:</b>
+
+```typescript
+readonly importPath: string;
+```
+
+## Remarks
+
+API Extractor does not currently support analysis of multiple entry points. If that feature is implemented in the future, then the `ApiEntryPoint.importPath` will be used to distinguish different entry points, for example: `controls/Button` in `import { Button } from "example-package/controls/Button";`<!-- -->.
+
+The `ApiEntryPoint.name` property stores the same value as `ApiEntryPoint.importPath`<!-- -->.
+

pages/api/api-extractor-model.apientrypoint.kind.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEntryPoint](./api-extractor-model.apientrypoint.md) &gt; [kind](./api-extractor-model.apientrypoint.kind.md)
+
+## ApiEntryPoint.kind property
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+readonly kind: ApiItemKind;
+```

pages/api/api-extractor-model.apientrypoint.md

@@ -0,0 +1,58 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEntryPoint](./api-extractor-model.apientrypoint.md)
+
+## ApiEntryPoint class
+
+Represents the entry point for an NPM package.
+
+<b>Signature:</b>
+
+```typescript
+export declare class ApiEntryPoint extends ApiEntryPoint_base 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./api-extractor-model.apientrypoint._constructor_.md) |  | Constructs a new instance of the <code>ApiEntryPoint</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [containerKey](./api-extractor-model.apientrypoint.containerkey.md) |  | <code>string</code> |  |
+|  [importPath](./api-extractor-model.apientrypoint.importpath.md) |  | <code>string</code> | The module path for this entry point, relative to the parent <code>ApiPackage</code>. In the current implementation, this is always the empty string, indicating the default entry point. |
+|  [kind](./api-extractor-model.apientrypoint.kind.md) |  | <code>ApiItemKind</code> |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [buildCanonicalReference()](./api-extractor-model.apientrypoint.buildcanonicalreference.md) |  | <b><i>(BETA)</i></b> |
+
+## Remarks
+
+This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations.
+
+`ApiEntryPoint` represents the entry point to an NPM package. API Extractor does not currently support analysis of multiple entry points, but the `ApiEntryPoint` object is included to support a future feature. In the current implementation, `ApiEntryPoint.importPath` is always the empty string.
+
+For example, suppose the package.json file looks like this:
+
+```json
+{
+  "name": "example-library",
+  "version": "1.0.0",
+  "main": "./lib/index.js",
+  "typings": "./lib/index.d.ts"
+}
+
+```
+In this example, the `ApiEntryPoint` would represent the TypeScript module for `./lib/index.js`<!-- -->.
+

pages/api/api-extractor-model.apienum._constructor_.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEnum](./api-extractor-model.apienum.md) &gt; [(constructor)](./api-extractor-model.apienum._constructor_.md)
+
+## ApiEnum.(constructor)
+
+Constructs a new instance of the `ApiEnum` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: IApiEnumOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | <code>IApiEnumOptions</code> |  |
+

pages/api/api-extractor-model.apienum.addmember.md

@@ -0,0 +1,29 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEnum](./api-extractor-model.apienum.md) &gt; [addMember](./api-extractor-model.apienum.addmember.md)
+
+## ApiEnum.addMember() method
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+addMember(member: ApiEnumMember): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  member | <code>ApiEnumMember</code> |  |
+
+<b>Returns:</b>
+
+`void`
+

pages/api/api-extractor-model.apienum.buildcanonicalreference.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEnum](./api-extractor-model.apienum.md) &gt; [buildCanonicalReference](./api-extractor-model.apienum.buildcanonicalreference.md)
+
+## ApiEnum.buildCanonicalReference() method
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+buildCanonicalReference(): DeclarationReference;
+```
+<b>Returns:</b>
+
+`DeclarationReference`
+

pages/api/api-extractor-model.apienum.containerkey.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEnum](./api-extractor-model.apienum.md) &gt; [containerKey](./api-extractor-model.apienum.containerkey.md)
+
+## ApiEnum.containerKey property
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+readonly containerKey: string;
+```

pages/api/api-extractor-model.apienum.getcontainerkey.md

@@ -0,0 +1,27 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEnum](./api-extractor-model.apienum.md) &gt; [getContainerKey](./api-extractor-model.apienum.getcontainerkey.md)
+
+## ApiEnum.getContainerKey() method
+
+<b>Signature:</b>
+
+```typescript
+static getContainerKey(name: string): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  name | <code>string</code> |  |
+
+<b>Returns:</b>
+
+`string`
+

pages/api/api-extractor-model.apienum.kind.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEnum](./api-extractor-model.apienum.md) &gt; [kind](./api-extractor-model.apienum.kind.md)
+
+## ApiEnum.kind property
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+readonly kind: ApiItemKind;
+```

pages/api/api-extractor-model.apienum.md

@@ -0,0 +1,56 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEnum](./api-extractor-model.apienum.md)
+
+## ApiEnum class
+
+Represents a TypeScript enum declaration.
+
+<b>Signature:</b>
+
+```typescript
+export declare class ApiEnum extends ApiEnum_base 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./api-extractor-model.apienum._constructor_.md) |  | Constructs a new instance of the <code>ApiEnum</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [containerKey](./api-extractor-model.apienum.containerkey.md) |  | <code>string</code> |  |
+|  [kind](./api-extractor-model.apienum.kind.md) |  | <code>ApiItemKind</code> |  |
+|  [members](./api-extractor-model.apienum.members.md) |  | <code>ReadonlyArray&lt;ApiEnumMember&gt;</code> |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [addMember(member)](./api-extractor-model.apienum.addmember.md) |  |  |
+|  [buildCanonicalReference()](./api-extractor-model.apienum.buildcanonicalreference.md) |  | <b><i>(BETA)</i></b> |
+|  [getContainerKey(name)](./api-extractor-model.apienum.getcontainerkey.md) | <code>static</code> |  |
+
+## Remarks
+
+This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations.
+
+`ApiEnum` represents an enum declaration such as `FontSizes` in the example below:
+
+```ts
+export enum FontSizes {
+  Small = 100,
+  Medium = 200,
+  Large = 300
+}
+
+```
+

pages/api/api-extractor-model.apienum.members.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEnum](./api-extractor-model.apienum.md) &gt; [members](./api-extractor-model.apienum.members.md)
+
+## ApiEnum.members property
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+readonly members: ReadonlyArray<ApiEnumMember>;
+```

pages/api/api-extractor-model.apienummember._constructor_.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEnumMember](./api-extractor-model.apienummember.md) &gt; [(constructor)](./api-extractor-model.apienummember._constructor_.md)
+
+## ApiEnumMember.(constructor)
+
+Constructs a new instance of the `ApiEnumMember` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: IApiEnumMemberOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | <code>IApiEnumMemberOptions</code> |  |
+

pages/api/api-extractor-model.apienummember.buildcanonicalreference.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEnumMember](./api-extractor-model.apienummember.md) &gt; [buildCanonicalReference](./api-extractor-model.apienummember.buildcanonicalreference.md)
+
+## ApiEnumMember.buildCanonicalReference() method
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+buildCanonicalReference(): DeclarationReference;
+```
+<b>Returns:</b>
+
+`DeclarationReference`
+

pages/api/api-extractor-model.apienummember.containerkey.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEnumMember](./api-extractor-model.apienummember.md) &gt; [containerKey](./api-extractor-model.apienummember.containerkey.md)
+
+## ApiEnumMember.containerKey property
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+readonly containerKey: string;
+```

pages/api/api-extractor-model.apienummember.getcontainerkey.md

@@ -0,0 +1,27 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEnumMember](./api-extractor-model.apienummember.md) &gt; [getContainerKey](./api-extractor-model.apienummember.getcontainerkey.md)
+
+## ApiEnumMember.getContainerKey() method
+
+<b>Signature:</b>
+
+```typescript
+static getContainerKey(name: string): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  name | <code>string</code> |  |
+
+<b>Returns:</b>
+
+`string`
+

pages/api/api-extractor-model.apienummember.initializerexcerpt.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEnumMember](./api-extractor-model.apienummember.md) &gt; [initializerExcerpt](./api-extractor-model.apienummember.initializerexcerpt.md)
+
+## ApiEnumMember.initializerExcerpt property
+
+An [Excerpt](./api-extractor-model.excerpt.md) that describes the value of the enum member.
+
+<b>Signature:</b>
+
+```typescript
+readonly initializerExcerpt: Excerpt;
+```

pages/api/api-extractor-model.apienummember.kind.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEnumMember](./api-extractor-model.apienummember.md) &gt; [kind](./api-extractor-model.apienummember.kind.md)
+
+## ApiEnumMember.kind property
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+readonly kind: ApiItemKind;
+```

pages/api/api-extractor-model.apienummember.md

@@ -0,0 +1,57 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEnumMember](./api-extractor-model.apienummember.md)
+
+## ApiEnumMember class
+
+Represents a member of a TypeScript enum declaration.
+
+<b>Signature:</b>
+
+```typescript
+export declare class ApiEnumMember extends ApiEnumMember_base 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./api-extractor-model.apienummember._constructor_.md) |  | Constructs a new instance of the <code>ApiEnumMember</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [containerKey](./api-extractor-model.apienummember.containerkey.md) |  | <code>string</code> |  |
+|  [initializerExcerpt](./api-extractor-model.apienummember.initializerexcerpt.md) |  | <code>Excerpt</code> | An [Excerpt](./api-extractor-model.excerpt.md) that describes the value of the enum member. |
+|  [kind](./api-extractor-model.apienummember.kind.md) |  | <code>ApiItemKind</code> |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [buildCanonicalReference()](./api-extractor-model.apienummember.buildcanonicalreference.md) |  | <b><i>(BETA)</i></b> |
+|  [getContainerKey(name)](./api-extractor-model.apienummember.getcontainerkey.md) | <code>static</code> |  |
+|  [onDeserializeInto(options, context, jsonObject)](./api-extractor-model.apienummember.ondeserializeinto.md) | <code>static</code> |  |
+|  [serializeInto(jsonObject)](./api-extractor-model.apienummember.serializeinto.md) |  |  |
+
+## Remarks
+
+This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations.
+
+`ApiEnumMember` represents an enum member such as `Small = 100` in the example below:
+
+```ts
+export enum FontSizes {
+  Small = 100,
+  Medium = 200,
+  Large = 300
+}
+
+```
+

pages/api/api-extractor-model.apienummember.ondeserializeinto.md

@@ -0,0 +1,31 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEnumMember](./api-extractor-model.apienummember.md) &gt; [onDeserializeInto](./api-extractor-model.apienummember.ondeserializeinto.md)
+
+## ApiEnumMember.onDeserializeInto() method
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+static onDeserializeInto(options: Partial<IApiEnumMemberOptions>, context: DeserializerContext, jsonObject: IApiEnumMemberJson): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | <code>Partial&lt;IApiEnumMemberOptions&gt;</code> |  |
+|  context | <code>DeserializerContext</code> |  |
+|  jsonObject | <code>IApiEnumMemberJson</code> |  |
+
+<b>Returns:</b>
+
+`void`
+

pages/api/api-extractor-model.apienummember.serializeinto.md

@@ -0,0 +1,29 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiEnumMember](./api-extractor-model.apienummember.md) &gt; [serializeInto](./api-extractor-model.apienummember.serializeinto.md)
+
+## ApiEnumMember.serializeInto() method
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+serializeInto(jsonObject: Partial<IApiEnumMemberJson>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  jsonObject | <code>Partial&lt;IApiEnumMemberJson&gt;</code> |  |
+
+<b>Returns:</b>
+
+`void`
+

pages/api/api-extractor-model.apifunction._constructor_.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiFunction](./api-extractor-model.apifunction.md) &gt; [(constructor)](./api-extractor-model.apifunction._constructor_.md)
+
+## ApiFunction.(constructor)
+
+Constructs a new instance of the `ApiFunction` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: IApiFunctionOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | <code>IApiFunctionOptions</code> |  |
+

pages/api/api-extractor-model.apifunction.buildcanonicalreference.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiFunction](./api-extractor-model.apifunction.md) &gt; [buildCanonicalReference](./api-extractor-model.apifunction.buildcanonicalreference.md)
+
+## ApiFunction.buildCanonicalReference() method
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+buildCanonicalReference(): DeclarationReference;
+```
+<b>Returns:</b>
+
+`DeclarationReference`
+

pages/api/api-extractor-model.apifunction.containerkey.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiFunction](./api-extractor-model.apifunction.md) &gt; [containerKey](./api-extractor-model.apifunction.containerkey.md)
+
+## ApiFunction.containerKey property
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+readonly containerKey: string;
+```

pages/api/api-extractor-model.apifunction.getcontainerkey.md

@@ -0,0 +1,28 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiFunction](./api-extractor-model.apifunction.md) &gt; [getContainerKey](./api-extractor-model.apifunction.getcontainerkey.md)
+
+## ApiFunction.getContainerKey() method
+
+<b>Signature:</b>
+
+```typescript
+static getContainerKey(name: string, overloadIndex: number): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  name | <code>string</code> |  |
+|  overloadIndex | <code>number</code> |  |
+
+<b>Returns:</b>
+
+`string`
+

pages/api/api-extractor-model.apifunction.kind.md

@@ -0,0 +1,18 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiFunction](./api-extractor-model.apifunction.md) &gt; [kind](./api-extractor-model.apifunction.kind.md)
+
+## ApiFunction.kind property
+
+
+<b>Signature:</b>
+
+```typescript
+/** @override */
+readonly kind: ApiItemKind;
+```

pages/api/api-extractor-model.apifunction.md

@@ -0,0 +1,53 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiFunction](./api-extractor-model.apifunction.md)
+
+## ApiFunction class
+
+Represents a TypeScript function declaration.
+
+<b>Signature:</b>
+
+```typescript
+export declare class ApiFunction extends ApiFunction_base 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./api-extractor-model.apifunction._constructor_.md) |  | Constructs a new instance of the <code>ApiFunction</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [containerKey](./api-extractor-model.apifunction.containerkey.md) |  | <code>string</code> |  |
+|  [kind](./api-extractor-model.apifunction.kind.md) |  | <code>ApiItemKind</code> |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [buildCanonicalReference()](./api-extractor-model.apifunction.buildcanonicalreference.md) |  | <b><i>(BETA)</i></b> |
+|  [getContainerKey(name, overloadIndex)](./api-extractor-model.apifunction.getcontainerkey.md) | <code>static</code> |  |
+
+## Remarks
+
+This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations.
+
+`ApiFunction` represents a TypeScript declaration such as this example:
+
+```ts
+export function getAverage(x: number, y: number): number {
+  return (x + y) / 2.0;
+}
+
+```
+Functions are exported by an entry point module or by a namespace. Compare with [ApiMethod](./api-extractor-model.apimethod.md)<!-- -->, which represents a function that is a member of a class.
+

pages/api/api-extractor-model.apiindexsignature._constructor_.md

@@ -0,0 +1,25 @@
+---
+layout: page
+navigation_source: api_nav
+improve_this_button: false
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/api-extractor-model](./api-extractor-model.md) &gt; [ApiIndexSignature](./api-extractor-model.apiindexsignature.md) &gt; [(constructor)](./api-extractor-model.apiindexsignature._constructor_.md)
+
+## ApiIndexSignature.(constructor)
+
+Constructs a new instance of the `ApiIndexSignature` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: IApiIndexSignatureOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | <code>IApiIndexSignatureOptions</code> |  |
+