RoadmapShopEvents
Skip to main content

Home > @microsoft/api-extractor-model > IApiPropertyOptions

IApiPropertyOptions interface

Constructor options for ApiProperty.

Signature:

export interface IApiPropertyOptions extends IApiPropertyItemOptions, IApiProtectedMixinOptions, IApiStaticMixinOptions, IApiInitializerMixinOptions 

Extends: IApiPropertyItemOptions, IApiProtectedMixinOptions, IApiStaticMixinOptions, IApiInitializerMixinOptions

Properties

PropertyModifiersTypeDescription
docCommenttsdoc.DocComment | undefined(Inherited from IApiDocumentedItemOptions)
excerptTokensIExcerptToken[](Inherited from IApiDeclaredItemOptions)
initializerTokenRange?IExcerptTokenRange

(Optional)

(Inherited from IApiInitializerMixinOptions)

isOptionalboolean(Inherited from IApiOptionalMixinOptions)
isProtectedboolean(Inherited from IApiProtectedMixinOptions)
isReadonlyboolean(Inherited from IApiReadonlyMixinOptions)
isStaticboolean(Inherited from IApiStaticMixinOptions)
namestring(Inherited from IApiNameMixinOptions)
propertyTypeTokenRangeIExcerptTokenRange(Inherited from IApiPropertyItemOptions)
releaseTagReleaseTag(Inherited from IApiReleaseTagMixinOptions)