Home Reference Source Repository

Function

Static Public Summary
public

getPaths(filePath: string): array

Get recursively climbing paths.

public

lookup(file: string, options: object, callback: lookedupAbsolutePath)

lookup climbing recursively file like a require.

public

lookupSync(file: string, options: object): string

Synchronous version of lookup

Static Public

public getPaths(filePath: string): array source

import {getPaths} from 'climb-lookup/src/index.js'

Get recursively climbing paths.

Params:

NameTypeAttributeDescription
filePath string

base path

Return:

array

paths - an abosolute file paths from filePath to root

public lookup(file: string, options: object, callback: lookedupAbsolutePath) source

import {lookup} from 'climb-lookup/src/index.js'

lookup climbing recursively file like a require.

Params:

NameTypeAttributeDescription
file string

lookup file name

options object
  • optional
options.cwd object
  • optional
  • default: process.cwd()

begin path

options.mode object
  • optional
  • default: null

pass to fs.accessSync as 2nd argument

callback lookedupAbsolutePath

public lookupSync(file: string, options: object): string source

import {lookupSync} from 'climb-lookup/src/index.js'

Synchronous version of lookup

Params:

NameTypeAttributeDescription
file string

lookup file name

options object
  • optional
options.cwd object
  • optional
  • default: process.cwd()

begin path

options.mode object
  • optional
  • default: null

pass to fs.accessSync as 2nd argument

Return:

string

lookedupPath - a found absolute file path

Throw:

*

if no such paths