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

ApiPackage class

Represents an NPM package containing API declarations.

Signature:

export declare class ApiPackage extends ApiPackage_base 

Remarks

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

Constructors

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

Properties

Property Modifiers Type Description
containerKey   string  
entryPoints   ReadonlyArray<ApiEntryPoint>  
kind   ApiItemKind  

Methods

Method Modifiers Description
addMember(member)    
buildCanonicalReference()   (BETA)
findEntryPointsByPath(importPath)    
loadFromJsonFile(apiJsonFilename) static  
saveToJsonFile(apiJsonFilename, options)