@dev-build-deploy/comment-it/lib/extractor.d.ts

Source File Comment Management Library

import { Comment, ExtractorOptions } from "./types";
/**
 * Extracts all comments from the provided file and yields them as an async generator
 * @param filePath The path to the file to extract comments from
 * @returns An async generator that yields comments
 */
export declare function extractComments(filePath: string, options?: ExtractorOptions): AsyncGenerator<Comment>;