Interface: GitHubTreeOptions

Defined in: loaders.ts:53

Document loaders: small async functions that return InputDocument[] ready to pipe into RAG.ingest. Every loader is framework-agnostic and accepts a custom fetch for tests.

#Extends

• GitHubLoaderOptions

#Properties

#fetch?

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

Defined in: loaders.ts:10

#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: loaders.ts:55

Only include files matching this regex / test.

#Parameters

path

string

#Returns

boolean

---

#maxFiles?

optional maxFiles?: number

Defined in: loaders.ts:57

Max files to load. Default 100.

---

#ref?

optional ref?: string

Defined in: loaders.ts:28

Branch / tag / sha. Default 'HEAD'.

#Inherited from

GitHubLoaderOptions.ref

---

#token?

optional token?: string

Defined in: loaders.ts:26

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