index.md

layout

default

menu_item

api

title

AnnotatedCommit

description

Version 0.4.0

return_to

API Documentation Index
/api/

sections

fromFetchhead	fromRef	lookup	#free	#id
#fromFetchhead	#fromRef	#lookup	#free	#id

AnnotatedCommit.fromFetchhead AsyncExperimental

AnnotatedCommit.fromFetchhead(repo, branch_name, remote_url, id).then(function(annotatedCommit) {
  // Use annotatedCommit
});

Parameters	Type
repo	Repository	repository that contains the given commit
branch_name	String	name of the (remote) branch
remote_url	String	url of the remote
id	Oid

Returns
AnnotatedCommit

AnnotatedCommit.fromRef(repo, ref).then(function(annotatedCommit) {
  // Use annotatedCommit
});

Parameters	Type
repo	Repository	repository that contains the given reference
ref	Reference	reference to use to lookup the git_annotated_commit

Returns
AnnotatedCommit

AnnotatedCommit.lookup(repo, id).then(function(annotatedCommit) {
  // Use annotatedCommit
});

Parameters	Type
repo	Repository	repository that contains the given commit
id	Oid	the commit object id to lookup

Returns
AnnotatedCommit

annotatedCommit.free();

var oid = annotatedCommit.id();

Returns
Oid	commit id