langchain.js
    Preparing search index...

    Class GitbookLoader

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    caller headers? selector? shouldLoadAllPaths textDecoder? timeout webPath

    Methods

    load scrape _scrape imports scrapeAll

    Constructors

    • Parameters

      • webPath: string
      • params: GitbookLoaderParams = {}

      Returns GitbookLoader

    Properties

    caller: AsyncCaller
    headers?: HeadersInit
    selector?: SelectorType
    shouldLoadAllPaths: boolean = false
    textDecoder?: TextDecoder
    timeout: number
    webPath: string

    Methods

    • 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[]>

      Promise resolving to an array of Document instances.

    • 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_scrape

    • _scrape(
          url: string,
          caller: AsyncCaller,
          timeout: undefined | number,
          textDecoder?: TextDecoder,
          options?: CheerioOptions & { headers?: HeadersInit },
      ): Promise<CheerioAPI>

      Parameters

      • url: string
      • caller: AsyncCaller
      • timeout: undefined | number
      • OptionaltextDecoder: TextDecoder
      • Optionaloptions: CheerioOptions & { headers?: HeadersInit }

      Returns Promise<CheerioAPI>

    • 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: string | Buffer<ArrayBufferLike> | AnyNode | AnyNode[],
                  options?: null | CheerioOptions,
                  isDocument?: boolean,
              ) => CheerioAPI;
          },
      >

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

    • Fetches web documents from the given array of URLs and loads them using Cheerio. It returns an array of CheerioAPI instances.

      Parameters

      • urls: string[]

        An array of URLs to fetch and load.

      • caller: AsyncCaller
      • timeout: undefined | number
      • OptionaltextDecoder: TextDecoder
      • Optionaloptions: CheerioOptions & { headers?: HeadersInit }

      Returns Promise<CheerioAPI[]>

      A Promise that resolves to an array of CheerioAPI instances.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods