@types/klaw-sync - npm Package Compare versions

Comparing version 1.1.3 to 2.0.0

klaw-sync/index.d.ts

@@ -1,2 +0,2 @@
-// Type definitions for klaw-sync 1.1
+// Type definitions for klaw-sync 2.0
 // Project: https://github.com/manidlou/node-klaw-sync
@@ -9,33 +9,48 @@ // Definitions by: Brendan Forster <https://github.com/shiftkey>
 import * as fs from 'fs'
-
 declare namespace klawSync {
-  interface Item {
-    path: string
-    stats: fs.Stats
-  }
+    interface Item {
+        path: string
+        stats: fs.Stats
+    }
 
-  interface Options {
-    /**
-     *  any paths or `micromatch` patterns to ignore.
-     *
-     * For more information on micromatch patterns: https://github.com/jonschlinkert/micromatch#features
-     */
-    ignore?: string | string[]
-    /**
-     * True to only return files (ignore directories).
-     *
-     * Defaults to false if not specified.
-     */
-    nodir?: boolean
-    /**
-     * True to only return directories (ignore files).
-     *
-     * Defaults to false if not specified.
-     */
-    nofile?: boolean
-  }
+    type Filter = (item: Item) => boolean
+
+    interface Options {
+        /**
+         * @description True to only return files (ignore directories).
+         *              Defaults to false if not specified.
+         * @default false
+         */
+        nodir?: boolean
+
+        /**
+         * @description True to only return directories (ignore files).
+         *              Defaults to false if not specified.
+         * @default false
+         */
+        nofile?: boolean
+
+        /**
+         * @description when filter function is used, the default behavior is to read all directories even
+         *              if they don't pass the filter function (won't be included but still will be traversed).
+         *              If you set true, there will be neither inclusion nor traversal for directories that
+         *              don't pass the filter function
+         * @since v2.0.0
+         */
+        noRecurseOnFailedFilter?: boolean
+
+        /**
+         * @description function that gets one argument fn({path: '', stats: {}}) and returns true to include
+         *              or false to exclude the item
+         * @since v2.0.0
+         */
+        filter?: Filter
+    }
 }
 
-declare function klawSync(root: string, options?: klawSync.Options): ReadonlyArray<klawSync.Item>
+declare function klawSync(
+    root: string,
+    options?: klawSync.Options,
+): ReadonlyArray<klawSync.Item>
 
 export = klawSync

klaw-sync/package.json

 {
     "name": "@types/klaw-sync",
-    "version": "1.1.3",
+    "version": "2.0.0",
     "description": "TypeScript definitions for klaw-sync",
@@ -22,4 +22,4 @@ "license": "MIT",
     },
-    "typesPublisherContentHash": "5f216fa7437ba7258ed08e62bac235a9b6b6e3aa1f270c82eb1ec44d2b0ef2bd",
+    "typesPublisherContentHash": "35d58134885b59580178b34924b010db331bb59f784f5dcde3f11e1db1b869a2",
     "typeScriptVersion": "2.0"
 }

klaw-sync/README.md

@@ -11,3 +11,3 @@ # Installation
 Additional Details
- * Last updated: Tue, 29 Aug 2017 21:31:37 GMT
+ * Last updated: Tue, 24 Apr 2018 23:31:17 GMT
  * Dependencies: fs, node
@@ -14,0 +14,0 @@ * Global values: none

No alert changes

Improved metrics

Total package byte prevSize

4128

increased by23.08%

Lines of code

46

increased by35.29%

No dependency changes