Package - walk-back

walk-back

Walk up the directory tree until the specified path is found. For example, walk up through parent directories 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

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

Current Tags

5.1.1 ... latest (3 months ago)

walk-back

walkBack(startAt, lookingFor) ⇒ string ⏏

Current Tags

13 Versions

walkBack(startAt, lookingFor) ⇒ `string` ⏏