OptionalaccessThe API endpoint URL of the GitHub instance. To be used when you are not targeting github.com, e.g. a GitHub Enterprise instance.
The base URL of the GitHub instance. To be used when you are not targeting github.com, e.g. a GitHub Enterprise instance.
ProtectedcallerOptionalignoreOptionalignoreOptionalmaxThe maximum number of concurrent calls that can be made. Defaults to 2.
OptionalmaxThe maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 2.
Set to true to recursively process submodules. Is only effective, when recursive=true.
OptionalverboseFetches the files from the GitHub repository and creates Document instances for each file. It also handles error handling based on the unknown handling option.
A promise that resolves to an array of Document instances.
Asynchronously streams documents from the entire GitHub repository. It is suitable for situations where processing large repositories in a memory-efficient manner is required.
ProtectedshouldDetermines whether a file or directory should be ignored based on its path and type.
The path of the file or directory.
The type of the file or directory.
A boolean indicating whether the file or directory should be ignored.
A class that extends the BaseDocumentLoader and implements the GithubRepoLoaderParams interface. It represents a document loader for loading files from a GitHub repository.