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

Hierarchy (view full)

Constructors

Properties

caller: AsyncCaller
shouldLoadAllPaths: boolean = false
timeout: number
webPath: string
headers?: Record<string, string> | [string, string][] | Headers
selector?: `.${number}${string}` | `.i${string}` | `.a${string}` | `.b${string}` | `.c${string}` | `.d${string}` | `.e${string}` | `.f${string}` | `.g${string}` | `.h${string}` | `.j${string}` | `.k${string}` | `.l${string}` | `.m${string}` | `.n${string}` | `.o${string}` | `.p${string}` | `.q${string}` | `.r${string}` | `.s${string}` | `.t${string}` | `.u${string}` | `.v${string}` | `.w${string}` | `.x${string}` | `.y${string}` | `.z${string}` | `.I${string}` | `.A${string}` | `.B${string}` | `.C${string}` | `.D${string}` | `.E${string}` | `.F${string}` | `.G${string}` | `.H${string}` | `.J${string}` | `.K${string}` | `.L${string}` | `.M${string}` | `.N${string}` | `.O${string}` | `.P${string}` | `.Q${string}` | `.R${string}` | `.S${string}` | `.T${string}` | `.U${string}` | `.V${string}` | `.W${string}` | `.X${string}` | `.Y${string}` | `.Z${string}` | `#${number}${string}` | `#i${string}` | `#a${string}` | `#b${string}` | `#c${string}` | `#d${string}` | `#e${string}` | `#f${string}` | `#g${string}` | `#h${string}` | `#j${string}` | `#k${string}` | `#l${string}` | `#m${string}` | `#n${string}` | `#o${string}` | `#p${string}` | `#q${string}` | `#r${string}` | `#s${string}` | `#t${string}` | `#u${string}` | `#v${string}` | `#w${string}` | `#x${string}` | `#y${string}` | `#z${string}` | `#I${string}` | `#A${string}` | `#B${string}` | `#C${string}` | `#D${string}` | `#E${string}` | `#F${string}` | `#G${string}` | `#H${string}` | `#J${string}` | `#K${string}` | `#L${string}` | `#M${string}` | `#N${string}` | `#O${string}` | `#P${string}` | `#Q${string}` | `#R${string}` | `#S${string}` | `#T${string}` | `#U${string}` | `#V${string}` | `#W${string}` | `#X${string}` | `#Y${string}` | `#Z${string}` | `:${number}${string}` | `:i${string}` | `:a${string}` | `:b${string}` | `:c${string}` | `:d${string}` | `:e${string}` | `:f${string}` | `:g${string}` | `:h${string}` | `:j${string}` | `:k${string}` | `:l${string}` | `:m${string}` | `:n${string}` | `:o${string}` | `:p${string}` | `:q${string}` | `:r${string}` | `:s${string}` | `:t${string}` | `:u${string}` | `:v${string}` | `:w${string}` | `:x${string}` | `:y${string}` | `:z${string}` | `:I${string}` | `:A${string}` | `:B${string}` | `:C${string}` | `:D${string}` | `:E${string}` | `:F${string}` | `:G${string}` | `:H${string}` | `:J${string}` | `:K${string}` | `:L${string}` | `:M${string}` | `:N${string}` | `:O${string}` | `:P${string}` | `:Q${string}` | `:R${string}` | `:S${string}` | `:T${string}` | `:U${string}` | `:V${string}` | `:W${string}` | `:X${string}` | `:Y${string}` | `:Z${string}` | `|${number}${string}` | `|i${string}` | `|a${string}` | `|b${string}` | `|c${string}` | `|d${string}` | `|e${string}` | `|f${string}` | `|g${string}` | `|h${string}` | `|j${string}` | `|k${string}` | `|l${string}` | `|m${string}` | `|n${string}` | `|o${string}` | `|p${string}` | `|q${string}` | `|r${string}` | `|s${string}` | `|t${string}` | `|u${string}` | `|v${string}` | `|w${string}` | `|x${string}` | `|y${string}` | `|z${string}` | `|I${string}` | `|A${string}` | `|B${string}` | `|C${string}` | `|D${string}` | `|E${string}` | `|F${string}` | `|G${string}` | `|H${string}` | `|J${string}` | `|K${string}` | `|L${string}` | `|M${string}` | `|N${string}` | `|O${string}` | `|P${string}` | `|Q${string}` | `|R${string}` | `|S${string}` | `|T${string}` | `|U${string}` | `|V${string}` | `|W${string}` | `|X${string}` | `|Y${string}` | `|Z${string}` | `>${number}${string}` | `>i${string}` | `>a${string}` | `>b${string}` | `>c${string}` | `>d${string}` | `>e${string}` | `>f${string}` | `>g${string}` | `>h${string}` | `>j${string}` | `>k${string}` | `>l${string}` | `>m${string}` | `>n${string}` | `>o${string}` | `>p${string}` | `>q${string}` | `>r${string}` | `>s${string}` | `>t${string}` | `>u${string}` | `>v${string}` | `>w${string}` | `>x${string}` | `>y${string}` | `>z${string}` | `>I${string}` | `>A${string}` | `>B${string}` | `>C${string}` | `>D${string}` | `>E${string}` | `>F${string}` | `>G${string}` | `>H${string}` | `>J${string}` | `>K${string}` | `>L${string}` | `>M${string}` | `>N${string}` | `>O${string}` | `>P${string}` | `>Q${string}` | `>R${string}` | `>S${string}` | `>T${string}` | `>U${string}` | `>V${string}` | `>W${string}` | `>X${string}` | `>Y${string}` | `>Z${string}` | `+${number}${string}` | `+i${string}` | `+a${string}` | `+b${string}` | `+c${string}` | `+d${string}` | `+e${string}` | `+f${string}` | `+g${string}` | `+h${string}` | `+j${string}` | `+k${string}` | `+l${string}` | `+m${string}` | `+n${string}` | `+o${string}` | `+p${string}` | `+q${string}` | `+r${string}` | `+s${string}` | `+t${string}` | `+u${string}` | `+v${string}` | `+w${string}` | `+x${string}` | `+y${string}` | `+z${string}` | `+I${string}` | `+A${string}` | `+B${string}` | `+C${string}` | `+D${string}` | `+E${string}` | `+F${string}` | `+G${string}` | `+H${string}` | `+J${string}` | `+K${string}` | `+L${string}` | `+M${string}` | `+N${string}` | `+O${string}` | `+P${string}` | `+Q${string}` | `+R${string}` | `+S${string}` | `+T${string}` | `+U${string}` | `+V${string}` | `+W${string}` | `+X${string}` | `+Y${string}` | `+Z${string}` | `~${number}${string}` | `~i${string}` | `~a${string}` | `~b${string}` | `~c${string}` | `~d${string}` | `~e${string}` | `~f${string}` | `~g${string}` | `~h${string}` | `~j${string}` | `~k${string}` | `~l${string}` | `~m${string}` | `~n${string}` | `~o${string}` | `~p${string}` | `~q${string}` | `~r${string}` | `~s${string}` | `~t${string}` | `~u${string}` | `~v${string}` | `~w${string}` | `~x${string}` | `~y${string}` | `~z${string}` | `~I${string}` | `~A${string}` | `~B${string}` | `~C${string}` | `~D${string}` | `~E${string}` | `~F${string}` | `~G${string}` | `~H${string}` | `~J${string}` | `~K${string}` | `~L${string}` | `~M${string}` | `~N${string}` | `~O${string}` | `~P${string}` | `~Q${string}` | `~R${string}` | `~S${string}` | `~T${string}` | `~U${string}` | `~V${string}` | `~W${string}` | `~X${string}` | `~Y${string}` | `~Z${string}` | `[${number}${string}` | `[i${string}` | `[a${string}` | `[b${string}` | `[c${string}` | `[d${string}` | `[e${string}` | `[f${string}` | `[g${string}` | `[h${string}` | `[j${string}` | `[k${string}` | `[l${string}` | `[m${string}` | `[n${string}` | `[o${string}` | `[p${string}` | `[q${string}` | `[r${string}` | `[s${string}` | `[t${string}` | `[u${string}` | `[v${string}` | `[w${string}` | `[x${string}` | `[y${string}` | `[z${string}` | `[I${string}` | `[A${string}` | `[B${string}` | `[C${string}` | `[D${string}` | `[E${string}` | `[F${string}` | `[G${string}` | `[H${string}` | `[J${string}` | `[K${string}` | `[L${string}` | `[M${string}` | `[N${string}` | `[O${string}` | `[P${string}` | `[Q${string}` | `[R${string}` | `[S${string}` | `[T${string}` | `[U${string}` | `[V${string}` | `[W${string}` | `[X${string}` | `[Y${string}` | `[Z${string}` | `${number}${string}` | `i${string}` | `a${string}` | `b${string}` | `c${string}` | `d${string}` | `e${string}` | `f${string}` | `g${string}` | `h${string}` | `j${string}` | `k${string}` | `l${string}` | `m${string}` | `n${string}` | `o${string}` | `p${string}` | `q${string}` | `r${string}` | `s${string}` | `t${string}` | `u${string}` | `v${string}` | `w${string}` | `x${string}` | `y${string}` | `z${string}` | `I${string}` | `A${string}` | `B${string}` | `C${string}` | `D${string}` | `E${string}` | `F${string}` | `G${string}` | `H${string}` | `J${string}` | `K${string}` | `L${string}` | `M${string}` | `N${string}` | `O${string}` | `P${string}` | `Q${string}` | `R${string}` | `S${string}` | `T${string}` | `U${string}` | `V${string}` | `W${string}` | `X${string}` | `Y${string}` | `Z${string}`
textDecoder?: TextDecoder

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.

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

  • 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 & {
          headers?: Record<string, string> | [string, string][] | Headers;
      }

    Returns Promise<CheerioAPI[]>

    A Promise that resolves to an array of CheerioAPI instances.

Generated using TypeDoc