fast-fs-hash - v0.0.0-rc4
    Preparing search index...

    Interface ProjectRoot

    Result of findProjectRoot / findProjectRootSync.

    Every field is independently populated as the walker climbs the parent chain from the start path. A field is null when its marker was not found before the walk hit a stop boundary (filesystem root, user home, enclosing .git, or the depth cap of 128).

    interface ProjectRoot {
        gitRoot: string | null;
        gitSuperRoot: string | null;
        nearestNodeModules: string | null;
        nearestPackageJson: string | null;
        nearestTsconfigJson: string | null;
        rootNodeModules: string | null;
        rootPackageJson: string | null;
        rootTsconfigJson: string | null;
    }
    Index

    Properties

    gitRoot gitSuperRoot nearestNodeModules nearestPackageJson nearestTsconfigJson rootNodeModules rootPackageJson rootTsconfigJson

    Properties

    gitRoot: string | null

    Innermost directory containing a .git (directory OR file). Matches git rev-parse --show-toplevel.

    gitSuperRoot: string | null

    Outermost directory containing a .git directory. null when not inside a submodule/worktree.

    nearestNodeModules: string | null

    First node_modules/ directory encountered walking up.

    nearestPackageJson: string | null

    First package.json encountered walking up from the start path.

    nearestTsconfigJson: string | null

    First tsconfig.json encountered walking up from the start path.

    rootNodeModules: string | null

    Last node_modules/ walking up, bounded by gitRoot.

    rootPackageJson: string | null

    Last package.json walking up, bounded by gitRoot (does not cross into a superproject).

    rootTsconfigJson: string | null

    Last tsconfig.json walking up, bounded by gitRoot.

    Settings

    Member Visibility

    On This Page

    Properties