RoadmapShopEvents
Skip to main content

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

PropertyModifiersTypeDescription
docCommenttsdoc.DocComment | undefined(Inherited from IApiDocumentedItemOptions)
excerptTokensIExcerptToken[](Inherited from IApiDeclaredItemOptions)
isOptionalboolean(Inherited from IApiOptionalMixinOptions)
isReadonlyboolean(Inherited from IApiReadonlyMixinOptions)
namestring(Inherited from IApiNameMixinOptions)
propertyTypeTokenRangeIExcerptTokenRange
releaseTagReleaseTag(Inherited from IApiReleaseTagMixinOptions)