RoadmapShopEvents
Skip to main content

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

ApiPropertyItem class

The abstract base class for ApiProperty and ApiPropertySignature.

Signature:

export declare class ApiPropertyItem extends ApiPropertyItem_base 

Extends: ApiPropertyItem_base

(Some inherited members may not be shown because they are not represented in the documentation.)

Constructors

ConstructorModifiersDescription
(constructor)(options)Constructs a new instance of the ApiPropertyItem class

Properties

PropertyModifiersTypeDescription
isEventPropertyreadonlybooleanReturns true if this property should be documented as an event.
propertyTypeExcerptreadonlyExcerptAn Excerpt that describes the type of the property.

Methods

MethodModifiersDescription
onDeserializeInto(options, context, jsonObject)static
serializeInto(jsonObject)