This commit is contained in:
Pete Gonzalez 2020-05-06 01:07:48 -07:00
Родитель c73f9e4b39
Коммит c3bc016581
480 изменённых файлов: 972 добавлений и 972 удалений

Просмотреть файл

@ -47,6 +47,6 @@ export const apiDocumenterPluginManifest: IApiDocumenterPluginManifest = {
| Property | Type | Description |
| --- | --- | --- |
| [features](./api-documenter.iapidocumenterpluginmanifest.features.md) | [IFeatureDefinition](./api-documenter.ifeaturedefinition.md)<code>[]</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>. |
| [features](./api-documenter.iapidocumenterpluginmanifest.features.md) | [IFeatureDefinition](./api-documenter.ifeaturedefinition.md)<!-- -->\[\] | The list of features provided by this plugin. |
| [manifestVersion](./api-documenter.iapidocumenterpluginmanifest.manifestversion.md) | 1000 | The manifest version number. For now, this must always be <code>1000</code>. |

Просмотреть файл

@ -21,7 +21,7 @@ export interface IFeatureDefinition
| 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: </code>[PluginFeatureInitialization](./api-documenter.pluginfeatureinitialization.md)<code>): </code>[MarkdownDocumenterFeature](./api-documenter.markdowndocumenterfeature.md)<code>;</code><br/><code> }</code> | Your subclass that extends from the base class. |
| [featureName](./api-documenter.ifeaturedefinition.featurename.md) | string | 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) | 'MarkdownDocumenterFeature' | 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) | { new (initialization: [PluginFeatureInitialization](./api-documenter.pluginfeatureinitialization.md)<!-- -->): [MarkdownDocumenterFeature](./api-documenter.markdowndocumenterfeature.md)<!-- -->; } | Your subclass that extends from the base class. |

Просмотреть файл

@ -22,6 +22,6 @@ export interface IMarkdownDocumenterFeatureOnBeforeWritePageArgs
| Property | Type | Description |
| --- | --- | --- |
| [apiItem](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.apiitem.md) | [ApiItem](./api-extractor-model.apiitem.md) | 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 [MarkdownDocumenterFeature.onBeforeWritePage()](./api-documenter.markdowndocumenterfeature.onbeforewritepage.md) handler can reassign this string to customize the page appearance. |
| [outputFilename](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.outputfilename.md) | string | The filename where the output will be written. |
| [pageContent](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.pagecontent.md) | string | The page content. The [MarkdownDocumenterFeature.onBeforeWritePage()](./api-documenter.markdowndocumenterfeature.onbeforewritepage.md) handler can reassign this string to customize the page appearance. |

Просмотреть файл

@ -25,7 +25,7 @@ getLinkForApiItem(apiItem: ApiItem): string | undefined;
<b>Returns:</b>
`string | undefined`
string \| undefined
The hyperlink, or `undefined` if the `ApiItem` object does not have a hyperlink.

Просмотреть файл

@ -26,5 +26,5 @@ onBeforeWritePage(eventArgs: IMarkdownDocumenterFeatureOnBeforeWritePageArgs): v
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -26,5 +26,5 @@ onFinished(eventArgs: IMarkdownDocumenterFeatureOnFinishedArgs): void;
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -27,5 +27,5 @@ The constructor for this class is marked as internal. Third-party code should no
| --- | --- | --- | --- |
| [apiModel](./api-documenter.markdowndocumenterfeaturecontext.apimodel.md) | | [ApiModel](./api-extractor-model.apimodel.md) | Provides access to the <code>ApiModel</code> for the documentation being generated. |
| [documenter](./api-documenter.markdowndocumenterfeaturecontext.documenter.md) | | [MarkdownDocumenterAccessor](./api-documenter.markdowndocumenteraccessor.md) | Exposes functionality of the documenter. |
| [outputFolder](./api-documenter.markdowndocumenterfeaturecontext.outputfolder.md) | | <code>string</code> | The full path to the output folder. |
| [outputFolder](./api-documenter.markdowndocumenterfeaturecontext.outputfolder.md) | | string | The full path to the output folder. |

Просмотреть файл

@ -19,5 +19,5 @@ onInitialized(): void;
```
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -21,5 +21,5 @@ buildCanonicalReference(): DeclarationReference;
```
<b>Returns:</b>
`DeclarationReference`
DeclarationReference

Просмотреть файл

@ -19,9 +19,9 @@ static getContainerKey(overloadIndex: number): string;
| Parameter | Type | Description |
| --- | --- | --- |
| overloadIndex | <code>number</code> | |
| overloadIndex | number | |
<b>Returns:</b>
`string`
string

Просмотреть файл

@ -50,7 +50,7 @@ let chooser: IChooser = chooseFirst;
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [containerKey](./api-extractor-model.apicallsignature.containerkey.md) | | <code>string</code> | |
| [containerKey](./api-extractor-model.apicallsignature.containerkey.md) | | string | |
| [kind](./api-extractor-model.apicallsignature.kind.md) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | |
## Methods

Просмотреть файл

@ -21,5 +21,5 @@ buildCanonicalReference(): DeclarationReference;
```
<b>Returns:</b>
`DeclarationReference`
DeclarationReference

Просмотреть файл

@ -19,9 +19,9 @@ static getContainerKey(name: string): string;
| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |
| name | string | |
<b>Returns:</b>
`string`
string

Просмотреть файл

@ -38,9 +38,9 @@ export class X { }
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [containerKey](./api-extractor-model.apiclass.containerkey.md) | | <code>string</code> | |
| [extendsType](./api-extractor-model.apiclass.extendstype.md) | | [HeritageType](./api-extractor-model.heritagetype.md)<code> &#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</code><code>&lt;</code>[HeritageType](./api-extractor-model.heritagetype.md)<code>&gt;</code> | The list of interfaces that this class implements using the <code>implements</code> keyword. |
| [containerKey](./api-extractor-model.apiclass.containerkey.md) | | string | |
| [extendsType](./api-extractor-model.apiclass.extendstype.md) | | [HeritageType](./api-extractor-model.heritagetype.md) \| undefined | 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) | | ReadonlyArray&lt;[HeritageType](./api-extractor-model.heritagetype.md)<!-- -->&gt; | The list of interfaces that this class implements using the <code>implements</code> keyword. |
| [kind](./api-extractor-model.apiclass.kind.md) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | |
## Methods

Просмотреть файл

@ -21,11 +21,11 @@ static onDeserializeInto(options: Partial<IApiClassOptions>, context: Deserializ
| Parameter | Type | Description |
| --- | --- | --- |
| options | <code>Partial</code><code>&lt;</code>[IApiClassOptions](./api-extractor-model.iapiclassoptions.md)<code>&gt;</code> | |
| context | <code>DeserializerContext</code> | |
| jsonObject | <code>IApiClassJson</code> | |
| options | Partial&lt;[IApiClassOptions](./api-extractor-model.iapiclassoptions.md)<!-- -->&gt; | |
| context | DeserializerContext | |
| jsonObject | IApiClassJson | |
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -21,9 +21,9 @@ serializeInto(jsonObject: Partial<IApiClassJson>): void;
| Parameter | Type | Description |
| --- | --- | --- |
| jsonObject | <code>Partial</code><code>&lt;</code><code>IApiClassJson</code><code>&gt;</code> | |
| jsonObject | Partial&lt;IApiClassJson&gt; | |
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -21,5 +21,5 @@ buildCanonicalReference(): DeclarationReference;
```
<b>Returns:</b>
`DeclarationReference`
DeclarationReference

Просмотреть файл

@ -19,9 +19,9 @@ static getContainerKey(overloadIndex: number): string;
| Parameter | Type | Description |
| --- | --- | --- |
| overloadIndex | <code>number</code> | |
| overloadIndex | number | |
<b>Returns:</b>
`string`
string

Просмотреть файл

@ -48,7 +48,7 @@ Compare with [ApiConstructSignature](./api-extractor-model.apiconstructsignature
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [containerKey](./api-extractor-model.apiconstructor.containerkey.md) | | <code>string</code> | |
| [containerKey](./api-extractor-model.apiconstructor.containerkey.md) | | string | |
| [kind](./api-extractor-model.apiconstructor.kind.md) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | |
## Methods

Просмотреть файл

@ -21,5 +21,5 @@ buildCanonicalReference(): DeclarationReference;
```
<b>Returns:</b>
`DeclarationReference`
DeclarationReference

Просмотреть файл

@ -19,9 +19,9 @@ static getContainerKey(overloadIndex: number): string;
| Parameter | Type | Description |
| --- | --- | --- |
| overloadIndex | <code>number</code> | |
| overloadIndex | number | |
<b>Returns:</b>
`string`
string

Просмотреть файл

@ -63,7 +63,7 @@ Compare with [ApiConstructor](./api-extractor-model.apiconstructor.md)<!-- -->,
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [containerKey](./api-extractor-model.apiconstructsignature.containerkey.md) | | <code>string</code> | |
| [containerKey](./api-extractor-model.apiconstructsignature.containerkey.md) | | string | |
| [kind](./api-extractor-model.apiconstructsignature.kind.md) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | |
## Methods

Просмотреть файл

@ -18,5 +18,5 @@ getExcerptWithModifiers(): string;
```
<b>Returns:</b>
`string`
string

Просмотреть файл

@ -34,7 +34,7 @@ Most `ApiItem` subclasses have declarations and thus extend `ApiDeclaredItem`<!-
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [excerpt](./api-extractor-model.apideclareditem.excerpt.md) | | [Excerpt](./api-extractor-model.excerpt.md) | The source code excerpt where the API item is declared. |
| [excerptTokens](./api-extractor-model.apideclareditem.excerpttokens.md) | | <code>ReadonlyArray</code><code>&lt;</code>[ExcerptToken](./api-extractor-model.excerpttoken.md)<code>&gt;</code> | The individual source code tokens that comprise the main excerpt. |
| [excerptTokens](./api-extractor-model.apideclareditem.excerpttokens.md) | | ReadonlyArray&lt;[ExcerptToken](./api-extractor-model.excerpttoken.md)<!-- -->&gt; | The individual source code tokens that comprise the main excerpt. |
## Methods

Просмотреть файл

@ -21,11 +21,11 @@ static onDeserializeInto(options: Partial<IApiDeclaredItemOptions>, context: Des
| Parameter | Type | Description |
| --- | --- | --- |
| options | <code>Partial</code><code>&lt;</code>[IApiDeclaredItemOptions](./api-extractor-model.iapideclareditemoptions.md)<code>&gt;</code> | |
| context | <code>DeserializerContext</code> | |
| jsonObject | <code>IApiDeclaredItemJson</code> | |
| options | Partial&lt;[IApiDeclaredItemOptions](./api-extractor-model.iapideclareditemoptions.md)<!-- -->&gt; | |
| context | DeserializerContext | |
| jsonObject | IApiDeclaredItemJson | |
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -21,9 +21,9 @@ serializeInto(jsonObject: Partial<IApiDeclaredItemJson>): void;
| Parameter | Type | Description |
| --- | --- | --- |
| jsonObject | <code>Partial</code><code>&lt;</code><code>IApiDeclaredItemJson</code><code>&gt;</code> | |
| jsonObject | Partial&lt;IApiDeclaredItemJson&gt; | |
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -31,7 +31,7 @@ This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of c
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [tsdocComment](./api-extractor-model.apidocumenteditem.tsdoccomment.md) | | <code>tsdoc.</code><code>DocComment</code><code> &#124; undefined</code> | |
| [tsdocComment](./api-extractor-model.apidocumenteditem.tsdoccomment.md) | | tsdoc.DocComment \| undefined | |
## Methods

Просмотреть файл

@ -21,11 +21,11 @@ static onDeserializeInto(options: Partial<IApiDocumentedItemOptions>, context: D
| Parameter | Type | Description |
| --- | --- | --- |
| options | <code>Partial</code><code>&lt;</code>[IApiDocumentedItemOptions](./api-extractor-model.iapidocumenteditemoptions.md)<code>&gt;</code> | |
| context | <code>DeserializerContext</code> | |
| jsonObject | <code>IApiItemJson</code> | |
| options | Partial&lt;[IApiDocumentedItemOptions](./api-extractor-model.iapidocumenteditemoptions.md)<!-- -->&gt; | |
| context | DeserializerContext | |
| jsonObject | IApiItemJson | |
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -21,9 +21,9 @@ serializeInto(jsonObject: Partial<IApiDocumentedItemJson>): void;
| Parameter | Type | Description |
| --- | --- | --- |
| jsonObject | <code>Partial</code><code>&lt;</code><code>IApiDocumentedItemJson</code><code>&gt;</code> | |
| jsonObject | Partial&lt;IApiDocumentedItemJson&gt; | |
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -21,5 +21,5 @@ buildCanonicalReference(): DeclarationReference;
```
<b>Returns:</b>
`DeclarationReference`
DeclarationReference

Просмотреть файл

@ -46,8 +46,8 @@ In this example, the `ApiEntryPoint` would represent the TypeScript module for `
| 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. |
| [containerKey](./api-extractor-model.apientrypoint.containerkey.md) | | string | |
| [importPath](./api-extractor-model.apientrypoint.importpath.md) | | string | 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) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | |
## Methods

Просмотреть файл

@ -25,5 +25,5 @@ addMember(member: ApiEnumMember): void;
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -21,5 +21,5 @@ buildCanonicalReference(): DeclarationReference;
```
<b>Returns:</b>
`DeclarationReference`
DeclarationReference

Просмотреть файл

@ -19,9 +19,9 @@ static getContainerKey(name: string): string;
| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |
| name | string | |
<b>Returns:</b>
`string`
string

Просмотреть файл

@ -42,9 +42,9 @@ export enum FontSizes {
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [containerKey](./api-extractor-model.apienum.containerkey.md) | | <code>string</code> | |
| [containerKey](./api-extractor-model.apienum.containerkey.md) | | string | |
| [kind](./api-extractor-model.apienum.kind.md) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | |
| [members](./api-extractor-model.apienum.members.md) | | <code>ReadonlyArray</code><code>&lt;</code>[ApiEnumMember](./api-extractor-model.apienummember.md)<code>&gt;</code> | |
| [members](./api-extractor-model.apienum.members.md) | | ReadonlyArray&lt;[ApiEnumMember](./api-extractor-model.apienummember.md)<!-- -->&gt; | |
## Methods

Просмотреть файл

@ -21,5 +21,5 @@ buildCanonicalReference(): DeclarationReference;
```
<b>Returns:</b>
`DeclarationReference`
DeclarationReference

Просмотреть файл

@ -19,9 +19,9 @@ static getContainerKey(name: string): string;
| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |
| name | string | |
<b>Returns:</b>
`string`
string

Просмотреть файл

@ -42,7 +42,7 @@ export enum FontSizes {
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [containerKey](./api-extractor-model.apienummember.containerkey.md) | | <code>string</code> | |
| [containerKey](./api-extractor-model.apienummember.containerkey.md) | | string | |
| [initializerExcerpt](./api-extractor-model.apienummember.initializerexcerpt.md) | | [Excerpt](./api-extractor-model.excerpt.md) | An [Excerpt](./api-extractor-model.excerpt.md) that describes the value of the enum member. |
| [kind](./api-extractor-model.apienummember.kind.md) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | |

Просмотреть файл

@ -21,11 +21,11 @@ static onDeserializeInto(options: Partial<IApiEnumMemberOptions>, context: Deser
| Parameter | Type | Description |
| --- | --- | --- |
| options | <code>Partial</code><code>&lt;</code>[IApiEnumMemberOptions](./api-extractor-model.iapienummemberoptions.md)<code>&gt;</code> | |
| context | <code>DeserializerContext</code> | |
| jsonObject | <code>IApiEnumMemberJson</code> | |
| options | Partial&lt;[IApiEnumMemberOptions](./api-extractor-model.iapienummemberoptions.md)<!-- -->&gt; | |
| context | DeserializerContext | |
| jsonObject | IApiEnumMemberJson | |
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -21,9 +21,9 @@ serializeInto(jsonObject: Partial<IApiEnumMemberJson>): void;
| Parameter | Type | Description |
| --- | --- | --- |
| jsonObject | <code>Partial</code><code>&lt;</code><code>IApiEnumMemberJson</code><code>&gt;</code> | |
| jsonObject | Partial&lt;IApiEnumMemberJson&gt; | |
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -21,5 +21,5 @@ buildCanonicalReference(): DeclarationReference;
```
<b>Returns:</b>
`DeclarationReference`
DeclarationReference

Просмотреть файл

@ -19,10 +19,10 @@ static getContainerKey(name: string, overloadIndex: number): string;
| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |
| overloadIndex | <code>number</code> | |
| name | string | |
| overloadIndex | number | |
<b>Returns:</b>
`string`
string

Просмотреть файл

@ -41,7 +41,7 @@ Functions are exported by an entry point module or by a namespace. Compare with
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [containerKey](./api-extractor-model.apifunction.containerkey.md) | | <code>string</code> | |
| [containerKey](./api-extractor-model.apifunction.containerkey.md) | | string | |
| [kind](./api-extractor-model.apifunction.kind.md) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | |
## Methods

Просмотреть файл

@ -21,5 +21,5 @@ buildCanonicalReference(): DeclarationReference;
```
<b>Returns:</b>
`DeclarationReference`
DeclarationReference

Просмотреть файл

@ -19,9 +19,9 @@ static getContainerKey(overloadIndex: number): string;
| Parameter | Type | Description |
| --- | --- | --- |
| overloadIndex | <code>number</code> | |
| overloadIndex | number | |
<b>Returns:</b>
`string`
string

Просмотреть файл

@ -44,7 +44,7 @@ export interface INumberTable {
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [containerKey](./api-extractor-model.apiindexsignature.containerkey.md) | | <code>string</code> | |
| [containerKey](./api-extractor-model.apiindexsignature.containerkey.md) | | string | |
| [kind](./api-extractor-model.apiindexsignature.kind.md) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | |
## Methods

Просмотреть файл

@ -21,5 +21,5 @@ buildCanonicalReference(): DeclarationReference;
```
<b>Returns:</b>
`DeclarationReference`
DeclarationReference

Просмотреть файл

@ -19,9 +19,9 @@ static getContainerKey(name: string): string;
| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |
| name | string | |
<b>Returns:</b>
`string`
string

Просмотреть файл

@ -39,8 +39,8 @@ export interface X extends Y {
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [containerKey](./api-extractor-model.apiinterface.containerkey.md) | | <code>string</code> | |
| [extendsTypes](./api-extractor-model.apiinterface.extendstypes.md) | | <code>ReadonlyArray</code><code>&lt;</code>[HeritageType](./api-extractor-model.heritagetype.md)<code>&gt;</code> | The list of base interfaces that this interface inherits from using the <code>extends</code> keyword. |
| [containerKey](./api-extractor-model.apiinterface.containerkey.md) | | string | |
| [extendsTypes](./api-extractor-model.apiinterface.extendstypes.md) | | ReadonlyArray&lt;[HeritageType](./api-extractor-model.heritagetype.md)<!-- -->&gt; | The list of base interfaces that this interface inherits from using the <code>extends</code> keyword. |
| [kind](./api-extractor-model.apiinterface.kind.md) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | |
## Methods

Просмотреть файл

@ -21,11 +21,11 @@ static onDeserializeInto(options: Partial<IApiInterfaceOptions>, context: Deseri
| Parameter | Type | Description |
| --- | --- | --- |
| options | <code>Partial</code><code>&lt;</code>[IApiInterfaceOptions](./api-extractor-model.iapiinterfaceoptions.md)<code>&gt;</code> | |
| context | <code>DeserializerContext</code> | |
| jsonObject | <code>IApiInterfaceJson</code> | |
| options | Partial&lt;[IApiInterfaceOptions](./api-extractor-model.iapiinterfaceoptions.md)<!-- -->&gt; | |
| context | DeserializerContext | |
| jsonObject | IApiInterfaceJson | |
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -21,9 +21,9 @@ serializeInto(jsonObject: Partial<IApiInterfaceJson>): void;
| Parameter | Type | Description |
| --- | --- | --- |
| jsonObject | <code>Partial</code><code>&lt;</code><code>IApiInterfaceJson</code><code>&gt;</code> | |
| jsonObject | Partial&lt;IApiInterfaceJson&gt; | |
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -19,5 +19,5 @@ protected buildCanonicalReference(): DeclarationReference;
```
<b>Returns:</b>
`DeclarationReference`
DeclarationReference

Просмотреть файл

@ -19,8 +19,8 @@ static deserialize(jsonObject: IApiItemJson, context: DeserializerContext): ApiI
| Parameter | Type | Description |
| --- | --- | --- |
| jsonObject | <code>IApiItemJson</code> | |
| context | <code>DeserializerContext</code> | |
| jsonObject | IApiItemJson | |
| context | DeserializerContext | |
<b>Returns:</b>

Просмотреть файл

@ -18,5 +18,5 @@ getAssociatedPackage(): ApiPackage | undefined;
```
<b>Returns:</b>
[ApiPackage](./api-extractor-model.apipackage.md)` | undefined`
[ApiPackage](./api-extractor-model.apipackage.md) \| undefined

Просмотреть файл

@ -18,5 +18,5 @@ getHierarchy(): ReadonlyArray<ApiItem>;
```
<b>Returns:</b>
`ReadonlyArray``<`[ApiItem](./api-extractor-model.apiitem.md)`>`
ReadonlyArray&lt;[ApiItem](./api-extractor-model.apiitem.md)<!-- -->&gt;

Просмотреть файл

@ -18,7 +18,7 @@ getMergedSiblings(): ReadonlyArray<ApiItem>;
```
<b>Returns:</b>
`ReadonlyArray``<`[ApiItem](./api-extractor-model.apiitem.md)`>`
ReadonlyArray&lt;[ApiItem](./api-extractor-model.apiitem.md)<!-- -->&gt;
## Remarks

Просмотреть файл

@ -18,7 +18,7 @@ getScopedNameWithinPackage(): string;
```
<b>Returns:</b>
`string`
string
## Remarks

Просмотреть файл

@ -18,5 +18,5 @@ getSortKey(): string;
```
<b>Returns:</b>
`string`
string

Просмотреть файл

@ -31,12 +31,12 @@ This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of c
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [canonicalReference](./api-extractor-model.apiitem.canonicalreference.md) | | <code>DeclarationReference</code> | <b><i>(BETA)</i></b> Warning: This API is used internally by API extractor but is not yet ready for general usage. |
| [containerKey](./api-extractor-model.apiitem.containerkey.md) | | <code>string</code> | Returns a string key that can be used to efficiently retrieve an <code>ApiItem</code> from an <code>ApiItemContainerMixin</code>. The key is unique within the container. Its format is undocumented and may change at any time. |
| [displayName](./api-extractor-model.apiitem.displayname.md) | | <code>string</code> | Returns a name for this object that can be used in diagnostic messages, for example. |
| [canonicalReference](./api-extractor-model.apiitem.canonicalreference.md) | | DeclarationReference | <b><i>(BETA)</i></b> Warning: This API is used internally by API extractor but is not yet ready for general usage. |
| [containerKey](./api-extractor-model.apiitem.containerkey.md) | | string | Returns a string key that can be used to efficiently retrieve an <code>ApiItem</code> from an <code>ApiItemContainerMixin</code>. The key is unique within the container. Its format is undocumented and may change at any time. |
| [displayName](./api-extractor-model.apiitem.displayname.md) | | string | Returns a name for this object that can be used in diagnostic messages, for example. |
| [kind](./api-extractor-model.apiitem.kind.md) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | Identifies the subclass of the <code>ApiItem</code> base class. |
| [members](./api-extractor-model.apiitem.members.md) | | <code>ReadonlyArray</code><code>&lt;</code>[ApiItem](./api-extractor-model.apiitem.md)<code>&gt;</code> | This property supports a visitor pattern for walking the tree. For items with ApiItemContainerMixin, it returns the contained items. Otherwise it returns an empty array. |
| [parent](./api-extractor-model.apiitem.parent.md) | | [ApiItem](./api-extractor-model.apiitem.md)<code> &#124; undefined</code> | If this item was added to a ApiItemContainerMixin item, then this returns the container item. If this is an Parameter that was added to a method or function, then this returns the function item. Otherwise, it returns undefined. |
| [members](./api-extractor-model.apiitem.members.md) | | ReadonlyArray&lt;[ApiItem](./api-extractor-model.apiitem.md)<!-- -->&gt; | This property supports a visitor pattern for walking the tree. For items with ApiItemContainerMixin, it returns the contained items. Otherwise it returns an empty array. |
| [parent](./api-extractor-model.apiitem.parent.md) | | [ApiItem](./api-extractor-model.apiitem.md) \| undefined | If this item was added to a ApiItemContainerMixin item, then this returns the container item. If this is an Parameter that was added to a method or function, then this returns the function item. Otherwise, it returns undefined. |
## Methods

Просмотреть файл

@ -21,11 +21,11 @@ static onDeserializeInto(options: Partial<IApiItemOptions>, context: Deserialize
| Parameter | Type | Description |
| --- | --- | --- |
| options | <code>Partial</code><code>&lt;</code>[IApiItemOptions](./api-extractor-model.iapiitemoptions.md)<code>&gt;</code> | |
| context | <code>DeserializerContext</code> | |
| jsonObject | <code>IApiItemJson</code> | |
| options | Partial&lt;[IApiItemOptions](./api-extractor-model.iapiitemoptions.md)<!-- -->&gt; | |
| context | DeserializerContext | |
| jsonObject | IApiItemJson | |
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -21,9 +21,9 @@ serializeInto(jsonObject: Partial<IApiItemJson>): void;
| Parameter | Type | Description |
| --- | --- | --- |
| jsonObject | <code>Partial</code><code>&lt;</code><code>IApiItemJson</code><code>&gt;</code> | |
| jsonObject | Partial&lt;IApiItemJson&gt; | |
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -25,7 +25,7 @@ addMember(member: ApiItem): void;
<b>Returns:</b>
`void`
void
## Remarks

Просмотреть файл

@ -21,9 +21,9 @@ findMembersByName(name: string): ReadonlyArray<ApiItem>;
| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |
| name | string | |
<b>Returns:</b>
`ReadonlyArray``<`[ApiItem](./api-extractor-model.apiitem.md)`>`
ReadonlyArray&lt;[ApiItem](./api-extractor-model.apiitem.md)<!-- -->&gt;

Просмотреть файл

@ -25,7 +25,7 @@ function isBaseClassOf(apiItem: ApiItem): apiItem is ApiItemContainerMixin;
<b>Returns:</b>
`apiItem`` is `[ApiItemContainerMixin](./api-extractor-model.apiitemcontainermixin.md)
apiItem is [ApiItemContainerMixin](./api-extractor-model.apiitemcontainermixin.md)
## Remarks

Просмотреть файл

@ -21,9 +21,9 @@ serializeInto(jsonObject: Partial<IApiItemJson>): void;
| Parameter | Type | Description |
| --- | --- | --- |
| jsonObject | <code>Partial</code><code>&lt;</code><code>IApiItemJson</code><code>&gt;</code> | |
| jsonObject | Partial&lt;IApiItemJson&gt; | |
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -21,11 +21,11 @@ tryGetMemberByKey(containerKey: string): ApiItem | undefined;
| Parameter | Type | Description |
| --- | --- | --- |
| containerKey | <code>string</code> | |
| containerKey | string | |
<b>Returns:</b>
[ApiItem](./api-extractor-model.apiitem.md)` | undefined`
[ApiItem](./api-extractor-model.apiitem.md) \| undefined
## Remarks

Просмотреть файл

@ -21,5 +21,5 @@ buildCanonicalReference(): DeclarationReference;
```
<b>Returns:</b>
`DeclarationReference`
DeclarationReference

Просмотреть файл

@ -19,11 +19,11 @@ static getContainerKey(name: string, isStatic: boolean, overloadIndex: number):
| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |
| isStatic | <code>boolean</code> | |
| overloadIndex | <code>number</code> | |
| name | string | |
| isStatic | boolean | |
| overloadIndex | number | |
<b>Returns:</b>
`string`
string

Просмотреть файл

@ -41,7 +41,7 @@ Compare with [ApiMethodSignature](./api-extractor-model.apimethodsignature.md)<!
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [containerKey](./api-extractor-model.apimethod.containerkey.md) | | <code>string</code> | |
| [containerKey](./api-extractor-model.apimethod.containerkey.md) | | string | |
| [kind](./api-extractor-model.apimethod.kind.md) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | |
## Methods

Просмотреть файл

@ -21,5 +21,5 @@ buildCanonicalReference(): DeclarationReference;
```
<b>Returns:</b>
`DeclarationReference`
DeclarationReference

Просмотреть файл

@ -19,10 +19,10 @@ static getContainerKey(name: string, overloadIndex: number): string;
| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |
| overloadIndex | <code>number</code> | |
| name | string | |
| overloadIndex | number | |
<b>Returns:</b>
`string`
string

Просмотреть файл

@ -41,7 +41,7 @@ Compare with [ApiMethod](./api-extractor-model.apimethod.md)<!-- -->, which repr
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [containerKey](./api-extractor-model.apimethodsignature.containerkey.md) | | <code>string</code> | |
| [containerKey](./api-extractor-model.apimethodsignature.containerkey.md) | | string | |
| [kind](./api-extractor-model.apimethodsignature.kind.md) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | |
## Methods

Просмотреть файл

@ -25,5 +25,5 @@ addMember(member: ApiPackage): void;
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -21,5 +21,5 @@ buildCanonicalReference(): DeclarationReference;
```
<b>Returns:</b>
`DeclarationReference`
DeclarationReference

Просмотреть файл

@ -19,7 +19,7 @@ loadPackage(apiJsonFilename: string): ApiPackage;
| Parameter | Type | Description |
| --- | --- | --- |
| apiJsonFilename | <code>string</code> | |
| apiJsonFilename | string | |
<b>Returns:</b>

Просмотреть файл

@ -54,9 +54,9 @@ Normally, API Extractor writes an .api.json file to disk for each project that i
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [containerKey](./api-extractor-model.apimodel.containerkey.md) | | <code>string</code> | |
| [containerKey](./api-extractor-model.apimodel.containerkey.md) | | string | |
| [kind](./api-extractor-model.apimodel.kind.md) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | |
| [packages](./api-extractor-model.apimodel.packages.md) | | <code>ReadonlyArray</code><code>&lt;</code>[ApiPackage](./api-extractor-model.apipackage.md)<code>&gt;</code> | |
| [packages](./api-extractor-model.apimodel.packages.md) | | ReadonlyArray&lt;[ApiPackage](./api-extractor-model.apipackage.md)<!-- -->&gt; | |
## Methods

Просмотреть файл

@ -19,8 +19,8 @@ resolveDeclarationReference(declarationReference: DocDeclarationReference, conte
| Parameter | Type | Description |
| --- | --- | --- |
| declarationReference | <code>DocDeclarationReference</code> | |
| contextApiItem | [ApiItem](./api-extractor-model.apiitem.md)<code> &#124; undefined</code> | |
| declarationReference | DocDeclarationReference | |
| contextApiItem | [ApiItem](./api-extractor-model.apiitem.md) \| undefined | |
<b>Returns:</b>

Просмотреть файл

@ -21,11 +21,11 @@ tryGetPackageByName(packageName: string): ApiPackage | undefined;
| Parameter | Type | Description |
| --- | --- | --- |
| packageName | <code>string</code> | |
| packageName | string | |
<b>Returns:</b>
[ApiPackage](./api-extractor-model.apipackage.md)` | undefined`
[ApiPackage](./api-extractor-model.apipackage.md) \| undefined
## Remarks

Просмотреть файл

@ -25,7 +25,7 @@ function isBaseClassOf(apiItem: ApiItem): apiItem is ApiNameMixin;
<b>Returns:</b>
`apiItem`` is `[ApiNameMixin](./api-extractor-model.apinamemixin.md)
apiItem is [ApiNameMixin](./api-extractor-model.apinamemixin.md)
## Remarks

Просмотреть файл

@ -21,9 +21,9 @@ serializeInto(jsonObject: Partial<IApiItemJson>): void;
| Parameter | Type | Description |
| --- | --- | --- |
| jsonObject | <code>Partial</code><code>&lt;</code><code>IApiItemJson</code><code>&gt;</code> | |
| jsonObject | Partial&lt;IApiItemJson&gt; | |
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -21,5 +21,5 @@ buildCanonicalReference(): DeclarationReference;
```
<b>Returns:</b>
`DeclarationReference`
DeclarationReference

Просмотреть файл

@ -19,9 +19,9 @@ static getContainerKey(name: string): string;
| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |
| name | string | |
<b>Returns:</b>
`string`
string

Просмотреть файл

@ -44,7 +44,7 @@ export namespace X {
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [containerKey](./api-extractor-model.apinamespace.containerkey.md) | | <code>string</code> | |
| [containerKey](./api-extractor-model.apinamespace.containerkey.md) | | string | |
| [kind](./api-extractor-model.apinamespace.kind.md) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | |
## Methods

Просмотреть файл

@ -25,5 +25,5 @@ addMember(member: ApiEntryPoint): void;
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -21,5 +21,5 @@ buildCanonicalReference(): DeclarationReference;
```
<b>Returns:</b>
`DeclarationReference`
DeclarationReference

Просмотреть файл

@ -19,9 +19,9 @@ findEntryPointsByPath(importPath: string): ReadonlyArray<ApiEntryPoint>;
| Parameter | Type | Description |
| --- | --- | --- |
| importPath | <code>string</code> | |
| importPath | string | |
<b>Returns:</b>
`ReadonlyArray``<`[ApiEntryPoint](./api-extractor-model.apientrypoint.md)`>`
ReadonlyArray&lt;[ApiEntryPoint](./api-extractor-model.apientrypoint.md)<!-- -->&gt;

Просмотреть файл

@ -19,7 +19,7 @@ static loadFromJsonFile(apiJsonFilename: string): ApiPackage;
| Parameter | Type | Description |
| --- | --- | --- |
| apiJsonFilename | <code>string</code> | |
| apiJsonFilename | string | |
<b>Returns:</b>

Просмотреть файл

@ -31,8 +31,8 @@ This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of c
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [containerKey](./api-extractor-model.apipackage.containerkey.md) | | <code>string</code> | |
| [entryPoints](./api-extractor-model.apipackage.entrypoints.md) | | <code>ReadonlyArray</code><code>&lt;</code>[ApiEntryPoint](./api-extractor-model.apientrypoint.md)<code>&gt;</code> | |
| [containerKey](./api-extractor-model.apipackage.containerkey.md) | | string | |
| [entryPoints](./api-extractor-model.apipackage.entrypoints.md) | | ReadonlyArray&lt;[ApiEntryPoint](./api-extractor-model.apientrypoint.md)<!-- -->&gt; | |
| [kind](./api-extractor-model.apipackage.kind.md) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | |
## Methods

Просмотреть файл

@ -19,10 +19,10 @@ saveToJsonFile(apiJsonFilename: string, options?: IApiPackageSaveOptions): void;
| Parameter | Type | Description |
| --- | --- | --- |
| apiJsonFilename | <code>string</code> | |
| apiJsonFilename | string | |
| options | [IApiPackageSaveOptions](./api-extractor-model.iapipackagesaveoptions.md) | |
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -25,7 +25,7 @@ function isBaseClassOf(apiItem: ApiItem): apiItem is ApiParameterListMixin;
<b>Returns:</b>
`apiItem`` is `[ApiParameterListMixin](./api-extractor-model.apiparameterlistmixin.md)
apiItem is [ApiParameterListMixin](./api-extractor-model.apiparameterlistmixin.md)
## Remarks

Просмотреть файл

@ -19,9 +19,9 @@ serializeInto(jsonObject: Partial<IApiItemJson>): void;
| Parameter | Type | Description |
| --- | --- | --- |
| jsonObject | <code>Partial</code><code>&lt;</code><code>IApiItemJson</code><code>&gt;</code> | |
| jsonObject | Partial&lt;IApiItemJson&gt; | |
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -21,5 +21,5 @@ buildCanonicalReference(): DeclarationReference;
```
<b>Returns:</b>
`DeclarationReference`
DeclarationReference

Просмотреть файл

@ -19,10 +19,10 @@ static getContainerKey(name: string, isStatic: boolean): string;
| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |
| isStatic | <code>boolean</code> | |
| name | string | |
| isStatic | boolean | |
<b>Returns:</b>
`string`
string

Просмотреть файл

@ -53,7 +53,7 @@ Compare with [ApiPropertySignature](./api-extractor-model.apipropertysignature.m
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [containerKey](./api-extractor-model.apiproperty.containerkey.md) | | <code>string</code> | |
| [containerKey](./api-extractor-model.apiproperty.containerkey.md) | | string | |
| [kind](./api-extractor-model.apiproperty.kind.md) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | |
## Methods

Просмотреть файл

@ -27,7 +27,7 @@ export declare class ApiPropertyItem extends ApiPropertyItem_base
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [isEventProperty](./api-extractor-model.apipropertyitem.iseventproperty.md) | | <code>boolean</code> | Returns true if this property should be documented as an event. |
| [isEventProperty](./api-extractor-model.apipropertyitem.iseventproperty.md) | | boolean | Returns true if this property should be documented as an event. |
| [propertyTypeExcerpt](./api-extractor-model.apipropertyitem.propertytypeexcerpt.md) | | [Excerpt](./api-extractor-model.excerpt.md) | An [Excerpt](./api-extractor-model.excerpt.md) that describes the type of the property. |
## Methods

Просмотреть файл

@ -21,11 +21,11 @@ static onDeserializeInto(options: Partial<IApiPropertyItemOptions>, context: Des
| Parameter | Type | Description |
| --- | --- | --- |
| options | <code>Partial</code><code>&lt;</code>[IApiPropertyItemOptions](./api-extractor-model.iapipropertyitemoptions.md)<code>&gt;</code> | |
| context | <code>DeserializerContext</code> | |
| jsonObject | <code>IApiPropertyItemJson</code> | |
| options | Partial&lt;[IApiPropertyItemOptions](./api-extractor-model.iapipropertyitemoptions.md)<!-- -->&gt; | |
| context | DeserializerContext | |
| jsonObject | IApiPropertyItemJson | |
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -21,9 +21,9 @@ serializeInto(jsonObject: Partial<IApiPropertyItemJson>): void;
| Parameter | Type | Description |
| --- | --- | --- |
| jsonObject | <code>Partial</code><code>&lt;</code><code>IApiPropertyItemJson</code><code>&gt;</code> | |
| jsonObject | Partial&lt;IApiPropertyItemJson&gt; | |
<b>Returns:</b>
`void`
void

Просмотреть файл

@ -21,5 +21,5 @@ buildCanonicalReference(): DeclarationReference;
```
<b>Returns:</b>
`DeclarationReference`
DeclarationReference

Просмотреть файл

@ -19,9 +19,9 @@ static getContainerKey(name: string): string;
| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |
| name | string | |
<b>Returns:</b>
`string`
string

Просмотреть файл

@ -42,7 +42,7 @@ Compare with [ApiProperty](./api-extractor-model.apiproperty.md)<!-- -->, which
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [containerKey](./api-extractor-model.apipropertysignature.containerkey.md) | | <code>string</code> | |
| [containerKey](./api-extractor-model.apipropertysignature.containerkey.md) | | string | |
| [kind](./api-extractor-model.apipropertysignature.kind.md) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | |
## Methods

Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше