feat: infer type of the output values

mrmlnc · Jun 9, 2019 · 09f0107 · 09f0107
1 parent a505273
commit 09f0107
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -4,11 +4,17 @@ import Provider from './providers/provider';
 import ProviderStream from './providers/stream';
 import ProviderSync from './providers/sync';
 import Settings, { Options } from './settings';
-import { EntryItem, Pattern } from './types/index';
+import { Entry, EntryItem, Pattern } from './types/index';
 import * as utils from './utils/index';
 
 type Task = taskManager.Task;
 
+type EntryObjectModePredicate = { [P in keyof Pick<Options, 'objectMode'>]-?: true };
+type EntryStatsPredicate = { [P in keyof Pick<Options, 'stats'>]-?: true };
+type EntryObjectPredicate = EntryObjectModePredicate | EntryStatsPredicate;
+
+function sync(source: Pattern | Pattern[], options: Options & EntryObjectPredicate): Entry[];
+function sync(source: Pattern | Pattern[], options?: Options): string[];
 function sync(source: Pattern | Pattern[], options?: Options): EntryItem[] {
 	assertPatternsInput(source);
 
@@ -17,6 +23,8 @@ function sync(source: Pattern | Pattern[], options?: Options): EntryItem[] {
 	return utils.array.flatten(works);
 }
 
+function async(source: Pattern | Pattern[], options: Options & EntryObjectPredicate): Promise<Entry[]>;
+function async(source: Pattern | Pattern[], options?: Options): Promise<string[]>;
 function async(source: Pattern | Pattern[], options?: Options): Promise<EntryItem[]> {
 	try {
 		assertPatternsInput(source);

diff --git a/src/tests/smoke/smoke.ts b/src/tests/smoke/smoke.ts
@@ -160,5 +160,5 @@ function getFastGlobEntries(pattern: Pattern, ignore?: Pattern, cwd?: string, op
 		...opts
 	};
 
-	return fg.sync(pattern, options).sort() as string[];
+	return fg.sync(pattern, options).sort();
 }