Interface GithubRepoLoaderParams

⚠️ Deprecated ⚠️

This feature is deprecated and will be removed in the future.

It is not recommended for use.

  • Import from "@langchain/community/document_loaders/web/github" instead. This entrypoint will be removed in 0.3.0.

An interface that represents the parameters for the GithubRepoLoader class. It extends the AsyncCallerParams interface and adds additional properties specific to the GitHub repository loader.

interface GithubRepoLoaderParams {
    accessToken?: string;
    apiUrl?: string;
    baseUrl?: string;
    branch?: string;
    ignoreFiles?: (string | RegExp)[];
    ignorePaths?: string[];
    maxConcurrency?: number;
    maxRetries?: number;
    processSubmodules?: boolean;
    recursive?: boolean;
    unknown?: "ignore" | "warn" | "error";
    verbose?: boolean;
}

Hierarchy (view full)

Implemented by

Properties

accessToken? apiUrl? baseUrl? branch? ignoreFiles? ignorePaths? maxConcurrency? maxRetries? processSubmodules? recursive? unknown? verbose?

Properties

Optional accessToken

accessToken?: string

Optional apiUrl

apiUrl?: string

The API endpoint URL of the GitHub instance. To be used when you are not targeting github.com, e.g. a GitHub Enterprise instance.

Optional baseUrl

baseUrl?: string

The base URL of the GitHub instance. To be used when you are not targeting github.com, e.g. a GitHub Enterprise instance.

Optional branch

branch?: string

Optional ignoreFiles

ignoreFiles?: (string | RegExp)[]

Optional ignorePaths

ignorePaths?: string[]

Optional maxConcurrency

maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to 2.

Optional maxRetries

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 2.

Optional processSubmodules

processSubmodules?: boolean

Set to true to recursively process submodules. Is only effective, when recursive=true.

Optional recursive

recursive?: boolean

Optional unknown

unknown?: "ignore" | "warn" | "error"

Optional verbose

verbose?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc