Optional depthIt is a number which says the max depth the algorithm can reach scanning the given path. All files and dirs which are beyound the max depth will not be considered by the algorithm
Optional descendantsIf true, also the number of descendants of each node will be added to the result.
Optional descendantsIf true, only files will be count as descendants of a node. It does not have effect if [[descendants]] option is not true.
Optional emptyIf true, every node of type directory in the result will contain isEmpty property, which will be true if the folder contains no files and no directories
Optional excludeIt is a regex, string (glob patterns) or array of them and all the matching paths will not be considered by the algorithm.
Optional excludeIf true, every empty directory will be excluded from the result. If the directory is not empty but all the contained files and directories are excluded by other options such as exclude or extensions, the directory will not be included in the result
Optional extensionsIt is an array of strings and all the files whose extension is not included in that array will be skipped by the algorithm. If value is undefined, all file extensions will be considered, if it is [], no files will be included
Optional followIf true, all symbolic links will be followed, including even their content if they link to a folder. Could not work on Windows
Optional hashIf true, every node in the result will contain hash property, computed by taking in consideration the name and the content of the node. If the node is a folder, all his considered inner files will be used by the algorithm
Optional hashHash algorithm used by cryptojs to return the hash
Optional hashHash encoding used by cryptojs to return the hash
Optional homeIf true, the unix homedir shortcut ~ will be expanded to the user home directory
Optional matchesIt is a regex, string (glob pattern) or array of them and all the non-matching paths will not be considered by the algorithm. Note: All the ancestors of a matching node will be added.
Optional normalizeIf true, on windows, normalize each path replacing each backslash \\ with a slash /
Optional showIf true, all hidden files and dirs will be included in the result. A hidden file or a directory has a name which starts with a dot and in some systems like Linux are hidden
Optional sizeIf true, every node in the result will contain size property. Same as sizeInBytes, but it is a string rounded to the second decimal digit and with an appropriate unit
Optional sizeIf true, every node in the result will contain sizeInBytes property as the number of bytes of the content. If a node is a folder, only its considered inner files will be computed to have this size
Optional skipIf true, folders whose user has not permissions will be skipped. An error will be thrown otherwise. Note: in fact every error thrown by fs calls will be ignored
Optional sortedIf true, directories and files will be scanned ordered by path. The value can be both boolean for default alpha order, a custom sorting function or a predefined sorting method in [[SortMethodPredefined]].
Optional statIf true every node of the result will contain stat property, provided by fs.lstat or fs.stat
Optional symbolicIf true, all symbolic links found will be included in the result. Could not work on Windows
Generated using TypeDoc
Interface of the options object used with "scan" function