TypeScript: Add overload when ignoreSymbols and pathAsArray are t…

…rue (#100)

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>

index.d.ts

@@ -254,7 +254,20 @@ declare const onChange: {
 		options?: Options & {pathAsArray?: false}
 	): ObjectType;
 
-	// Overload that returns an Array as path when `pathAsArray` option is true.
+	// Overload that returns a string array as path when `ignoreSymbols` and `pathAsArray` options are true.
+	<ObjectType extends Record<string, any>>(
+		object: ObjectType,
+		onChange: (
+			this: ObjectType,
+			path: string[],
+			value: unknown,
+			previousValue: unknown,
+			applyData: ApplyData
+		) => void,
+		options: Options & {ignoreSymbols: true; pathAsArray: true}
+	): ObjectType;
+
+	// Overload that returns an array as path when `pathAsArray` option is true.
 	<ObjectType extends Record<string, any>>(
 		object: ObjectType,
 		onChange: (

index.test-d.ts

@@ -57,3 +57,14 @@ const watchedObjectPathAsString = onChange(object, function (path) {
 expectType<typeof object>(watchedObjectPathAsString);
 
 watchedObjectPathAsString.foo = true;
+
+const watchedObjectPathAsStringArray = onChange(object, function (path) {
+	expectType<typeof object>(this);
+	expectType<string[]>(path);
+}, {
+	ignoreSymbols: true,
+	pathAsArray: true,
+});
+expectType<typeof object>(watchedObjectPathAsStringArray);
+
+watchedObjectPathAsStringArray.foo = true;