Interface: GitHubTreeOptions

Defined in: packages/rag/src/loaders/documents.ts:57

#Extends

• GitHubLoaderOptions

#Properties

#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/rag/src/loaders/shared.ts:5

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

GitHubLoaderOptions.fetch

---

#filter?

optional filter?: (path) => boolean

Defined in: packages/rag/src/loaders/documents.ts:59

Only include files matching this regex / test.

#Parameters

path

string

#Returns

boolean

---

#maxFiles?

optional maxFiles?: number

Defined in: packages/rag/src/loaders/documents.ts:61

Max files to load. Default 100.

---

#ref?

optional ref?: string

Defined in: packages/rag/src/loaders/documents.ts:31

Branch / tag / sha. Default 'HEAD'.

#Inherited from

GitHubLoaderOptions.ref

---

#signal?

optional signal?: AbortSignal

Defined in: packages/rag/src/loaders/shared.ts:7

Optional abort signal forwarded to underlying HTTP calls when supported.

#Inherited from

GitHubLoaderOptions.signal

---

#token?

optional token?: string

Defined in: packages/rag/src/loaders/documents.ts:29

#Inherited from

GitHubLoaderOptions.token

Explore nearby

• Peer
  BM25Options

  Auto-generated API reference for BM25Options.

• Peer
  ChunkOptions

  Auto-generated API reference for ChunkOptions.

• Peer
  ConfluenceLoaderOptions

  Auto-generated API reference for ConfluenceLoaderOptions.