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

ApiClass class

Represents a TypeScript class declaration.

Signature:

export declare class ApiClass extends ApiClass_base 

Remarks

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

ApiClass represents a TypeScript declaration such as this:

export class X { }

Constructors

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

Properties

Property Modifiers Type Description
containerKey   string  
extendsType   HeritageType | undefined The base class that this class inherits from (using the extends keyword), or undefined if there is no base class.
implementsTypes   ReadonlyArray<HeritageType> The list of interfaces that this class implements using the implements keyword.
kind   ApiItemKind  

Methods

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