jest-changed-files - npm Package Compare versions

Comparing version 29.2.0 to 29.4.0

package.json

 {
   "name": "jest-changed-files",
-  "version": "29.2.0",
+  "version": "29.4.0",
   "repository": {
@@ -29,3 +29,3 @@ "type": "git",
   },
-  "gitHead": "ee5b37a4f4433afcfffb0356cea47739d8092287"
+  "gitHead": "4bc0e8acaf990e6618a7bed1dca67760c20bb12a"
 }

README.md

@@ -13,3 +13,3 @@ # jest-changed-files
 
-### `getChangedFilesForRoots(roots: <Array<string>>, options: ?object): Promise<?object>`
+### `getChangedFilesForRoots(roots: Array<string>, options: Options): Promise<ChangedFiles>`
 
@@ -26,5 +26,15 @@ Get the list of files and repos that have changed since the last commit.
 - withAncestor: boolean
+- changedSince: string
 
-### findRepos(roots: <Array<string>>): Promise<?object>
+### Returns
 
+A Promise of Object literal with keys
+
+- changedFiles: Set\<string>
+- repos:
+  - git: Set\<string>
+  - hg: Set\<string>
+
+### findRepos(roots: Array<string>): Promise<Repos>
+
 Get a set of git and hg repositories.
@@ -36,2 +46,9 @@
 
+### Returns
+
+A Promise of Object literal with keys
+
+- git: Set\<string>
+- hg: Set\<string>
+
 ## Usage
@@ -56,2 +73,17 @@
 ```javascript
+import {getChangedFilesForRoots} from 'jest-changed-files';
+
+getChangedFilesForRoots(['/path/to/test'], {
+  changedSince: 'main',
+}).then(files => {
+  /*
+  {
+    repos: [],
+    changedFiles: []
+  }
+  */
+});
+```
+
+```javascript
 import {findRepos} from 'jest-changed-files';
@@ -58,0 +90,0 @@

No alert changes

Improved metrics

Total package byte prevSize

15907

increased by14.05%

Number of package files

9

increased by12.5%

Number of lines in readme file

96

increased by50%

No dependency changes