renameBranch
Rename a branch
param | type [= default] | description |
---|---|---|
fs | FsClient | a file system implementation |
dir | string | The working tree directory path |
gitdir | string = join(dir,'.git') | The git directory path |
ref | string | What to name the branch |
oldref | string | What the name of the branch was |
checkout | boolean = false | Update HEAD to point at the newly created branch |
return | Promise<void> | Resolves successfully when filesystem operations are complete |
Example Code:
await git.renameBranch({ fs, dir: '/tutorial', ref: 'main', oldref: 'master' })
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')