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

ApiInterface class

Represents a TypeScript class declaration.

Signature:

export declare class ApiInterface extends ApiInterface_base 

Remarks

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

ApiInterface represents a TypeScript declaration such as this:

export interface X extends Y {
}

Constructors

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

Properties

Property Modifiers Type Description
containerKey   string  
extendsTypes   ReadonlyArray<HeritageType> The list of base interfaces that this interface inherits from using the extends keyword.
kind   ApiItemKind  

Methods

Method Modifiers Description
buildCanonicalReference()   (BETA)
getContainerKey(name) static  
onDeserializeInto(options, context, jsonObject) static  
serializeInto(jsonObject)