Support objectMode option in the TypeScript types (#178)

Co-authored-by: Sindre Sorhus <[email protected]>

Author: Purpzie

index.d.ts

@@ -1,11 +1,13 @@
-import {Options as FastGlobOptions} from 'fast-glob';
+import {Options as FastGlobOptions, Entry as FastGlobEntry} from 'fast-glob';
 
 declare namespace globby {
 	type ExpandDirectoriesOption =
 		| boolean
 		| readonly string[]
 		| {files?: readonly string[]; extensions?: readonly string[]};
 
+	type Entry = FastGlobEntry;
+
 	interface GlobbyOptions extends FastGlobOptions {
 		/**
 		If set to `true`, `globby` will automatically glob directories for you. If you define an `Array` it will only glob files that matches the patterns inside the `Array`. You can also define an `Object` with `files` and `extensions` like in the example below.
@@ -88,10 +90,13 @@ declare const globby: {
 	@param options - See the [`fast-glob` options](https://github.com/mrmlnc/fast-glob#options-3) in addition to the ones in this package.
 	@returns The matching paths.
 	*/
-	sync: (
+	sync: ((
+		patterns: string | readonly string[],
+		options: globby.GlobbyOptions & {objectMode: true}
+	) => globby.Entry[]) & ((
 		patterns: string | readonly string[],
 		options?: globby.GlobbyOptions
-	) => string[];
+	) => string[]);
 
 	/**
 	Find files and directories using glob patterns.
@@ -146,6 +151,11 @@ declare const globby: {
 
 	readonly gitignore: Gitignore;
 
+	(
+		patterns: string | readonly string[],
+		options: globby.GlobbyOptions & {objectMode: true}
+	): Promise<globby.Entry[]>;
+
 	/**
 	Find files and directories using glob patterns.
 

index.test-d.ts

@@ -28,6 +28,7 @@ expectType<Promise<string[]>>(
 );
 expectType<Promise<string[]>>(globby('*.tmp', {gitignore: true}));
 expectType<Promise<string[]>>(globby('*.tmp', {ignore: ['**/b.tmp']}));
+expectType<Promise<globby.Entry[]>>(globby('*.tmp', {objectMode: true}));
 
 // Globby (sync)
 expectType<string[]>(globbySync('*.tmp'));
@@ -45,6 +46,7 @@ expectType<string[]>(
 );
 expectType<string[]>(globbySync('*.tmp', {gitignore: true}));
 expectType<string[]>(globbySync('*.tmp', {ignore: ['**/b.tmp']}));
+expectType<globby.Entry[]>(globbySync('*.tmp', {objectMode: true}));
 
 // Globby (stream)
 expectType<NodeJS.ReadableStream>(globbyStream('*.tmp'));