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

Constructors

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

Properties

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

Methods

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