npm.io
5.1.2 • Published 4 months ago

walk-back

Licence
MIT
Version
5.1.2
Deps
0
Size
8 kB
Vulns
0
Weekly
0
Stars
17

view on npm npm module downloads Gihub repo dependents Gihub package dependents Node.js CI

walk-back

Walk up the directory tree until the specified path is found. For example, starting from the current directory, you might want to walk up the directory tree until a specified config file is found.

Example

import walkBack from 'walk-back'

walkBack(startAt, lookingFor) ⇒ string

Returns an absolute file path (if found) else null.

Kind: Exported function

Param Type Description
startAt string the directory to start in
lookingFor string the path we're looking for

Example

> walkBack('/Users/lloyd/Documents/75lb/walk-back', 'package.json')
'/Users/lloyd/Documents/75lb/walk-back/package.json'

> walkBack('/Users/lloyd/Documents/75lb/walk-back', '75lb')
'/Users/lloyd/Documents/75lb'

> walkBack('/Users/lloyd/Documents/75lb/walk-back', '.bash_profile')
'/Users/lloyd/.bash_profile'

> walkBack('.', '.bash_profile')
'/Users/lloyd/.bash_profile'

> walkBack('/Users/lloyd/Documents/75lb/walk-back', 'non-existent.file')
null

2015-26 Lloyd Brookes <opensource@75lb.com>.

Tested by test-runner. Documented by jsdoc-to-markdown.

Keywords