Mirror/git-stats
1
0
Fork 0
mirror of https://github.com/IonicaBizau/git-stats.git synced 2025-01-03 10:22:11 +01:00
Code Issues Projects Releases Packages Wiki Activity

Docs about _data and save

Browse source
This commit is contained in:
Ionică Bizău 2015-09-13 17:49:10 +03:00
parent d04935e340
commit 7865ddcbcc
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
lib/index.js
View file

@ -77,6 +77,8 @@ GitStats.DEFAULT_CONFIG = {
* - `date` (String|Date): The date object or a string in a format that can be parsed. * - `date` (String|Date): The date object or a string in a format that can be parsed.
* - `url` (String): The repository remote url. * - `url` (String): The repository remote url.
* - `hash` (String): The commit hash. * - `hash` (String): The commit hash.
* - `_data` (Object): If this field is provided, it should be the content of the git-stats data file as object. It will be modified in-memory and then returned.
* - `save` (Boolean): If `false`, the result will *not* be saved in the file.
* *
* @param {Function} callback The callback function. * @param {Function} callback The callback function.
* @return {GitStats} The `GitStats` instance. * @return {GitStats} The `GitStats` instance.