fast-glob
Advanced tools
Package description
The fast-glob package is a Node.js library that provides a fast and efficient way to match file paths against specified patterns. It uses the glob syntax, which is a way of filtering files in file systems using wildcard characters.
Synchronous file searching
This feature allows you to perform synchronous file searches, returning an array of paths that match the specified patterns. The example code searches for all files except markdown files.
const fg = require('fast-glob');
const paths = fg.sync(['**/*', '!**/*.md']);Asynchronous file searching
This feature allows you to perform asynchronous file searches, returning a promise that resolves with an array of paths that match the specified patterns. The example code searches for all files except markdown files and logs the result.
const fg = require('fast-glob');
fg.async(['**/*', '!**/*.md']).then(paths => {
console.log(paths);
});Stream interface for file searching
This feature provides a stream interface for file searching, emitting each matching path as a 'data' event. The example code searches for all files except markdown files and logs each matching path as it's found.
const fg = require('fast-glob');
const stream = fg.stream(['**/*', '!**/*.md']);
stream.on('data', (entry) => console.log(entry));The 'glob' package is one of the most well-known globbing libraries for Node.js. It is slower than fast-glob but has been around longer and has a large user base.
The 'node-glob' package is another alternative that provides similar functionality to fast-glob. It is also slower and less feature-rich compared to fast-glob.
The 'micromatch' package is a smaller, more focused library for matching files. It is highly performant and offers fine-grained control over the matching process, but it may not be as fast as fast-glob for large sets of files.
The 'minimatch' package is a minimal matching utility that works with the glob syntax. It is the matcher used internally by the 'glob' package and is less feature-rich compared to fast-glob.
Readme
Is a faster (1.5-8x for most cases)
node-globalternative.
$ npm i -S fast-glob
fs.Stats objects with the additional path property.fs.Stats object before sending it to an array.const fastGlob = require('fast-glob');
// Async
fastGlob('dir/**/*.txt').then((files) => {
console.log(files); // ['dir/a.txt', ...]
});
// Sync
const files = fastGlob.sync('dir/**/*.txt');
console.log(files); // ['dir/a.txt', ...]
String|String[] Patterns to be matchedObjectString[] or fs.Stats[] with path propertyString|String[] Patterns to be matchedObjectString[] or fs.Stats[] with path property| Option | Type | Default | Description |
|---|---|---|---|
cwd | String | process.cwd | The current working directory in which to search |
deep | `Number | Boolean` | true |
ignore | `String | String[]` | [] |
stats | Boolean | false | Return fs.Stats with path property instead of file path. |
onlyFiles | Boolean | false | Return only files. |
onlyDirs | Boolean | false | Return only directories. |
bashNative | String[] | ['darwin', 'linux'] | Use bash-powered globbing (2-15x faster on Linux, but slow on BashOnWindows) for specified platforms. See available values for array. |
transform | Function | null | Allows you to transform a path or fs.Stats object before sending to the array. |
node-glob?Not fully, because fast-glob not implements all options of node-glob.
transform optionfastGlob('dir/**/*.txt', { transform: readFilePromise }).then((files) => {
console.log(files); // ['dir/a.txt', ...]
return Promise.all(files);
}).then((files) => {
console.log(files); // ['content from dir/a.txt', ...]
});
Tech specs:
$ npm run bench
==============================
Benchmark for 10 files
==============================
bash: 6 ms
node-glob (10): 19.47606 ms
bash-glob (10): 23.406374 ms
fast-glob (10) as native: 25.359293 ms
fast-glob (10) as fast: 33.696387 ms
==============================
Benchmark for 50 files
==============================
bash: 6 ms
node-glob (54): 28.43855 ms
bash-glob (54): 20.731202 ms
fast-glob (54) as native: 22.709236 ms
fast-glob (54) as fast: 25.057461 ms
==============================
Benchmark for 100 files
==============================
bash: 5 ms
node-glob (109): 34.811618 ms
bash-glob (109): 21.624256 ms
fast-glob (109) as native: 26.291311 ms
fast-glob (109) as fast: 29.61791 ms
==============================
Benchmark for 500 files
==============================
bash: 7 ms
node-glob (549): 90.513766 ms
bash-glob (549): 23.116938 ms
fast-glob (549) as native: 30.978642 ms
fast-glob (549) as fast: 61.367613 ms
==============================
Benchmark for 1000 files
==============================
bash: 11 ms
node-glob (1099): 139.44816 ms
bash-glob (1099): 35.691985 ms
fast-glob (1099) as native: 36.770455 ms
fast-glob (1099) as fast: 84.387065 ms
==============================
Benchmark for 5000 files
==============================
bash: 43 ms
node-glob (5499): 584.910373 ms
bash-glob (5499): 90.38803 ms
fast-glob (5499) as native: 97.143759 ms
fast-glob (5499) as fast: 233.977073 ms
==============================
Benchmark for 10000 files
==============================
bash: 96 ms
node-glob (10999): 1143.377267 ms
bash-glob (10999): 169.416486 ms
fast-glob (10999) as native: 198.930152 ms
fast-glob (10999) as fast: 531.693878 ms
See the Releases section of our GitHub project for changelogs for each release version.
This software is released under the terms of the MIT license.
FAQs
Unknown package
We found that fast-glob demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A threat actor on BreachForums is selling an unverified npm vulnerability for account takeover, but npm has not officially confirmed the existence of this security concern.
Security News
Cyber insurance rates are dropping as the market matures, according to a new report projecting global premiums to reach $43 billion by 2030, driven by international market uptake and growth in the SME sector.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.