node machine
about
Filesystem.ls()
List contents of a directory on the local filesystem.
Usage
var Filesystem = require('machinepack-fs');
// List contents of a directory on the local filesystem.
Filesystem.ls({
dir: '/Users/mikermcneil/.tmp/foo',
depth: 1,
includeFiles: true,
includeDirs: true,
includeSymlinks: true,
includeHidden: false,
}).exec({
// An unexpected error occurred.
error: function (err) {
},
// No directory was found at the specified directory path.
doesNotExist: function () {
},
// OK.
success: function (result) {
},
});
Inputs
-
dir
required Path to the directory whose contents should be listed.
-
'/Users/mikermcneil/.tmp/foo'
-
depth
The maximum number of "hops" (i.e. directories deep) to include directory contents from.
-
1
-
includeFiles
Whether or not to include files.
-
true
-
includeDirs
Whether or not to include directories.
-
true
-
includeSymlinks
Whether or not to include symbolic links.
-
true
-
includeHidden
Whether or not to include hidden files/directories/symlinks.
-
false
Exits
-
error
An unexpected error occurred.
-
doesNotExist
No directory was found at the specified directory path.
-
success
OK.
-
[ '/Users/mikermcneil/.tmp/foo/.gitignore' ]