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

📝

Browse source
This commit is contained in:
Ionică Bizău 2015-11-01 17:17:51 +02:00
parent c90a82094f
commit 35ccc37a1c
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
DOCUMENTATION.md
View file

@ -10,7 +10,7 @@ You can see below the API reference of this module.
- **GitStats** The `GitStats` instance. - **GitStats** The `GitStats` instance.
### `getConfig(callback)` ### `getConfig(callback)`
Fetches the configuration object from file (`~/.git-stats-config.json`). Fetches the configuration object from file (`~/.git-stats-config.js`).
#### Params #### Params
- **Function** `callback`: The callback function. - **Function** `callback`: The callback function.
@ -46,7 +46,7 @@ Deletes a specifc commit from the history.
#### Params #### Params
- **Object** `data`: The commit data containing: - **Object** `data`: The commit data containing:
- `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. If not provided, the hash object will be searched in all dates.
- `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. - `_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. - `save` (Boolean): If `false`, the result will *not* be saved in the file.
@ -107,11 +107,11 @@ Creates the calendar data for the provided period (default: *last year*).
#### Return #### Return
- **GitStats** The `GitStats` instance. - **GitStats** The `GitStats` instance.
### `ansiCalendar(data, callback)` ### `ansiCalendar(options, callback)`
Creates the ANSI contributions calendar. Creates the ANSI contributions calendar.
#### Params #### Params
- **Object** `data`: The object passed to the `calendar` method. - **Object** `options`: The object passed to the `calendar` method.
- **Function** `callback`: The callback function. - **Function** `callback`: The callback function.
#### Return #### Return
@ -136,6 +136,7 @@ Creates the authors pie.
- `repo` (String): The repository path. - `repo` (String): The repository path.
- `radius` (Number): The pie radius. - `radius` (Number): The pie radius.
- `no_ansi` (Boolean): If `true`, the pie will not contain ansi characters. - `no_ansi` (Boolean): If `true`, the pie will not contain ansi characters.
- `raw` (Boolean): If `true`, the raw JSON will be displayed.
- **Function** `callback`: The callback function. - **Function** `callback`: The callback function.
#### Return #### Return