Branch

Branch.create Async

Branch.create(repo, branch_name, target, force).then(function(reference) {
  // Use reference
});

Parameters	Type
repo	Repository
branch_name	String	Name for the branch; this name is validated for consistency. It should also not conflict with an already existing branch name.
target	Commit	Commit to which this branch should point. This object must belong to the given `repo`.
force	Number	Overwrite existing branch.

Returns
Reference	the underlying reference.

Branch.createFromAnnotated(repository, branch_name, commit, force).then(function(reference) {
  // Use reference
});

Returns
Reference

var result = Branch.delete(branch);

Parameters	Type
branch	Reference	A valid reference representing a branch

Returns
Number	0 on success, or an error code.

var result = Branch.isCheckedOut(branch);

Parameters	Type
branch	Reference	Reference to the branch.

Returns
Number	1 if branch is checked out, 0 if it isn’t,
error code otherwise.

var result = Branch.isHead(branch);

Parameters	Type
branch	Reference	Current underlying reference of the branch.

Returns
Number	1 if HEAD points at the branch, 0 if it isn’t,
error code otherwise.

Branch.lookup(repo, branch_name, branch_type).then(function(reference) {
  // Use reference
});

Parameters	Type
repo	Repository	the repository to look up the branch
branch_name	String	Name of the branch to be looked-up; this name is validated for consistency.
branch_type	Number	Type of the considered branch. This should be valued with either GIT_BRANCH_LOCAL or GIT_BRANCH_REMOTE.

Returns
Reference

Branch.move(branch, new_branch_name, force).then(function(reference) {
  // Use reference
});

Parameters	Type
branch	Reference	Current underlying reference of the branch.
new_branch_name	String	Target name of the branch once the move is performed; this name is validated for consistency.
force	Number	Overwrite existing branch.

Returns
Reference

Branch.name(ref).then(function(string) {
  // Use string
});

Parameters	Type
ref	Reference	the reference ideally pointing to a branch

Returns
String

Branch.remoteName(repo, the).then(function(string) {
  // Use string
});

Retrieve the Branch’s Remote Name as a String.

Parameters	Type
repo	Repository	The repo to get the remote name from
the	String	refname of the branch

Returns
String	remote name as a string.

Branch.setUpstream(branch, upstream_name).then(function(result) {
  // Use result
});

Parameters	Type
branch	Reference	the branch to configure
upstream_name	String	remote-tracking or local branch to set as upstream. Pass NULL to unset.

Returns
Number	0 or an error code

Branch.upstream(branch).then(function(reference) {
  // Use reference
});

Parameters	Type
branch	Reference	Current underlying reference of the branch.

Returns
Reference	the retrieved
reference.

Branch.upstreamName(repo, refname).then(function(buf) {
  // Use buf
});

Parameters	Type
repo	Repository	the repository where the branches live
refname	String	reference name of the local branch.

Returns
Buf

var result = Branch.upstreamRemote(buf, repo, refname);

Parameters	Type
buf	Buf	the buffer into which to write the name
repo	Repository	the repository in which to look
refname	String	the full name of the branch

Returns
Number	0 or an error code