simple-read-dir
v1.0.0
Published
Simple yet robust way to get a list of files and folders. Extracted for use across projects.
Downloads
5
Readme
Read Directory
Installation
npm install simple-read-dir
Usage
// Add to project
const readDirectory = require('simple-read-dir');
// OR
import readDirectory from 'simple-read-dir';
// Basic usage
const { files, folders } = await readDirectory(path, options);
// Recursive
const tree = await readDirectory(path, options, depth)
// Options
{
file?: boolean; // Files only
dir?: boolean; // Directories only
size?: boolean; // With sizes
search?: string; // Filter results
ext?: string; // Filter by extension
all?: boolean; // Include hidden files
}
(c) 2023 Tristan Collicott