@types/find-root

What is @types/find-root?

@types/find-root is a TypeScript type definition package for the find-root library. The find-root library is used to find the root directory of a project by looking for a specific file (usually package.json) in the current directory or its ancestors.

What are @types/find-root's main functionalities?

Find the root directory of a project

This feature allows you to find the root directory of a project by searching for a specific file (default is package.json) starting from the current directory and moving up the directory tree.

const findRoot = require('find-root');
const root = findRoot(__dirname);
console.log(root);

Find the root directory with a custom file

This feature allows you to find the root directory of a project by searching for a custom file instead of the default package.json.

const findRoot = require('find-root');
const root = findRoot(__dirname, (dir) => require('fs').existsSync(require('path').join(dir, 'custom-file.txt')));
console.log(root);

Other packages similar to @types/find-root

find-up

The find-up package is used to find a file or directory by walking up parent directories. It is more flexible than find-root as it allows you to specify the file or directory to find and provides more options for customization.

pkg-up

The pkg-up package is specifically designed to find the nearest package.json file by walking up parent directories. It is similar to find-root but is more focused on finding package.json files only.

find-node-modules

The find-node-modules package is used to find all node_modules directories in a project. It is different from find-root as it focuses on locating node_modules directories rather than the root directory of a project.

README

Installation

npm install --save @types/find-root

Summary

This package contains type definitions for find-root (https://github.com/js-n/find-root).

Details

Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/find-root

Additional Details

• Last updated: Fri, 23 Mar 2018 22:51:43 GMT
• Dependencies: node
• Global values: none

Credits

These definitions were written by Arturas Molcanovas https://github.com/Alorel.