Various TypeScript type tweaks

Author: sindresorhus

index.d.ts

@@ -1,7 +1,11 @@
-import * as locatePath from 'locate-path';
+import {Options as LocatePathOptions} from 'locate-path';
+
+declare const stop: unique symbol;
 
 declare namespace findUp {
-	interface Options {
+	interface Options extends LocatePathOptions {}
+
+	interface MatcherOptions {
 		/**
 		Directory to start from.
 
@@ -10,7 +14,9 @@ declare namespace findUp {
 		readonly cwd?: string;
 	}
 
-	type Match = string | symbol | undefined;
+	type StopSymbol = typeof stop;
+
+	type Match = string | StopSymbol | undefined;
 }
 
 declare const findUp: {
@@ -43,36 +49,36 @@ declare const findUp: {
 	})();
 	```
 	*/
-	(name: string | string[], options?: locatePath.AsyncOptions): Promise<string | undefined>;
+	(name: string | string[], options?: findUp.Options): Promise<string | undefined>;
 
 	/**
 	Find a file or directory by walking up parent directories.
 
 	@param matcher - Called for each directory in the search. Return a path or `findUp.stop` to stop the search.
 	@returns The first path found or `undefined` if none could be found.
 	*/
-	(matcher: (directory: string) => (findUp.Match | Promise<findUp.Match>), options?: findUp.Options): Promise<string | undefined>;
+	(matcher: (directory: string) => (findUp.Match | Promise<findUp.Match>), options?: findUp.MatcherOptions): Promise<string | undefined>;
 
 	/**
 	Synchronously find a file or directory by walking up parent directories.
 
 	@param name - Name of the file or directory to find. Can be multiple.
 	@returns The first path found (by respecting the order of `name`s) or `undefined` if none could be found.
 	*/
-	sync(name: string | string[], options?: locatePath.Options): string | undefined;
+	sync(name: string | string[], options?: findUp.Options): string | undefined;
 
 	/**
 	Synchronously find a file or directory by walking up parent directories.
 
 	@param matcher - Called for each directory in the search. Return a path or `findUp.stop` to stop the search.
 	@returns The first path found or `undefined` if none could be found.
 	*/
-	sync(matcher: (directory: string) => findUp.Match, options?: findUp.Options): string | undefined;
+	sync(matcher: (directory: string) => findUp.Match, options?: findUp.MatcherOptions): string | undefined;
 
 	/**
 	Return this in a `matcher` function to stop the search and force `findUp` to immediately return `undefined`.
 	*/
-	readonly stop: unique symbol;
+	readonly stop: findUp.StopSymbol;
 };
 
 export = findUp;

index.js

@@ -8,10 +8,13 @@ module.exports = async (name, options = {}) => {
 	let directory = path.resolve(options.cwd || '');
 	const {root} = path.parse(directory);
 	const paths = [].concat(name);
+
 	// eslint-disable-next-line no-constant-condition
 	while (true) {
 		// eslint-disable-next-line no-await-in-loop
-		const foundPath = await (typeof name === 'function' ? name(directory) : locatePath(paths, {...options, cwd: directory}));
+		const foundPath = await (typeof name === 'function' ?
+			name(directory) :
+			locatePath(paths, {...options, cwd: directory}));
 
 		if (foundPath === stop) {
 			return;
@@ -36,7 +39,9 @@ module.exports.sync = (name, options = {}) => {
 
 	// eslint-disable-next-line no-constant-condition
 	while (true) {
-		const foundPath = typeof name === 'function' ? name(directory) : locatePath.sync(paths, {...options, cwd: directory});
+		const foundPath = typeof name === 'function' ?
+			name(directory) :
+			locatePath.sync(paths, {...options, cwd: directory});
 
 		if (foundPath === stop) {
 			return;

index.test-d.ts

@@ -1,4 +1,4 @@
-import {expectType} from 'tsd';
+import {expectType, expectError} from 'tsd';
 import findUp = require('.');
 
 expectType<Promise<string | undefined>>(findUp('unicorn.png'));
@@ -9,19 +9,20 @@ expectType<Promise<string | undefined>>(findUp(['rainbow.png', 'unicorn.png'], {
 expectType<Promise<string | undefined>>(findUp(['rainbow.png', 'unicorn.png'], {allowSymlinks: false}));
 expectType<Promise<string | undefined>>(findUp(['rainbow.png', 'unicorn.png'], {type: 'file'}));
 expectType<Promise<string | undefined>>(findUp(['rainbow.png', 'unicorn.png'], {type: 'directory'}));
+expectError(findUp(['rainbow.png', 'unicorn.png'], {concurrency: 1}))
 
 expectType<Promise<string | undefined>>(findUp(() => 'unicorn.png'));
 expectType<Promise<string | undefined>>(findUp(() => 'unicorn.png', {cwd: ''}));
 expectType<Promise<string | undefined>>(findUp(() => undefined));
 expectType<Promise<string | undefined>>(findUp(() => undefined, {cwd: ''}));
-expectType<Promise<string | undefined>>(findUp(() => findUp.stop));
-expectType<Promise<string | undefined>>(findUp(() => findUp.stop, {cwd: ''}));
+expectType<Promise<string | undefined>>(findUp((): findUp.StopSymbol => findUp.stop));
+expectType<Promise<string | undefined>>(findUp((): findUp.StopSymbol => findUp.stop, {cwd: ''}));
 expectType<Promise<string | undefined>>(findUp(async () => 'unicorn.png'));
 expectType<Promise<string | undefined>>(findUp(async () => 'unicorn.png', {cwd: ''}));
 expectType<Promise<string | undefined>>(findUp(async () => undefined));
 expectType<Promise<string | undefined>>(findUp(async () => undefined, {cwd: ''}));
-expectType<Promise<string | undefined>>(findUp(async () => findUp.stop));
-expectType<Promise<string | undefined>>(findUp(async () => findUp.stop, {cwd: ''}));
+expectType<Promise<string | undefined>>(findUp(async (): Promise<findUp.StopSymbol> => findUp.stop));
+expectType<Promise<string | undefined>>(findUp(async (): Promise<findUp.StopSymbol> => findUp.stop, {cwd: ''}));
 
 expectType<string | undefined>(findUp.sync('unicorn.png'));
 expectType<string | undefined>(findUp.sync('unicorn.png', {cwd: ''}));
@@ -36,7 +37,7 @@ expectType<string | undefined>(findUp.sync(() => 'unicorn.png'));
 expectType<string | undefined>(findUp.sync(() => 'unicorn.png', {cwd: ''}));
 expectType<string | undefined>(findUp.sync(() => undefined));
 expectType<string | undefined>(findUp.sync(() => undefined, {cwd: ''}));
-expectType<string | undefined>(findUp.sync(() => findUp.stop));
-expectType<string | undefined>(findUp.sync(() => findUp.stop, {cwd: ''}));
+expectType<string | undefined>(findUp.sync((): findUp.StopSymbol => findUp.stop));
+expectType<string | undefined>(findUp.sync((): findUp.StopSymbol => findUp.stop, {cwd: ''}));
 
 expectType<Symbol>(findUp.stop);