Blame view

node_modules/dir-glob/readme.md 1.27 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
  # 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');
  
  dirGlob(['index.js', 'test.js', 'fixtures']).then(files => {
  	console.log(files);
  	//=> ['index.js', 'test.js', 'fixtures/**']
  });
  
  dirGlob(['lib/**', 'fixtures'], {
  	files: ['test', 'unicorn']
  	extensions: ['js']
  }).then(files => {
  	console.log(files);
  	//=> ['lib/**', 'fixtures/**/test.js', 'fixtures/**/unicorn.js']
  });
  
  dirGlob(['lib/**', 'fixtures'], {
  	files: ['test', 'unicorn', '*.jsx'],
  	extensions: ['js', 'png']
  }).then(files => {
  	console.log(files);
  	//=> ['lib/**', 'fixtures/**/test.{js,png}', 'fixtures/**/unicorn.{js,png}', 'fixtures/**/*.jsx']
  });
  ```
  
  
  ## API
  
  ### dirGlob(input, [options])
  
  Returns a `Promise` for an array of glob strings.
  
  ### dirGlob.sync(input, [options])
  
  Returns an array of glob strings.
  
  #### input
  
  Type: `Array` `string`
  
  A `string` or an `Array` of paths.
  
  #### options
  
  ##### extensions
  
  Type: `Array`
  
  Append extensions to the end of your globs.
  
  ##### files
  
  Type: `Array`
  
  Only glob for certain files.
  
  
  ## License
  
  MIT © [Kevin Mårtensson](https://github.com/kevva)