From 7865ddcbcc3f30dbcc586574bc536174450975dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ionic=C4=83=20Biz=C4=83u?= Date: Sun, 13 Sep 2015 17:49:10 +0300 Subject: [PATCH] Docs about _data and save --- lib/index.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/index.js b/lib/index.js index 1f65cf0..08a91c1 100644 --- a/lib/index.js +++ b/lib/index.js @@ -77,6 +77,8 @@ GitStats.DEFAULT_CONFIG = { * - `date` (String|Date): The date object or a string in a format that can be parsed. * - `url` (String): The repository remote url. * - `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. * @return {GitStats} The `GitStats` instance.