Reference

exports-md

Functions

`findNearestTypescript`

export function findNearestTypescript(startDir?: string): string;

^{🔍 findNearestTypescript on GitHub}

`generateMarkdownForModule`

export function generateMarkdownForModule(modulePath: string, options?: GenerateMarkdownOptions): Promise<GeneratedMarkdown>;

^{🔍 generateMarkdownForModule on GitHub}

Types

`GeneratedMarkdown`

export interface GeneratedMarkdown {
  declaration: string;
  fromCache: boolean;
  inputFile: string;
  markdown: string;
  warnings: string[];
}

^{🔍 GeneratedMarkdown on GitHub}

`GenerateMarkdownOptions`

export interface GenerateMarkdownOptions {
  cwd?: string;
  followImports?: boolean;
  followReExports?: boolean;
  github?: GitHubOptions;
  outDir?: string;
  propertyDocs?: PropertyDocMode;
  reverseSymbols?: boolean;
  groupBySyntax?: boolean;
  sortByName?: boolean;
  symbols?: string[];
}

^{🔍 GenerateMarkdownOptions on GitHub}

`GitHubOptions`

export interface GitHubOptions {
  repository?: string;
  searchLinks?: boolean;
}

^{🔍 GitHubOptions on GitHub}

`PropertyDocMode`

export type PropertyDocMode = 'inline' | 'list';

^{🔍 PropertyDocMode on GitHub}