@microsoft/api-extractor
Version:
Validatation, documentation, and auditing for the exported API of a TypeScript package
24 lines (23 loc) • 750 B
TypeScript
/// <reference types="es6-collections" />
import ApiItem, { IApiItemOptions } from './ApiItem';
/**
* This is an abstract base class for ApiPackage, ApiEnum, and ApiStructuredType,
* which all act as containers for other ApiItem definitions.
*/
declare abstract class ApiItemContainer extends ApiItem {
memberItems: Map<string, ApiItem>;
constructor(options: IApiItemOptions);
/**
* Return a list of the child items for this container, sorted alphabetically.
*/
getSortedMemberItems(): ApiItem[];
/**
* Add a child item to the container.
*/
protected addMemberItem(apiItem: ApiItem): void;
/**
* @virtual
*/
visitTypeReferencesForApiItem(): void;
}
export default ApiItemContainer;