FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

JSdocs for filehistorywalk · nodegit/nodegit@a31d1eb · GitHub

Repository navigation

Commit a31d1eb

Browse files
committed
JSdocs for filehistorywalk
1 parent 9d548ec commit a31d1eb

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

‎lib/revwalk.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,3 +123,21 @@ Revwalk.prototype.getCommits = function(count) {
123123
return Promise.all(promises);
124124
});
125125
};
126+
127+
/**
128+
* @typedef historyEntry
129+
* @type {Object}
130+
* @property {Commit} commit the commit for this entry
131+
* @property {Number} status the status of the file in the commit
132+
* @property {String} oldName the old name that is provided when status is
133+
* renamed
134+
*/
135+
136+
/**
137+
* @function fileHistoryWalk
138+
* @memberof Revwalk.prototype
139+
* @param {String} filePath
140+
* @param {Number} max_count
141+
* @async
142+
* @return {Array<historyEntry>}
143+
*/

0 commit comments

Comments
 (0)

Back | FazBrowse Home | New Git URL