types: add api types

NodeSecure · Apr 12, 2024 · 2274288 · 2274288
1 parent 4bf8f8a
commit 2274288
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 2 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -1,5 +1,10 @@
 import {
   AstAnalyser,
+  AstAnalyserOptions,
+
+  EntryFilesAnalyser,
+  EntryFilesAnalyserOptions,
+
   SourceParser,
   runASTAnalysis,
   runASTAnalysisOnFile,
@@ -23,6 +28,9 @@ declare const warnings: Record<WarningName, Pick<WarningDefault, "experimental"
 export {
   warnings,
   AstAnalyser,
+  AstAnalyserOptions,
+  EntryFilesAnalyser,
+  EntryFilesAnalyserOptions,
   SourceParser,
   runASTAnalysis,
   runASTAnalysisOnFile,

diff --git a/src/EntryFilesAnalyser.js b/src/EntryFilesAnalyser.js
@@ -22,10 +22,10 @@ export class EntryFilesAnalyser {
   }
 
   /**
-   * Analyzes a set of entry files asynchronously, yielding analysis reports.
+   * Asynchronously analyze a set of entry files yielding analysis reports.
    *
    * @param {(string | URL)[]} entryFiles
-   * @yields {Object} - Yields an object containing the analysis results for each file.
+   * @yields {Object} - Yields an object containing the analysis report for each file.
   */
   async* analyse(entryFiles) {
     this.analyzedDeps = new Set();

diff --git a/types/api.d.ts b/types/api.d.ts
@@ -3,10 +3,13 @@ import { Statement } from "meriyah/dist/src/estree.js";
 
 export {
   AstAnalyser,
+  EntryFilesAnalyser,
   SourceParser,
   runASTAnalysis,
   runASTAnalysisOnFile,
 
+  AstAnalyserOptions,
+  EntryFilesAnalyserOptions,
   RuntimeOptions,
   RuntimeFileOptions,
 
@@ -101,5 +104,19 @@ declare class AstAnalyser {
   analyzeFile(pathToFile: string, options?: RuntimeFileOptions): Promise<ReportOnFile>;
 }
 
+interface EntryFilesAnalyserOptions {
+  astAnalyzer?: AstAnalyser;
+  loadExtensions?: (defaults: string[]) => string[];
+}
+
+declare class EntryFilesAnalyser {
+  constructor(options?: EntryFilesAnalyserOptions);
+
+  /**
+   * Asynchronously analyze a set of entry files yielding analysis reports.
+   */
+  analyse(entryFiles: (string | URL)[]): AsyncGenerator<ReportOnFile & { url: string }>;
+}
+
 declare function runASTAnalysis(str: string, options?: RuntimeOptions & AstAnalyserOptions): Report;
 declare function runASTAnalysisOnFile(pathToFile: string, options?: RuntimeFileOptions & AstAnalyserOptions): Promise<ReportOnFile>;