Class EPubLoader

A class that extends the BaseDocumentLoader class. It represents a document loader that loads documents from EPUB files.

Hierarchy

Constructors

constructor

Properties

filePath

Methods

load loadAndSplit parse

Constructors

constructor

  • Parameters

    • filePath: string
    • __namedParameters: {
          splitChapters: undefined | boolean;
      } = {}
      • splitChapters: undefined | boolean

    Returns EPubLoader

Properties

filePath

filePath: string

Methods

load

  • A method that loads the EPUB file and returns a promise that resolves to an array of Document instances.

    Returns Promise<Document<Record<string, any>>[]>

    A promise that resolves to an array of Document instances.

loadAndSplit

  • Loads the documents and splits them using a specified text splitter.

    Parameters

    Returns Promise<Document<Record<string, any>>[]>

    A Promise that resolves with an array of Document instances, each split according to the provided TextSplitter.

Protected parse

  • A protected method that takes an EPUB object as a parameter and returns a promise that resolves to an array of objects representing the content and metadata of each chapter.

    Parameters

    • epub: EPub

      The EPUB object to parse.

    Returns Promise<{
        pageContent: string;
        metadata?: object;
    }[]>

    A promise that resolves to an array of objects representing the content and metadata of each chapter.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc