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.
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(options) | Constructs a new instance of the ApiPackage class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| containerKey | readonly | string | |
| entryPoints | readonly | ReadonlyArray<ApiEntryPoint> | |
| kind | readonly | ApiItemKind | |
| projectFolderUrl | readonly | string | undefined | |
| tsdocConfiguration | readonly | TSDocConfiguration | The TSDoc configuration that was used when analyzing the API for this package. |