Interface FileLoaderInterface

packages/file-loaders/src/types.ts:184–200

 * Defines the interface that all file loader classes must implement.
 */
export interface FileLoaderInterface {
  /**
   * Aggregates the page content obtained from loadPages into a single string.
   * @param pages Array of DocumentPage objects.
   * @returns Promise that returns the aggregated text content.
   */
  aggregateContent: (pages: DocumentPage[]) => Promise<string>;

  attachDocumentMetadata?: (filePath: string) => Promise<Record<string, any>>;

  /**
   * Loads file content based on the file path and splits it into logical pages/chunks.
   * @param filePath Full path of the file.
   * @returns Promise that returns an array containing DocumentPage objects.
   */
  loadPages: (filePath: string) => Promise<DocumentPage[]>;
}