If true, folder depth information will be added to every item starting with 0 (initial path), and will be incremented by 1 in every subfolder. Default: false
Sets the encoding format to use in the readFile FS native node function (ascii, base64, binary, hex, ucs2/ucs-2/utf16le/utf-16le, utf8/utf-8, latin1). Default: 'base64'
Negative filter the items: only items which DO NOT (partially or completely) match any of the strings in the exclude array will be returned. Default: []
If true, lowercase extensions will be added to every item in the extension object property (file.TXT => info.extension = ".txt"). Default: false
If true and mode is LIST, the list will be returned with files only. If true and mode is TREE, the directory structures without files will be deleted. If false, all empty and non empty directories will be listed. Default: true
Positive filter the items: only items which DO (partially or completely) match one of the strings in the include array will be returned. Default: []
The list will return an array of items. The tree will return the items structured like the file system. Default: LIST
Normalizes windows style paths by replacing double backslahes with single forward slahes (unix style). Default: true
Adds the content of the file into the item (base64 format). Default: false
Computes the canonical pathname by resolving ., .. and symbolic links. Default: true
If true, files and folders of folders and subfolders will be listed. If false, only the files and folders of the select directory will be listed. Default: true
If true a stats object (with file information) will be added to every item. If false this info is not added. Default: false.
Generated using TypeDoc
Options/Settings options available for this module
[mode] - The list will return an array of items. The tree will return the items structured like the file system. Default: LIST
[recursive] - If true, files and folders of folders and subfolders will be listed. If false, only the files and folders of the select directory will be listed. Default: true
[stats] - If true a stats object (with file information) will be added to every item. If false this info is not added. Default: false.
[ignoreFolders] - If true and mode is LIST, the list will be returned with files only. If true and mode is TREE, the directory structures without files will be deleted. If false, all empty and non empty directories will be listed. Default: true
[extensions] - If true, lowercase extensions will be added to every item in the extension object property (file.TXT => info.extension = ".txt"). Default: false
[deep] - If true, folder depth information will be added to every item starting with 0 (initial path), and will be incremented by 1 in every subfolder. Default: false
[realPath] - Computes the canonical pathname by resolving ., .. and symbolic links. Default: true
[normalizePath] - Normalizes windows style paths by replacing double backslahes with single forward slahes (unix style). Default: true
[include] - Positive filter the items: only items which DO (partially or completely) match one of the strings in the include array will be returned. Default: []
[exclude] - Negative filter the items: only items which DO NOT (partially or completely) match any of the strings in the exclude array will be returned. Default: []
[readContent] - Adds the content of the file into the item (base64 format). Default: false
[encoding] - Sets the encoding format to use in the readFile FS native node function (ascii, base64, binary, hex, ucs2/ucs-2/utf16le/utf-16le, utf8/utf-8, latin1). Default: 'base64'