11
11
12
12
## Contents
13
13
14
- * [ What is this?] ( #what-is-this )
15
- * [ When should I use this?] ( #when-should-i-use-this )
16
- * [ Install] ( #install )
17
- * [ Use] ( #use )
18
- * [ API] ( #api )
19
- * [ ` findDown(test[, paths][, callback]) ` ] ( #finddowntest-paths-callback )
20
- * [ ` findDownAll(test[, paths][, callback]) ` ] ( #finddownalltest-paths-callback )
21
- * [ ` Assert ` ] ( #assert )
22
- * [ ` Callback ` ] ( #callback )
23
- * [ ` CallbackAll ` ] ( #callbackall )
24
- * [ ` Result ` ] ( #result )
25
- * [ ` Test ` ] ( #test )
26
- * [ Types] ( #types )
27
- * [ Compatibility] ( #compatibility )
28
- * [ Contribute] ( #contribute )
29
- * [ License] ( #license )
14
+ * [ What is this?] ( #what-is-this )
15
+ * [ When should I use this?] ( #when-should-i-use-this )
16
+ * [ Install] ( #install )
17
+ * [ Use] ( #use )
18
+ * [ API] ( #api )
19
+ * [ ` findDown(test[, paths][, callback]) ` ] ( #finddowntest-paths-callback )
20
+ * [ ` findDownAll(test[, paths][, callback]) ` ] ( #finddownalltest-paths-callback )
21
+ * [ ` Assert ` ] ( #assert )
22
+ * [ ` Callback ` ] ( #callback )
23
+ * [ ` CallbackAll ` ] ( #callbackall )
24
+ * [ ` Result ` ] ( #result )
25
+ * [ ` Test ` ] ( #test )
26
+ * [ Types] ( #types )
27
+ * [ Compatibility] ( #compatibility )
28
+ * [ Contribute] ( #contribute )
29
+ * [ License] ( #license )
30
30
31
31
## What is this?
32
32
@@ -83,17 +83,17 @@ Find the first file or folder downwards.
83
83
84
84
###### Signatures
85
85
86
- * ` (test[, paths], callback) => undefined `
87
- * ` (test[, paths]) => Promise<VFile> `
86
+ * ` (test[, paths], callback) => undefined `
87
+ * ` (test[, paths]) => Promise<VFile> `
88
88
89
89
###### Parameters
90
90
91
- * ` test ` ([ ` Test ` ] [ api-test ] )
92
- — things to search for
93
- * ` paths ` (` Array<URL | string> | URL | string ` , default: ` process.cwd() ` )
94
- — places to search from
95
- * ` callback ` ([ ` Callback ` ] [ api-callback ] , optional)
96
- — callback called when done
91
+ * ` test ` ([ ` Test ` ] [ api-test ] )
92
+ — things to search for
93
+ * ` paths ` (` Array<URL | string> | URL | string ` , default: ` process.cwd() ` )
94
+ — places to search from
95
+ * ` callback ` ([ ` Callback ` ] [ api-callback ] , optional)
96
+ — callback called when done
97
97
98
98
###### Returns
99
99
@@ -109,17 +109,17 @@ Find files or folders downwards.
109
109
110
110
###### Signatures
111
111
112
- * ` (test[, paths], callback) => undefined `
113
- * ` (test[, paths]) => Promise<Array<VFile>> `
112
+ * ` (test[, paths], callback) => undefined `
113
+ * ` (test[, paths]) => Promise<Array<VFile>> `
114
114
115
115
###### Parameters
116
116
117
- * ` test ` ([ ` Test ` ] [ api-test ] )
118
- — things to search for
119
- * ` paths ` (` Array<URL | string> | URL | string ` , default: ` process.cwd() ` )
120
- — places to search from
121
- * ` callback ` ([ ` CallbackAll ` ] [ api-callback-all ] , optional)
122
- — callback called when done
117
+ * ` test ` ([ ` Test ` ] [ api-test ] )
118
+ — things to search for
119
+ * ` paths ` (` Array<URL | string> | URL | string ` , default: ` process.cwd() ` )
120
+ — places to search from
121
+ * ` callback ` ([ ` CallbackAll ` ] [ api-callback-all ] , optional)
122
+ — callback called when done
123
123
124
124
###### Returns
125
125
@@ -132,10 +132,10 @@ Handle a file (TypeScript type).
132
132
133
133
###### Parameters
134
134
135
- * ` file ` ([ ` VFile ` ] [ vfile ] )
136
- — file to handle
137
- * ` stats ` ([ ` Stats ` ] [ stats ] )
138
- — stats from ` fs.stat `
135
+ * ` file ` ([ ` VFile ` ] [ vfile ] )
136
+ — file to handle
137
+ * ` stats ` ([ ` Stats ` ] [ stats ] )
138
+ — stats from ` fs.stat `
139
139
140
140
###### Returns
141
141
@@ -147,10 +147,10 @@ Callback called when done finding one file (TypeScript type).
147
147
148
148
###### Parameters
149
149
150
- * ` error ` (` Error ` or ` undefined ` )
151
- — error; errors are currently never passed
152
- * ` file ` ([ ` VFile ` ] [ vfile ] or ` undefined ` )
153
- — file
150
+ * ` error ` (` Error ` or ` undefined ` )
151
+ — error; errors are currently never passed
152
+ * ` file ` ([ ` VFile ` ] [ vfile ] or ` undefined ` )
153
+ — file
154
154
155
155
###### Returns
156
156
@@ -162,10 +162,10 @@ Callback called when done (TypeScript type).
162
162
163
163
###### Parameters
164
164
165
- * ` error ` (` Error ` or ` undefined ` )
166
- — error; errors are currently never passed
167
- * ` files ` ([ ` Array<VFile> ` ] [ vfile ] )
168
- — files
165
+ * ` error ` (` Error ` or ` undefined ` )
166
+ — error; errors are currently never passed
167
+ * ` files ` ([ ` Array<VFile> ` ] [ vfile ] )
168
+ — files
169
169
170
170
###### Returns
171
171
@@ -177,12 +177,12 @@ What to do when collecting a file or folder (TypeScript type).
177
177
178
178
###### Fields
179
179
180
- * ` break ` (` boolean ` , default: ` false ` )
181
- — stop searching after this file or folder
182
- * ` include ` (` boolean ` , default: ` false ` )
183
- — include this file or folder
184
- * ` skip ` (` boolean ` , default: ` false ` )
185
- — do not search inside this folder
180
+ * ` break ` (` boolean ` , default: ` false ` )
181
+ — stop searching after this file or folder
182
+ * ` include ` (` boolean ` , default: ` false ` )
183
+ — include this file or folder
184
+ * ` skip ` (` boolean ` , default: ` false ` )
185
+ — do not search inside this folder
186
186
187
187
### ` Test `
188
188
0 commit comments