Home > @microsoft/api-extractor-model > IApiPropertyItemOptions
IApiPropertyItemOptions interface
Constructor options for ApiPropertyItem.
Signature:
export interface IApiPropertyItemOptions extends IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiOptionalMixinOptions, IApiReadonlyMixinOptions, IApiDeclaredItemOptions
Extends: IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiOptionalMixinOptions, IApiReadonlyMixinOptions, IApiDeclaredItemOptions
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| docComment | tsdoc.DocComment | undefined | (Inherited from IApiDocumentedItemOptions) | |
| excerptTokens | IExcerptToken[] | (Inherited from IApiDeclaredItemOptions) | |
| isOptional | boolean | (Inherited from IApiOptionalMixinOptions) | |
| isReadonly | boolean | (Inherited from IApiReadonlyMixinOptions) | |
| name | string | (Inherited from IApiNameMixinOptions) | |
| propertyTypeTokenRange | IExcerptTokenRange | ||
| releaseTag | ReleaseTag | (Inherited from IApiReleaseTagMixinOptions) |