Type alias FetchParams

Type declaration

• dir: string

  The working tree directory path.

• fs: FsClient

  A file system client.

• http: HttpClient

  An HTTP client.

• Optional cache?: Cache

  A cache object.

• Optional depth?: number | null

  Determines how much of the git repository's history to retrieve.

• Optional exclude?: string[]

  A list of branches or tags. Instructs the remote server not to send us any commits reachable from these refs.

• Optional gitdir?: string

  The git directory path (default: {dir}/.git).

• Optional headers?: HttpHeaders

  Additional headers to include in HTTP requests, similar to git's extraHeader config.

• Optional onAuth?: AuthCallback

  Optional auth fill callback.

• Optional onAuthFailure?: AuthFailureCallback

  Optional auth rejected callback.

• Optional onAuthSuccess?: AuthSuccessCallback

  Optional auth approved callback.

• Optional onMessage?: MessageCallback

  Optional message event callback.

• Optional onProgress?: ProgressCallback

  Optional progress event callback.

• Optional prune?: boolean

  Delete local remote-tracking branches that are not present on the remote.

• Optional pruneTags?: boolean

  Prune local tags that don’t exist on the remote, and force-update those tags that differ.

• Optional ref?: string

  Which branch to fetch if singleBranch is true. By default this is the current branch or the remote's default branch.

• Optional relative?: boolean

  Changes the meaning of depth to be measured from the current shallow depth rather than from the branch tip.

• Optional remote?: string

  If URL is not specified, determines which remote to use.

• Optional remoteRef?: string

  The name of the branch on the remote to fetch if singleBranch is true. By default this is the configured remote tracking branch.

• Optional since?: Date | null

  Only fetch commits created after the given date. Mutually exclusive with depth.

• Optional singleBranch?: boolean

  Instead of the default behavior of fetching all the branches, only fetch a single branch.

• Optional tags?: boolean

  Also fetch tags.

• Optional url?: string

  The URL of the remote repository. The default is the value set in the git config for that remote.