Skip to content

ListDirR (recursive directory listing)

ts
function ListDirR(what: string, mask?: string): DirListItem[];

Lists the contents of a directory in the local file system, recursively including all subdirectories, and returns a JavaScript array of DirListItem objects.

ParameterTypeRequirementExplanation
whatstringrequiredPath to a valid, existing directory in the local file system
maskstringoptionalFile mask (e.g., *.docx) to filter results; if omitted, all files in the directory and subdirectories are listed

Example

ts
// Acquire recursive directory list
var dirList = cli.ListDirR('/docs');
if (Array.isArray(dirList)) {
  dirList.forEach(function(item) {
    Log(item.Name);
  });
}

Example (with mask parameter)

ts
// Acquire recursive directory list with mask
var dirList = cli.ListDirR('/docs', '*.docx'); // only list *.docx files, including those in subfolders
if (Array.isArray(dirList)) {
  dirList.forEach(function(item) {
    Log(item.Name);
  });
}