import { BaseArgs, GeneratedDefinition, GeneratedType, GeneratedFunction } from './types.js';

/**
 * Generate documentation for properties of `type` and `interface` and parameters and returns
 * signature of `function`.
 * @returns Parsed TSDoc definition from TypeScript `type`, `interface` or `function`.
 * @example
 * To generate documentation for a `type`, `interface`, or `function`, export it via the `code`
 * argument.
 *
 * ### As a `default` export
 *
 * ```mdx
 * import { generateDefinition, TSDoc } from 'nextra/tsdoc'
 *
 * <TSDoc
 *   definition={generateDefinition({
 *     code: "export { yourTypeOrFunction as default } from 'your-package'",
 *   })}
 * />
 * ```
 *
 * ### As a named export
 *
 * ```mdx
 * import { generateDefinition, TSDoc } from 'nextra/tsdoc'
 *
 * <TSDoc
 *   definition={generateDefinition({
 *     code: "export { yourTypeOrFunction } from 'your-package'",
 *     exportName: 'yourTypeOrFunction'
 *   })}
 * />
 * ```
 */
declare function generateDefinition({ code, exportName, flattened }: BaseArgs): GeneratedDefinition & (GeneratedType | GeneratedFunction);

export { generateDefinition };