Merge pull request #217 from danger/changelog_docs_fordifftype

Adds a changelog and diff
danger · Apr 12, 2017 · 8fba6e7 · 8fba6e7
2 parents 53ad560 + f818b4c
commit 8fba6e7
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/changelog.md b/changelog.md
@@ -2,6 +2,8 @@
 
 ### Master
 
+* Adds a `diffTypes` option to `diffForFile` - alex3165
+
 ### 0.15.0
 
 * When a Dangerfile fails to eval, send a message to the PR - orta

diff --git a/source/danger.d.ts b/source/danger.d.ts
@@ -164,7 +164,12 @@ export interface GitDSL {
    */
   readonly deleted_files: Array<string>
 
-  /** Offers the diff for a specific file */
+  /** Offers the diff for a specific file
+   *
+   * @param {string} filename the path to the json file
+   * @param {string[]} diffTypes An array containing: "add", "del" or "normal" - then you can only get these changes
+   */
+
   diffForFile(filename: string, diffTypes?: string[]): string | null,
 
   /**

diff --git a/source/dsl/GitDSL.ts b/source/dsl/GitDSL.ts
@@ -59,7 +59,12 @@ export interface GitDSL {
    */
   readonly deleted_files: Array<string>
 
-  /** Offers the diff for a specific file */
+  /** Offers the diff for a specific file
+   *
+   * @param {string} filename the path to the json file
+   * @param {string[]} diffTypes An array containing: "add", "del" or "normal" - then you can only get these changes
+   */
+
   diffForFile(filename: string, diffTypes?: string[]): string | null,
 
   /**