@types/find-project-root v1.1.4

Installation

npm install --save @types/find-project-root

Summary

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

Details

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

index.d.ts

// Type definitions for find-project-root 1.1
// Project: https://github.com/kirstein/find-project-root
// Definitions by: Ika <https://github.com/ikatyang>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/**
 * Finds the project root by custom markers
 */
declare function findProjectRoot(path: string, options?: findProjectRoot.Options): null | string;

declare namespace findProjectRoot {
    interface Options {
        /**
         * total number of levels the algorithm can traverse
         */
        maxDepth?: number | undefined;
        /**
         * markers that it will search for
         */
        markers?: string[] | undefined;
    }

    const MAX_DEPTH: 9;
    const MARKERS: [".git", ".hg"];
}

export = findProjectRoot;

Additional Details

• Last updated: Thu, 08 Jul 2021 12:01:37 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Ika.