Awesome
Promise version of glob
Match files using the patterns the shell uses, like stars and stuff.
[!IMPORTANT]
Glob has native Promise support as ofv9.0.0
, please use it directly. I will not issue a deprecation notice on this package, because I can't deal with the volume of angry tickets that will follow.
Install
npm install glob-promise glob
NOTE
glob
is set as a peerDependency
in package.json
npm
>= 7 will automatically installpeerDependencies
npm
<= 6 will not automatically installpeerDependencies
.
You will need to manually add glob
as a dependency to your project for glob-promise
to work.
API
glob(pattern [, options])
Alias for glob.promise
glob.promise(pattern [, options])
pattern: String
(glob pattern)
options: Object
or String
Return: Object
(Promise)
When it finishes, it will be fulfilled with an Array
of filenames as its first argument.
When it fails to read the files, it will be rejected with an error as its first argument.
glob('**/*')
.then(function(contents) {
contents; //=> ['lorem', 'ipsum', 'dolor']
});
glob('{foo,bar.baz}.txt', { nobrace: true })
.then(function(contents) {
contents; //=> []
});
glob.glob(pattern [, options], cb)
see
glob
glob.sync(pattern [, options])
see
glob.sync()
glob.hasMagic(pattern, [options])
see
glob.hasMagic()
Class: glob.Glob
see
Glob
options
The option object will be directly passed to glob.
Author: Ahmad Nassri • Twitter: @AhmadNassri