Note.commitCreate
var oid = Note.commitCreate(repo, parent, author, committer, oid, note, allow_note_overwrite);
| Parameters | Type | |
|---|---|---|
| repo | Repository | repository where the note will live |
| parent | Commit | Pointer to parent note or NULL if this shall start a new notes tree |
| author | Signature | signature of the notes commit author |
| committer | Signature | signature of the notes commit committer |
| oid | Oid | OID of the git object to decorate |
| note | String | Content of the note to add for object oid |
| allow_note_overwrite | Number | Overwrite existing note |
| Returns | |
|---|---|
| Oid | a point to the id of a note blob (optional) |
Note.commitIteratorNew
Note.commitIteratorNew(notes_commit).then(function(noteIterator) {
// Use noteIterator
});
| Parameters | Type | |
|---|---|---|
| notes_commit | Commit | a pointer to the notes commit object |
| Returns | |
|---|---|
| NoteIterator |
Note.commitRead
Note.commitRead(repo, notes_commit, oid).then(function(note) {
// Use note
});
| Parameters | Type | |
|---|---|---|
| repo | Repository | repository where to look up the note |
| notes_commit | Commit | a pointer to the notes commit object |
| oid | Oid | OID of the git object to read the note from |
| Returns | |
|---|---|
| Note |
Note.commitRemove
Note.commitRemove(repo, notes_commit, author, committer, oid).then(function(oid) {
// Use oid
});
| Parameters | Type | |
|---|---|---|
| repo | Repository | repository where the note lives |
| notes_commit | Commit | a pointer to the notes commit object |
| author | Signature | signature of the notes commit author |
| committer | Signature | signature of the notes commit committer |
| oid | Oid | OID of the git object to remove the note from |
| Returns | |
|---|---|
| Oid |
Note.create
Note.create(repo, notes_ref, author, committer, oid, note, force).then(function(oid) {
// Use oid
});
| Parameters | Type | |
|---|---|---|
| repo | Repository | repository where to store the note |
| notes_ref | String | canonical name of the reference to use (optional); defaults to “refs/notes/commits” |
| author | Signature | signature of the notes commit author |
| committer | Signature | signature of the notes commit committer |
| oid | Oid | OID of the git object to decorate |
| note | String | Content of the note to add for object oid |
| force | Number | Overwrite existing note |
| Returns | |
|---|---|
| Oid |
Note.defaultRef
Note.defaultRef(repo).then(function(buf) {
// Use buf
});
| Parameters | Type | |
|---|---|---|
| repo | Repository | The Git repository |
| Returns | |
|---|---|
| Buf | buffer in which to store the name of the default notes reference |
Note.foreach
Note.foreach(repo, notes_ref, note_cb, payload).then(function(result) {
// Use result
});
| Parameters | Type | |
|---|---|---|
| repo | Repository | Repository where to find the notes. |
| notes_ref | String | Reference to read from (optional); defaults to “refs/notes/commits”. |
| note_cb | NoteForeachCb | Callback to invoke per found annotation. Return non-zero to stop looping. |
| payload | Void | Extra parameter to callback function. |
| Returns | |
|---|---|
| Number | 0 on success, non-zero callback return value, or error code |
Note.read
Note.read(repo, notes_ref, oid).then(function(note) {
// Use note
});
| Parameters | Type | |
|---|---|---|
| repo | Repository | repository where to look up the note |
| notes_ref | String | canonical name of the reference to use (optional); defaults to “refs/notes/commits” |
| oid | Oid | OID of the git object to read the note from |
| Returns | |
|---|---|
| Note |
Note.remove
Note.remove(repo, notes_ref, author, committer, oid).then(function(result) {
// Use result
});
| Parameters | Type | |
|---|---|---|
| repo | Repository | repository where the note lives |
| notes_ref | String | canonical name of the reference to use (optional); defaults to “refs/notes/commits” |
| author | Signature | signature of the notes commit author |
| committer | Signature | signature of the notes commit committer |
| oid | Oid | OID of the git object to remove the note from |
| Returns | |
|---|---|
| Number | 0 or an error code |
Note#author
var signature = note.author();
| Returns | |
|---|---|
| Signature | the author |
Note#committer
var signature = note.committer();
| Returns | |
|---|---|
| Signature | the committer |
Note#id
var oid = note.id();
| Returns | |
|---|---|
| Oid | the note object’s id |
Note#message
var string = note.message();
| Returns | |
|---|---|
| String | the note message |