ts-pkgx/dist/generate.d.ts

A library & CLI for managing packages

/**
 * Safely convert a filename to a valid JavaScript identifier
 * @param moduleName The module filename without extension
 * @returns A valid JavaScript identifier
 */
export declare function toSafeVarName(moduleName: string): string;
/**
 * Convert a filename to the expected type name in the file
 * @param moduleName The module filename without extension
 * @param packagesDir The packages directory to read from
 * @returns The expected type name
 */
export declare function toTypeName(moduleName: string, packagesDir?: string): string;
/**
 * Convert a filename to the expected package variable name in the file
 * @param moduleName The module filename without extension
 * @param packagesDir The packages directory to read from
 * @returns The expected package variable name
 */
export declare function toPackageVarName(moduleName: string, packagesDir?: string): string;
/**
 * Generate the index.ts file for the packages directory
 * @param packagesDir Optional packages directory path (for testing)
 * @returns The path to the generated index file
 */
export declare function generateIndex(packagesDir?: string): Promise<string | null>;
/**
 * Generates the aliases.ts file
 * @param packagesDir Optional packages directory path (for testing)
 * @returns Path to the generated file
 */
export declare function generateAliases(packagesDir?: string): Promise<string>;
/**
 * Main documentation generation function
 */
export declare function generateDocs(outputDir?: string, packagesDir?: string): Promise<void>;