Type alias CloneParams

Type declaration

• dir: string

  The working tree directory path.

• fs: FsClient

  A file system implementation.

• http: HttpClient

  An HTTP client.

• url: string

  The URL of the remote repository.

• Optional cache?: Cache

  A cache object.

• Optional depth?: number

  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 noCheckout?: boolean

  If true, clone will only fetch the repo, not check out a branch. Skipping checkout can save a lot of time normally spent writing files to disk.

• Optional noTags?: boolean

  By default clone will fetch all tags. noTags disables that behavior.

• 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 ref?: string

  Which branch to checkout. By default this is the designated "main branch" of the repository.

• 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

  What to name the remote that is created (default: origin).

• Optional since?: Date

  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.