Fix types for stats option

Fixes #139

Author: sindresorhus

index.d.ts

@@ -179,7 +179,7 @@ console.log(paths);
 */
 export function globby(
 	patterns: string | readonly string[],
-	options: Options & {objectMode: true}
+	options: Options & ({objectMode: true} | {stats: true})
 ): Promise<GlobEntry[]>;
 export function globby(
 	patterns: string | readonly string[],
@@ -197,7 +197,7 @@ Note that glob patterns can only contain forward-slashes, not backward-slashes,
 */
 export function globbySync(
 	patterns: string | readonly string[],
-	options: Options & {objectMode: true}
+	options: Options & ({objectMode: true} | {stats: true})
 ): GlobEntry[];
 export function globbySync(
 	patterns: string | readonly string[],
@@ -224,7 +224,7 @@ for await (const path of globbyStream('*.tmp')) {
 */
 export function globbyStream(
 	patterns: string | readonly string[],
-	options: Options & {objectMode: true}
+	options: Options & ({objectMode: true} | {stats: true})
 ): GlobbyEntryStream;
 export function globbyStream(
 	patterns: string | readonly string[],

index.test-d.ts

@@ -33,6 +33,7 @@ expectType<Promise<string[]>>(globby('*.tmp', {
 expectType<Promise<string[]>>(globby('*.tmp', {gitignore: true}));
 expectType<Promise<string[]>>(globby('*.tmp', {ignore: ['**/b.tmp']}));
 expectType<Promise<GlobEntry[]>>(globby('*.tmp', {objectMode: true}));
+expectType<Promise<GlobEntry[]>>(globby('*.tmp', {stats: true}));
 
 // Globby (sync)
 expectType<string[]>(globbySync('*.tmp'));
@@ -49,6 +50,7 @@ expectType<string[]>(globbySync('*.tmp', {
 expectType<string[]>(globbySync('*.tmp', {gitignore: true}));
 expectType<string[]>(globbySync('*.tmp', {ignore: ['**/b.tmp']}));
 expectType<GlobEntry[]>(globbySync('*.tmp', {objectMode: true}));
+expectType<GlobEntry[]>(globbySync('*.tmp', {stats: true}));
 
 // Globby (stream)
 expectType<GlobbyStream>(globbyStream('*.tmp'));
@@ -65,7 +67,9 @@ expectType<GlobbyStream>(globbyStream('*.tmp', {
 expectType<GlobbyStream>(globbyStream('*.tmp', {gitignore: true}));
 expectType<GlobbyStream>(globbyStream('*.tmp', {ignore: ['**/b.tmp']}));
 expectType<GlobbyEntryStream>(globbyStream('*.tmp', {objectMode: true}));
+expectType<GlobbyEntryStream>(globbyStream('*.tmp', {stats: true}));
 expectType<GlobbyEntryStream>(globbyStream('*.tmp', {objectMode: true, gitignore: true}));
+expectType<GlobbyEntryStream>(globbyStream('*.tmp', {stats: true, gitignore: true}));
 
 // eslint-disable-next-line unicorn/prefer-top-level-await
 (async () => {
@@ -88,6 +92,16 @@ expectType<GlobbyEntryStream>(globbyStream('*.tmp', {objectMode: true, gitignore
 	expectType<GlobEntry[]>(streamResult);
 })();
 
+// eslint-disable-next-line unicorn/prefer-top-level-await
+(async () => {
+	const streamResult = [];
+	for await (const entry of globbyStream('*.tmp', {stats: true})) {
+		streamResult.push(entry);
+	}
+
+	expectType<GlobEntry[]>(streamResult);
+})();
+
 // GenerateGlobTasks
 expectType<Promise<GlobTask[]>>(generateGlobTasks('*.tmp'));
 expectType<Promise<GlobTask[]>>(generateGlobTasks(['a.tmp', '*.tmp', '!{c,d,e}.tmp']));

tests/globby.js

@@ -743,6 +743,27 @@ test('unique when using objectMode option', async t => {
 	t.true(isUnique(result.map(({path}) => path)));
 });
 
+test('stats option returns Entry objects with stats', async t => {
+	const result = await runGlobby(t, '*.tmp', {cwd, stats: true});
+	t.true(result.length > 0);
+	for (const entry of result) {
+		t.truthy(entry.path);
+		t.truthy(entry.name);
+		// Note: stats property exists but is filtered out in stabilizeResult for testing
+	}
+});
+
+test('gitignore option and stats option', async t => {
+	const result = await runGlobby(t, 'fixtures/gitignore/*', {gitignore: true, stats: true});
+	t.is(result.length, 1);
+	t.truthy(result[0].path);
+});
+
+test('unique when using stats option', async t => {
+	const result = await runGlobby(t, ['a.tmp', '*.tmp'], {cwd, stats: true});
+	t.true(isUnique(result.map(({path}) => path)));
+});
+
 // Known limitation: ** in parentheses doesn't work (fast-glob #484)
 test.failing('** inside parentheses', async t => {
 	const testDir = temporaryDirectory();