TripSit

Archived

This repository has been archived on 2020-11-02. You can view files and clone it, but cannot push or open issues or pull requests.

History

cranberry ed23347e56 Initial comission of TheLounge base files		2020-11-01 22:46:04 +00:00
..
index.d.ts	Initial comission of TheLounge base files	2020-11-01 22:46:04 +00:00
index.js	Initial comission of TheLounge base files	2020-11-01 22:46:04 +00:00
license	Initial comission of TheLounge base files	2020-11-01 22:46:04 +00:00
package.json	Initial comission of TheLounge base files	2020-11-01 22:46:04 +00:00
readme.md	Initial comission of TheLounge base files	2020-11-01 22:46:04 +00:00

readme.md

find-up

Find a file or directory by walking up parent directories

Install

$ npm install find-up

Usage

/
└── Users
    └── sindresorhus
        ├── unicorn.png
        └── foo
            └── bar
                ├── baz
                └── example.js

example.js

const path = require('path');
const findUp = require('find-up');

(async () => {
    console.log(await findUp('unicorn.png'));
    //=> '/Users/sindresorhus/unicorn.png'

    console.log(await findUp(['rainbow.png', 'unicorn.png']));
    //=> '/Users/sindresorhus/unicorn.png'

    console.log(await findUp(async directory => {
        const hasUnicorns = await findUp.exists(path.join(directory, 'unicorn.png'));
        return hasUnicorns && directory;
    }, {type: 'directory'}));
    //=> '/Users/sindresorhus'
})();

API

findUp(name, options?)

findUp(matcher, options?)

Returns a Promise for either the path or undefined if it couldn’t be found.

findUp([…name], options?)

Returns a Promise for either the first path found (by respecting the order of the array) or undefined if none could be found.

findUp.sync(name, options?)

findUp.sync(matcher, options?)

Returns a path or undefined if it couldn’t be found.

findUp.sync([…name], options?)

Returns the first path found (by respecting the order of the array) or undefined if none could be found.

name

Type: string

Name of the file or directory to find.

matcher

Type: Function

A function that will be called with each directory until it returns a string with the path, which stops the search, or the root directory has been reached and nothing was found. Useful if you want to match files with certain patterns, set of permissions, or other advanced use-cases.

When using async mode, the matcher may optionally be an async or promise-returning function that returns the path.

options

Type: object

cwd

Type: string
Default: process.cwd()

Directory to start from.

type

Type: string
Default: 'file'
Values: 'file' 'directory'

The type of paths that can match.

allowSymlinks

Type: boolean
Default: true

Allow symbolic links to match if they point to the chosen path type.

findUp.exists(path)

Returns a Promise<boolean> of whether the path exists.

findUp.sync.exists(path)

Returns a boolean of whether the path exists.

path