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.

Constructors

Constructor	Modifiers	Description
(constructor)(options)		Constructs a new instance of the ApiPropertySignature class

Properties

Property	Modifiers	Type	Description
containerKey	readonly	string
kind	readonly	ApiItemKind

Methods

Method	Modifiers	Description
buildCanonicalReference()		(BETA)
getContainerKey(name)	static