Rush StackShopBlogEvents
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

Constructor

Modifiers

Description

(constructor)(options)

Constructs a new instance of the ApiPropertyItem class

Properties

Property

Modifiers

Type

Description

isEventProperty

readonly

boolean

Returns true if this property should be documented as an event.

propertyTypeExcerpt

readonly

Excerpt

An Excerpt that describes the type of the property.

Methods

Method

Modifiers

Description

onDeserializeInto(options, context, jsonObject)

static

serializeInto(jsonObject)