1 | import { ModuleDeclarations } from './module-declarations';
|
2 | import { PackageFile } from './package-file';
|
3 |
|
4 | /**
|
5 | * `PackageAPI` represents the public API exported by a package.
|
6 | *
|
7 | * @see {@link PackageDeclarations}
|
8 | * @see {@link PackageFile}
|
9 | */
|
10 | export interface PackageAPI {
|
11 | /** Main documentation comment describing the package */
|
12 | readonly overview?: string;
|
13 |
|
14 | /** Exported package declarations */
|
15 | readonly declarations: ModuleDeclarations;
|
16 |
|
17 | /** Files containing the exported package declarations */
|
18 | readonly files: PackageFile[];
|
19 | }
|