tiny-readdir
A simple promisified recursive readdir function.
Last updated 4 years ago by fabiospampinato .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ gnpm install tiny-readdir 
SYNC missed versions from official npm registry.

Tiny Readdir

A simple promisified recursive readdir function.

Install

npm install --save tiny-readdir

Usage

import readdir from 'tiny-readdir';

const aborter = new AbortController ();

const result = await readdir ( '/foo/bar', {
  depth: 20, // Maximum depth to look at
  limit: 1_000_000, // Maximum number of files explored, useful as a stop gap in some edge cases
  followSymlinks: true, // Whether to follow symlinks or not
  ignore: targetPath => /node_modules/.test ( targetPath ), // Function that if returns true will ignore this particular file or a directory and its descendants
  signal: aborter.signal // Optional abort signal, useful for aborting potentially expensive operations
});

console.log ( result.directories ); // => Array of absolute paths pointing to directories
console.log ( result.files ); // => Array of absolute paths pointing to files
console.log ( result.symlinks ); // => Array of absolute paths pointing to symlinks

console.log ( result.directoriesNames ); // => Set of directories names found
console.log ( result.filesNames ); // => Set of files name found
console.log ( result.symlinksNames ); // => Set of symlinks names found

console.log ( result.directoriesNamesToPaths ); // => Record of directories names found to their paths
console.log ( result.filesNamesToPaths ); // => Record of files names found to their paths
console.log ( result.symlinksNamesToPaths ); // => Record of symlinks names found to their paths

setTimeout ( () => aborter.abort (), 10000 ); // Aborting if it's going to take longer than 10s

License

MIT © Fabio Spampinato

Current Tags

  • 2.4.0                                ...           latest (a year ago)

14 Versions

  • 2.4.0                                ...           a year ago
  • 2.3.0                                ...           a year ago
  • 2.2.1                                ...           a year ago
  • 2.2.0                                ...           2 years ago
  • 2.1.0                                ...           2 years ago
  • 2.0.0                                ...           3 years ago
  • 1.5.0                                ...           4 years ago
  • 1.4.0                                ...           4 years ago
  • 1.3.0                                ...           4 years ago
  • 1.2.2                                ...           4 years ago
  • 1.2.1                                ...           4 years ago
  • 1.2.0                                ...           4 years ago
  • 1.1.0                                ...           4 years ago
  • 1.0.0                                ...           4 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 8
Last Day 0
Last Week 8
Last Month 0
Dependencies (0)
None
Dev Dependencies (4)
Dependents (1)

Copyright 2013 - present © cnpmjs.org | Home |