tsdoc-markdown
Version:
Generates markdown documentation from TypeScript source code.
9 lines (8 loc) • 446 B
TypeScript
import type { DocEntry, MarkdownEmoji, MarkdownOptions } from '../types';
import type { JsDocsMetadata } from './types';
export declare const emojiTitle: ({ emoji, key }: {
key: keyof MarkdownEmoji;
} & Pick<MarkdownOptions, "emoji">) => string;
export declare const metadataToMarkdown: ({ returnType, references, examples, url, emoji }: JsDocsMetadata & Pick<DocEntry, "url"> & {
emoji: MarkdownEmoji | null | undefined;
}) => string[];