readdir-plus

fs.readdir with additional options. Features:

• Multiple return types: names, paths, relative paths, details (with parts parsed + file type)
• Optional recursive search
• Loads stat for each found file / directory. Optionally disable for better performance.
• Detailed filtering by file type, regex and/or callback
• Produce tree structure or flat list
• Synchronous option
• Load content of found files (binary or text determined by extension) (TODO)
• Zero dependencies
• Tests

---

Basic usage

var readdir = require("readdir-plus");

readdir("/path/to/directory", function (err, files) {
	files.forEach(console.log);
});

Detailed results

readdir("/path/to/directory", {return: "details", stat: "true", content: "true"}, function (err, results) {
	require("util").inspect(results);
});

Output:

	[
		{
			name: "file.txt",
			path: "/home/myname/path/to/directory/subdir/file.txt",
			relativePath: "subdir/file.txt", 
			extension: ".txt",
			type: "file",
			stat: { /* see node documentation for properties found here */ },
			content: "Content of the file here"
		},
		{ /*... */ }
	]

For more examples, see unit tests

---

Options

All options with defaults and helpful comments can be seen here.

---

Licence

Apache v2. Read it here.