aboutsummaryrefslogtreecommitdiff
path: root/node_modules/dir-glob/readme.md
diff options
context:
space:
mode:
authorMinteck <nekostarfan@gmail.com>2021-08-24 14:41:48 +0200
committerMinteck <nekostarfan@gmail.com>2021-08-24 14:41:48 +0200
commitd25e11bee6ca5ca523884da132d18e1400e077b9 (patch)
tree8af39fde19f7ed640a60fb397c7edd647dff1c4c /node_modules/dir-glob/readme.md
downloadkartik-iridium-d25e11bee6ca5ca523884da132d18e1400e077b9.tar.gz
kartik-iridium-d25e11bee6ca5ca523884da132d18e1400e077b9.tar.bz2
kartik-iridium-d25e11bee6ca5ca523884da132d18e1400e077b9.zip
Initial commit
Diffstat (limited to 'node_modules/dir-glob/readme.md')
-rw-r--r--node_modules/dir-glob/readme.md76
1 files changed, 76 insertions, 0 deletions
diff --git a/node_modules/dir-glob/readme.md b/node_modules/dir-glob/readme.md
new file mode 100644
index 0000000..cb7313f
--- /dev/null
+++ b/node_modules/dir-glob/readme.md
@@ -0,0 +1,76 @@
+# dir-glob [![Build Status](https://travis-ci.org/kevva/dir-glob.svg?branch=master)](https://travis-ci.org/kevva/dir-glob)
+
+> Convert directories to glob compatible strings
+
+
+## Install
+
+```
+$ npm install dir-glob
+```
+
+
+## Usage
+
+```js
+const dirGlob = require('dir-glob');
+
+(async () => {
+ console.log(await dirGlob(['index.js', 'test.js', 'fixtures']));
+ //=> ['index.js', 'test.js', 'fixtures/**']
+
+ console.log(await dirGlob(['index.js', 'inner_folder'], {cwd: 'fixtures'}));
+ //=> ['index.js', 'inner_folder/**']
+
+ console.log(await dirGlob(['lib/**', 'fixtures'], {
+ files: ['test', 'unicorn']
+ extensions: ['js']
+ }));
+ //=> ['lib/**', 'fixtures/**/test.js', 'fixtures/**/unicorn.js']
+
+ console.log(await dirGlob(['lib/**', 'fixtures'], {
+ files: ['test', 'unicorn', '*.jsx'],
+ extensions: ['js', 'png']
+ }));
+ //=> ['lib/**', 'fixtures/**/test.{js,png}', 'fixtures/**/unicorn.{js,png}', 'fixtures/**/*.jsx']
+})();
+```
+
+
+## API
+
+### dirGlob(input, options?)
+
+Returns a `Promise<string[]>` with globs.
+
+### dirGlob.sync(input, options?)
+
+Returns a `string[]` with globs.
+
+#### input
+
+Type: `string | string[]`
+
+Paths.
+
+#### options
+
+Type: `object`
+
+##### extensions
+
+Type: `string[]`
+
+Append extensions to the end of your globs.
+
+##### files
+
+Type: `string[]`
+
+Only glob for certain files.
+
+##### cwd
+
+Type: `string[]`
+
+Test in specific directory.