@ts-ast-parser/core/dist/models/module.d.ts

Reflects a simplified version of the TypeScript AST for generating documentation

import type { CommentPart } from '@ts-ast-parser/comment';
import type { Declaration } from './declaration.js';
import type { Export } from './export.js';
import type { Import } from './import.js';
/**
 * A JS Module represents all the declarations/imports/exports defined inside a file
 */
export interface Module {
    /**
     * The source path of the file relative to the working directory
     */
    sourcePath: string;
    /**
     * The output path of the file relative to the working directory
     */
    outputPath: string;
    /**
     * All the declarations exported from the file
     */
    declarations: Declaration[];
    /**
     * All the imports
     */
    imports: Import[];
    /**
     * All the exports
     */
    exports: Export[];
    /**
     * Module JSDoc
     */
    jsDoc?: CommentPart[];
}
//# sourceMappingURL=module.d.ts.map