UNPKG

969 BTypeScriptView Raw
1import type { ApiItem } from '@microsoft/api-extractor-model';
2/** @internal */
3export interface IMarkdownDocumenterAccessorImplementation {
4 getLinkForApiItem(apiItem: ApiItem): string | undefined;
5}
6/**
7 * Provides access to the documenter that is generating the output.
8 *
9 * @privateRemarks
10 * This class is wrapper that provides access to the underlying MarkdownDocumenter, while hiding the implementation
11 * details to ensure that the plugin API contract is stable.
12 *
13 * @public
14 */
15export declare class MarkdownDocumenterAccessor {
16 private _implementation;
17 /** @internal */
18 constructor(implementation: IMarkdownDocumenterAccessorImplementation);
19 /**
20 * For a given `ApiItem`, return its markdown hyperlink.
21 *
22 * @returns The hyperlink, or `undefined` if the `ApiItem` object does not have a hyperlink.
23 */
24 getLinkForApiItem(apiItem: ApiItem): string | undefined;
25}
26//# sourceMappingURL=MarkdownDocumenterAccessor.d.ts.map
\No newline at end of file