hike

• • Cached#entries(pathname)
  • • Array

• • pathname
  • • String

  • Pathname to get files list for.

See Hike#entries for details.

• • Cached#find(logicalPaths[, options][, callback])
  • • String
    • undefined

• • logicalPaths
  • • String
    • Array

  • One or many (fallbacks) logical paths.

• • options
  • • Object

  • Options hash. See description below.

• • callback
  • • Function

  • Function to execute on each matching path. See description below.

See Hike#find for details.

• • Cached#stat(pathname)
  • • fs.Stats
    • undefined

• • pathname
  • • String

  • Pathname to get stats for.

See Hike#stat for details.

• • Cached#extensions
  • • Array

Returns array of registered lookup extensions.

• • Cached#paths
  • • Array

Returns array of registered lookup paths.

• • Cached#root
  • • String

Returns hike's root.

• • new Hike(root = ".")

• • root
  • • String

  • root path

A Hike accepts an optional root path that defaults to your current working directory. Any relative paths added to Hike#paths will be expanded relatively to the root.

• • Hike#appendExtensions(extensions)
  • • void

• • extensions
  • • Array

  • extensions to append

Appends extensions to the list of lookup extensions.

• • Hike#appendPaths(pathnames)
  • • void

• • pathnames
  • • Array

  • paths to append

Appends pathnames to the list of lookup paths.

• • Hike#entries(pathname)
  • • Array

• • pathname
  • • String

  • Pathname to get files list for.

ENOENT-aware wraper over fs.readdirSync that filters out . files and ~ swap files. Returns an empty Array if the directory does not exist.

• • Hike#find(logicalPaths[, options][, callback])
  • • String
    • undefined

• • logicalPaths
  • • String
    • Array

  • One or many (fallbacks) logical paths.

• • options
  • • Object

  • Options hash. See description below.

• • callback
  • • Function

  • Function to execute on each matching path. See description below.

Returns the expanded path for a logical path in the path collection.

trail = new Hike("/home/ixti/Projects/hike-js");

trail.appendExtensions([".js"]);
trail.appendPaths(["lib", "test"]);

trail.find("hike");
// -> "/home/ixti/Projects/hike-js/lib/hike.js"

trail.find("test_hike");
// -> "/home/ixti/Projects/hike-js/test/test_hike.js"

find accepts multiple fallback logical paths that returns the first match.

trail.find(["hike", "hike/index"]);

is equivalent to

trail.find("hike") || trail.find("hike/index");

Though find always returns the first match, it is possible to iterate over all shadowed matches and fallbacks by supplying a callback:

trail.find(["hike", "hike/index"], function (pathname) {
  console.warn(pathname);
});

This allows you to filter your matches by any condition.

trail.find("application", function (pathname) {
  if ("text/css" == mime_type_for(pathname)) {
    // stop iteration and return matched pathname
    return true;
  }
});

Options

• basePath (String): You can specify "alternative" base path to be used upon searching. Default: Hike#root.

Callback

Iterator that is called on each matching pathname.

It receives matching pathname and must return true-ish value in order to stop iteration and return given pathname as result of search.

Default:

function (pathname) { return true; }

• • Hike#prependExtensions(extensions)
  • • void

• • extensions
  • • Array

  • extensions to prepend

Prepends extensions to the list of lookup extensions.

• • Hike#prependPaths(pathnames)
  • • void

• • pathnames
  • • Array

  • paths to prepend

Prepends pathnames to the list of lookup paths.

• • Hike#removeExtension([extensions])
  • • Array

• • extensions
  • • Array

  • extensions to remove

Removes extensions from the list of lookup extensions. If no extensions given (or an empty array), then all registered lookup extensions are removed.

Returns list of removed extensions.

• • Hike#removePath([pathnames])
  • • Array

• • pathnames
  • • Array

  • paths to remove

Removes pathnames from the list of lookup paths. If no pathnames given (or an empty array), then all registered lookup paths are removed.

Returns list of removed pathnames.

• • Hike#stat(pathname)
  • • fs.Stats
    • undefined

• • pathname
  • • String

  • Pathname to get stats for.

ENOENT-aware wraper over fs.statSync. Returns undefined if file does not exists.

• • Hike#cached
  • • Cached

A Cached is a cached Hike object that caches FS ops. If you are confident that you are not making changes the paths you are searching, cached version will avoid excess system calls.

var cached = trail.cached;

cached.find("hike/trail"); // hits FS
cached.find("hike/trail"); // returns cached result
cached.find("test_trail"); // hits FS

• • Hike#extensions
  • • Array

Returns array of registered lookup extensions.

• • Hike#paths
  • • Array

Returns array of registered lookup paths.

• • Hike#root
  • • String

Returns hike's root.