glob
Advanced tools
Package description
The glob npm package allows users to match file paths against specified patterns similar to how shell works. It is widely used for tasks such as file searching, filtering, and bulk operations on sets of files.
File Pattern Matching
Match files using the patterns the shell uses, like stars and stuff.
const glob = require('glob');
glob('**/*.js', function (er, files) {
// files is an array of filenames.
// If the `nonull` option is set, and nothing
// was found, then files is ["**/*.js"]
// er is an error object or null.
console.log(files);
});Synchronous File Pattern Matching
Perform a synchronous glob search.
const glob = require('glob');
const files = glob.sync('**/*.js');
// files is an array of filenames found matching the pattern.
console.log(files);Pattern Matching with Promises
Use glob with Promises for better async control flow.
const glob = require('glob');
const util = require('util');
const globPromise = util.promisify(glob);
globPromise('**/*.js').then(files => {
console.log(files);
}).catch(err => {
console.error('Error occurred:', err);
});Minimatch is a minimal matching utility that works similarly to glob but focuses on the pattern matching algorithm itself. It is actually used by glob under the hood for its matching capabilities.
Fast-glob is an alternative to glob that claims to be faster due to its use of streams and parallel processing. It provides a similar API and is often used when performance is a critical factor.
Globule is another pattern matching library that extends the functionality of glob with additional features like filtering matched files using other patterns. It provides a more granular control over the file matching process.
Micromatch is a smaller, more efficient, and highly configurable globbing library. It provides a powerful and expressive API for pattern matching and is designed to be faster and safer than minimatch.
Readme
node-glob - Globbing for Node
[4:46pm] _ry: it would be good to
have a file system Glob functionality (to get an array of
filenames)
npm install glob
(You can also install it by doing node-waf configure build and then
linking or copying the folder into your project's node_modules
directory.)
A glob is a pattern-matching syntax that shells use. Like when you do
rm *.js, the *.js is a glob.
You can do nifty things with them.
If it doesn't work on one of those environments, please post a bug.
This is a binding to
glob(3) and
fnmatch(3). It includes
a statically compiled port of the NetBSD glob and fnmatch
programs, so it might not exactly match what #include <fnmatch.h>
or #include <glob.h> implements on your system.
To load the library:
var glob = require("glob")
Search through the filesystem asynchronously.
NOTHING!
glob(pattern, flags, function (er, matches) {
// if an error occurred, it's in er.
// otherwise, "matches" is an array of filenames.
...
})
Search through the filesystem synchronously
Array of strings that match.
var matches = glob.globSync(pattern, flags) // throws on error
Test if a string matches a pattern. (no i/o performed)
var isMatch = glob.fnmatch(pattern, str, flags)
The behavior of glob and fnmatch are modified by several bitwise flags.
The flags are defined on the main glob object. If you have an integer, and want to look up which flag it corresponds to, you can look it up on the glob/globSync functions if it is a glob flag, or on the fnmatch function if it is an fnmatch flag.
That is, fnmatch[fnmatch.FNM_CASEFOLD] === 'FNM_CASEFOLD'.
GLOB_DEFAULT Used if no flags are passed to glob() or
globSync(). Equivalent of
GLOB_BRACE|GLOB_LIMIT|GLOB_STAR|GLOB_MARK|GLOB_TILDE.FNM_DEFAULT Used if no flags are passed to fnmatch(). Equivalent
of FNM_PATHNAME|FNM_PERIOD.GLOB_MARK Append / to matching directories.GLOB_NOCHECK Return pattern itself if nothing matches.GLOB_NOSORT Don't sort.GLOB_NOESCAPE Disable backslash escaping.GLOB_NOSPACE Malloc call failed.GLOB_ABORTED Unignored error.GLOB_NOMATCH No match, and GLOB_NOCHECK was not set.GLOB_NOSYS Implementation does not support function.GLOB_BRACE Expand braces ala csh.GLOB_NOMAGIC GLOB_NOCHECK without magic chars (csh).GLOB_LIMIT Limit memory used by matches to ARG_MAXGLOB_TILDE Expand tilde names from the passwd file.GLOB_PERIOD Allow metachars to match leading periods.GLOB_NO_DOTDIRS Make . and .. vanish from wildcards.GLOB_STAR Use glob ** to recurse directoriesGLOB_QUOTE source compatibilityFNM_NOMATCH Match failed.FNM_NOSYS Function not implemented.FNM_NORES Out of resourcesFNM_NOESCAPE Disable backslash escaping.FNM_PATHNAME Slash must be matched by slash.FNM_PERIOD Period must be matched by period.FNM_CASEFOLD Pattern is matched case-insensitiveFNM_LEADING_DIR Ignore / after Imatch.FAQs
the most correct and second fastest glob implementation in JavaScript
We found that 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
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.