vfile-find-up
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatvfile utility to find files by searching the file system upwards.
Contents
* [`findUp(test[, path][, callback])`](#finduptest-path-callback)
* [`findUpAll(test[, path][, callback])`](#findupalltest-path-callback)
* [`Assert`](#assert)
* [`Callback`](#callback)
* [`CallbackAll`](#callbackall)
* [`Result`](#result)
* [`Test`](#test)
What is this?
This utility lets you find one or many files upwards.When should I use this?
You can use this utility if you want to find, say, a config file. If you instead want to find files downwards, such as all markdown files in a folder, you can usevfile-find-down
vfile-find-down.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install vfile-find-up
Use
import {findUp} from 'vfile-find-up'
console.log(await findUp('package.json'))
Yields:
VFile {
cwd: '/Users/tilde/Projects/oss/vfile-find-up',
data: {},
history: [ '/Users/tilde/Projects/oss/vfile-find-up/package.json' ],
messages: []
}
API
This package exports the identifiersfindUp
api-find-up and
findUpAll
api-find-up-all.
There is no default export.findUp(test[, path][, callback])
Find the first file or folder upwards.👉 Note: files are not read (theirvalue
is not populated). useto-vfile
to-vfile for that.
Signatures
(test[, path], callback) => undefined
(test[, path]) => Promise<VFile>
Parameters
— things to search for
path
(URL
orstring
, default:process.cwd()
)
— place to search from
callback
(Callback
api-callback, optional)
— callback called when done
Returns
Nothing whencallback
is given (undefined
), otherwise a promise that
resolves to a file (VFile | undefined
vfile).findUpAll(test[, path][, callback])
Find files or folders upwards.👉 Note: files are not read (theirvalue
is not populated). useto-vfile
to-vfile for that.
Signatures
(test[, path], callback) => undefined
(test[, path]) => Promise<Array<VFile>>
Parameters
— things to search for
paths
(URL
orstring
, default:process.cwd()
)
— place to search from
callback
(CallbackAll
api-callback-all, optional)
— callback called when done
Returns
Nothing whencallback
is given (undefined
), otherwise a promise that
resolves to files (Array<VFile>
vfile).Assert
Handle a file (TypeScript type).Parameters
— file to handle
Returns
How to handle this file (Result
api-result, optional).Callback
Callback called when done finding one file (TypeScript type).Parameters
error
(Error | undefined
)
— error; errors are currently never passed
file
(VFile | undefined
vfile)
— file
Returns
Nothing (undefined
).CallbackAll
Callback called when done (TypeScript type).Parameters
error
(Error | undefined
)
— error; errors are currently never passed
files
(Array<VFile>
vfile)
— files
Returns
Nothing (undefined
).Result
What to do when collecting a file or folder (TypeScript type).Fields
break
(boolean
, default:false
)
— stop searching after this file or folder
include
(boolean
, default:false
)
— include this file or folder
Test
Things to search for (TypeScript type).For strings, the
basename
or extname
of files must match them.
For arrays, any test in them must match.Type
type Test = Array<Assert | string> | Assert | string
Types
This package is fully typed with TypeScript. It exports the additional typesAssert
api-assert,
Callback
api-callback,
CallbackAll
api-callback-all,
Result
api-result, and
Test
api-test.Compatibility
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-up@^7
,
compatible with Node.js 16.Contribute
Seecontributing.md
contributing in vfile/.github
health for ways to
get started.
See support.md
support for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.