vfile utility to find files by searching the file system downwards.
This utility lets you find one or many files downwards.
You can use this utility if you want to find files in, say, a folder.
One example is all markdown files.
If you instead want to find files upwards, such as config files, you can use
vfile-find-up
.
This package is ESM only. In Node.js (version 16), install with npm:
npm install vfile-find-down
import {findDown} from 'vfile-find-down'
console.log(await findDown('.md'))
Yields:
VFile {
cwd: '/Users/tilde/Projects/oss/vfile-find-down',
data: {},
history: [ '/Users/tilde/Projects/oss/vfile-find-down/readme.md' ],
messages: []
}
This package exports the identifiers
findDown
and
findDownAll
.
There is no default export.
Find the first file or folder downwards.
๐ Note: files are not read (their
value
is not populated). useto-vfile
for that.
(test[, paths], callback) => undefined
(test[, paths]) => Promise<VFile>
test
(Test
) โ things to search forpaths
(Array<URL | string> | URL | string
, default:process.cwd()
) โ places to search fromcallback
(Callback
, optional) โ callback called when done
Nothing when callback
is given (undefined
), otherwise a promise that
resolves to a file (VFile
or undefined
).
Find files or folders downwards.
๐ Note: files are not read (their
value
is not populated). useto-vfile
for that.
(test[, paths], callback) => undefined
(test[, paths]) => Promise<Array<VFile>>
test
(Test
) โ things to search forpaths
(Array<URL | string> | URL | string
, default:process.cwd()
) โ places to search fromcallback
(CallbackAll
, optional) โ callback called when done
Nothing when callback
is given (undefined
), otherwise a promise that
resolves to files (Array<VFile>
).
Handle a file (TypeScript type).
How to handle this file (Result
, optional).
Callback called when done finding one file (TypeScript type).
error
(Error
orundefined
) โ error; errors are currently never passedfile
(VFile
orundefined
) โ file
Nothing (undefined
).
Callback called when done (TypeScript type).
error
(Error
orundefined
) โ error; errors are currently never passedfiles
(Array<VFile>
) โ files
Nothing (undefined
).
What to do when collecting a file or folder (TypeScript type).
break
(boolean
, default:false
) โ stop searching after this file or folderinclude
(boolean
, default:false
) โ include this file or folderskip
(boolean
, default:false
) โ do not search inside this folder
Things to search for (TypeScript type).
For strings, the basename
or extname
of files must match them and
hidden folders and node_modules
will not be searched.
For arrays, any test in them must match.
type Test = Array<Assert | string> | Assert | string
This package is fully typed with TypeScript.
It exports the additional types
Assert
,
Callback
,
CallbackAll
,
Result
, and
Test
.
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, vfile-find-down@^7
,
compatible with Node.js 16.
See contributing.md
in vfile/.github
for ways to
get started.
See support.md
for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
MIT ยฉ Titus Wormer