@rowanmanning/list-all-files
v5.1.0
Published
List all files in a directory
Downloads
36
Readme
@rowanmanning/list-all-files
List all files in a directory recursively.
[!WARNING] This library will be deprecated in April 2026 to coincide with the end-of-life date for Node.js 20. This is because the native
fs.globandfs.globSyncmethods in Node.js 22 and above provide the same functionality.
Requirements
This library requires the following to run:
- Node.js 20+
Usage
Install with npm:
npm install @rowanmanning/list-all-filesAsynchronous Interface
Load the library into your code with require:
const { listAllFiles } = require('@rowanmanning/list-all-files');List all files in a directory asynchronously, using promises or async/await:
listAllFiles('./directory-path').then(files => {
// files is an array of strings, each being the path to a file
});or
const files = await listAllFiles('./directory-path');
// files is an array of strings, each being the path to a fileSynchronous Interface
Load the library into your code with require:
const { listAllFilesSync } = require('@rowanmanning/list-all-files');List all files in a directory synchronously:
const files = listAllFilesSync('./directory-path');
// files is an array of strings, each being the path to a fileMigration
A new major version of this project is released if breaking changes are introduced. We maintain a migration guide to help users migrate between these versions.
Contributing
The contributing guide is available here. All contributors must follow this library's code of conduct.
License
Licensed under the MIT license. Copyright © 2020, Rowan Manning
