address review issue: document stopAt option in ts doc

sindresorhus · Sep 20, 2021 · c2134ed · c2134ed
1 parent d2a1b0d
commit c2134ed
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/index.d.ts b/index.d.ts
@@ -8,7 +8,14 @@ export const findUpStop: unique symbol;
 
 export type Match = string | typeof findUpStop | undefined;
 
-export type Options = LocatePathOptions & {stopAt?: string};
+export interface Options extends LocatePathOptions {
+	/**
+	The path to the directory to stop the search before reaching root if there were no matches before the `stopAt` directory.
+
+	@default path.parse(cwd).root
+	*/
+	readonly stopAt?: string;
+}
 
 /**
 Find a file or directory by walking up parent directories.