Class GitbookLoader

Class representing a document loader specifically designed for loading documents from Gitbook. It extends the CheerioWebBaseLoader.

Hierarchy

Constructors

constructor

Properties

caller shouldLoadAllPaths timeout webPath selector? textDecoder?

Methods

load loadAndSplit scrape imports

Constructors

constructor

Properties

caller

caller: AsyncCaller

shouldLoadAllPaths

shouldLoadAllPaths: boolean = false

timeout

timeout: number

webPath

webPath: string

Optional selector

selector?: SelectorType

Optional textDecoder

textDecoder?: TextDecoder

Methods

load

  • Method that scrapes the web document using Cheerio and loads the content based on the value of shouldLoadAllPaths. If shouldLoadAllPaths is true, it calls the loadAllPaths() method to load all paths. Otherwise, it calls the loadPath() method to load a single path.

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

    Promise resolving 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.

scrape

  • Fetches the web document from the webPath and loads it using Cheerio. It returns a CheerioAPI instance.

    Returns Promise<CheerioAPI>

    A Promise that resolves to a CheerioAPI instance.

Static imports

  • A static method that dynamically imports the Cheerio library and returns the load function. If the import fails, it throws an error.

    Returns Promise<{
        load: ((content, options?, isDocument?) => CheerioAPI);
    }>

    A Promise that resolves to an object containing the load function from the Cheerio library.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc