UNPKG

@microsoft/api-extractor

Version:

Analyze the exported API for a TypeScript library and generate reviews, documentation, and .d.ts rollups

52 lines 1.78 kB
import { ApiModel, ApiPackage, ReleaseTag } from '@microsoft/api-extractor-model'; import type { Collector } from '../collector/Collector'; import type { ExtractorConfig } from '../api/ExtractorConfig'; /** * @beta */ export interface IApiModelGenerationOptions { /** * The release tags to trim. */ releaseTagsToTrim: Set<ReleaseTag>; } export declare class ApiModelGenerator { private readonly _collector; private readonly _apiModel; private readonly _referenceGenerator; private readonly _releaseTagsToTrim; readonly docModelEnabled: boolean; constructor(collector: Collector, extractorConfig: ExtractorConfig); get apiModel(): ApiModel; buildApiPackage(): ApiPackage; private _processAstEntity; private _processAstNamespaceImport; private _processDeclaration; private _tryFindFunctionDeclaration; private _processChildDeclarations; private _processApiCallSignature; private _processApiConstructor; private _processApiClass; private _processApiConstructSignature; private _processApiEnum; private _processApiEnumMember; private _processApiFunction; private _processApiIndexSignature; private _processApiInterface; private _processApiMethod; private _processApiMethodSignature; private _processApiNamespace; private _processApiProperty; private _processApiPropertySignature; private _processApiTypeAlias; private _processApiVariable; /** * @param nodesToCapture - A list of child nodes whose token ranges we want to capture */ private _buildExcerptTokens; private _captureTypeParameters; private _captureParameters; private _isReadonly; private _getFileUrlPath; } //# sourceMappingURL=ApiModelGenerator.d.ts.map