Edit

checkout

Checkout a branch

param	type [= default]	description
fs	FsClient	a file system implementation
onProgress	ProgressCallback	optional progress event callback
onPostCheckout	PostCheckoutCallback	optional post-checkout hook callback
dir	string	The working tree directory path
gitdir	string = join(dir,'.git')	The git directory path
ref	string = 'HEAD'	Source to checkout files from
filepaths	Array<string>	Limit the checkout to the given files and directories
remote	string = 'origin'	Which remote repository to use
noCheckout	boolean = false	If true, will update HEAD but won't update the working directory
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.
dryRun	boolean = false	If true, simulates a checkout so you can test whether it would succeed.
force	boolean = false	If true, conflicts will be ignored and files will be overwritten regardless of local changes.
track	boolean = true	If false, will not set the remote branch tracking information. Defaults to true.
cache	object	a cache object
return	Promise<void>	Resolves successfully when filesystem operations are complete

If the branch already exists it will check out that branch. Otherwise, it will create a new remote tracking branch set to track the remote branch of that name.

Example Code:

// switch to the main branch
await git.checkout({
  fs,
  dir: '/tutorial',
  ref: 'main'
})
console.log('done')

// restore the 'docs' and 'src/docs' folders to the way they were, overwriting any changes
await git.checkout({
  fs,
  dir: '/tutorial',
  force: true,
  filepaths: ['docs', 'src/docs']
})
console.log('done')

// restore the 'docs' and 'src/docs' folders to the way they are in the 'develop' branch, overwriting any changes
await git.checkout({
  fs,
  dir: '/tutorial',
  ref: 'develop',
  noUpdateHead: true,
  force: true,
  filepaths: ['docs', 'src/docs']
})
console.log('done')

---

Tip: If you need a clean slate, expand and run this snippet to clean up the file system.

window.fs = new LightningFS('fs', { wipe: true })
window.pfs = window.fs.promises
console.log('done')