RoadmapShopEvents
Skip to main content

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

ApiPropertySignature class

Represents a TypeScript property declaration that belongs to an ApiInterface.

Signature:

export declare class ApiPropertySignature extends ApiPropertyItem 

Extends: ApiPropertyItem

Remarks

This is part of the ApiModel hierarchy of classes, which are serializable representations of API declarations.

ApiPropertySignature represents a TypeScript declaration such as the width and height members in this example:

export interface IWidget {
readonly width: number;
height: number;
}

Compare with ApiProperty, which represents a property belonging to a class. For example, a class property can be static but an interface property cannot.

(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 ApiPropertySignature class

Properties

PropertyModifiersTypeDescription
containerKeyreadonlystring
isEventPropertyreadonlyboolean

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

(Inherited from ApiPropertyItem)

kindreadonlyApiItemKind
propertyTypeExcerptreadonlyExcerpt

An Excerpt that describes the type of the property.

(Inherited from ApiPropertyItem)

Methods

MethodModifiersDescription
buildCanonicalReference()(BETA)
getContainerKey(name)static
onDeserializeInto(options, context, jsonObject)static

(Inherited from ApiPropertyItem)

serializeInto(jsonObject)

(Inherited from ApiPropertyItem)