Question 1

How do I use find-up to find the nearest package.json file?

Accepted Answer

Use findUp('package.json') starting from the current directory; it will traverse upward until it finds the file or reaches the root. For multiple matches, use findUpMultiple with a limit option.

Question 2

What's the difference between find-up and node-glob for searching files?

Accepted Answer

find-up is optimized for traversing directory hierarchies (up or down) with precise control, while node-glob focuses on pattern matching across directories without built-in traversal logic. Use find-up for config file discovery and node-glob for batch file matching.

Question 3

Can find-up handle symbolic links in the search?

Accepted Answer

Yes, it includes an allowSymlinks option (default true) to control whether symbolic links are considered matches, as specified in the options section for both findUp and findDown functions.

Question 4

How to limit the number of matches in find-up?

Accepted Answer

Use the limit option with findUpMultiple or findUpMultipleSync to restrict results; for example, setting limit: 5 returns only the first five matches, preventing excessive output in large searches.

Question 5

Is there a way to stop the search early with find-up?

Accepted Answer

Yes, return the findUpStop symbol from a custom matcher function to halt traversal immediately, which is useful for performance optimization in deeply nested directories.

Question 6

How does find-up compare to using fs.readdir recursively?

Accepted Answer

find-up abstracts recursive traversal with optimized algorithms and options like breadth-first or depth-first search, reducing boilerplate code compared to manual fs.readdir implementations for file discovery.

Question 7

Can find-up search for directories as well as files?

Accepted Answer

Yes, set the type option to 'directory' or 'both' in the options object; for example, findUp('.git', {type: 'both'}) can match either a file or directory named .git, useful for submodules.

find-up

What is find-up?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions