Class CheerioWebBaseLoader

A class that extends the BaseDocumentLoader and implements the DocumentLoader interface. It represents a document loader for loading web-based documents using Cheerio.

Example

const loader = new CheerioWebBaseLoader("https:exampleurl.com");
const docs = await loader.load();
console.log({ docs });

Hierarchy

Implements

Constructors

constructor

Properties

caller timeout webPath selector? textDecoder?

Methods

load loadAndSplit scrape imports scrapeAll

Constructors

constructor

Properties

caller

caller: AsyncCaller

timeout

timeout: number

webPath

webPath: string

Optional selector

selector?: SelectorType

Optional textDecoder

textDecoder?: TextDecoder

Methods

load

loadAndSplit

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.

Static scrapeAll

  • 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
    • Optional textDecoder: TextDecoder
    • Optional options: CheerioOptions

    Returns Promise<CheerioAPI[]>

    A Promise that resolves to an array of CheerioAPI instances.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc