interface Param {
    /** The name of the param */
    name: string;
    /** A description of the param */
    description?: string;
    /** The type of the param */
    type: string;
}
interface TypeScriptDocument {
    /** The title of the exported thing */
    title: string;
    /** The description of the exported thing */
    description?: string;
    /** Example of usage */
    examples?: string[];
    /** Params if applicable */
    params?: Param[];
    /** Properties if applicable */
    properties?: string[];
    /** Interface members if applicable */
    members?: string[];
    /** The type of the exported member */
    type?: string;
    /** If a function the type of the return */
    returnType?: string;
}
/**
 * Generate the markdown docs a doc returned from `getAllDocs`
 *
 * @param doc - The TypeScript document to generate types for
 */
export declare function generateMarkdown(doc: TypeScriptDocument, headerDepth?: number): string;
/**
 * Get the docs for all some files in the project.
 *
 * @param pattern - A glob pattern or patterns to match files from
 */
export declare function getAllDocs(pattern?: string | string[]): Promise<TypeScriptDocument[]>;
/**
 * Create a markdown comment matcher. This matches the section where
 * we will insert docs. Use this to create a custom section.
 *
 * @param name - The name to use in the markdown comment
 */
export declare function createMatcher(name: string): RegExp;
export interface GenerateOptions {
    /** A regex to match the part of the readme  */
    matcher?: RegExp;
    /** A glob pattern or patterns to match files from */
    pattern?: string | string[];
    /** How deep the markdown headers should be */
    headerDepth?: number;
}
/**
 * Generate all the docs and put it in the README.
 *
 * @param options - Options for generating the docs
 *
 * @example
 * import generate, { createMatcher } from 'ts-readme';
 *
 * generate({ matcher: createMatcher('TS-README-GENERATED') })
 */
export default function generate(options?: GenerateOptions): Promise<void>;
export {};
//# sourceMappingURL=index.d.ts.map