Type alias CheckoutParams

Type declaration

• dir: string

  The working tree directory path.

• fs: FsClient

  A file system implementation.

• Optional cache?: Cache

  A cache object.

• Optional dryRun?: boolean

  If true, simulates a checkout so you can test whether it would succeed.

• Optional filepaths?: string[]

  Limit the checkout to the given files and directories.

• Optional force?: boolean

  If true, conflicts will be ignored and files will be overwritten regardless of local changes.

• Optional gitdir?: string

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

• Optional noCheckout?: boolean

  If true, will update HEAD but won't update the working directory.

• Optional noUpdateHead?: boolean

  If true, will update the working directory but won't update HEAD. Defaults to false when ref is provided, and true if ref is not provided.

• Optional onProgress?: ProgressCallback

  Optional progress event callback.

• Optional ref?: string

  Source to checkout files from (default: HEAD).

• Optional remote?: string

  Which remote repository to use (default: origin).

• Optional track?: boolean

  If false, will not set the remote branch tracking information (default true).