RoadmapShopEvents
Skip to main content

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

ApiPackage class

Represents an NPM package containing API declarations.

Signature:

export declare class ApiPackage extends ApiPackage_base 

Extends: ApiPackage_base

Remarks

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

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

Properties

PropertyModifiersTypeDescription
containerKeyreadonlystring
entryPointsreadonlyReadonlyArray<ApiEntryPoint>
kindreadonlyApiItemKind
tsdocConfigurationreadonlyTSDocConfigurationThe TSDoc configuration that was used when analyzing the API for this package.

Methods

MethodModifiersDescription
addMember(member)
buildCanonicalReference()(BETA)
findEntryPointsByPath(importPath)
loadFromJsonFile(apiJsonFilename)static
saveToJsonFile(apiJsonFilename, options)