[types] Add missing string option type in toGamut

color-js · Sep 18, 2023 · 8eeae72 · 8eeae72
1 parent f225561
commit 8eeae72
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/src/toGamut.js b/src/toGamut.js
@@ -12,7 +12,7 @@ import getColor from "./getColor.js";
 /**
  * Force coordinates to be in gamut of a certain color space.
  * Mutates the color it is passed.
- * @param {Object} options
+ * @param {Object|string} options object or spaceId string
  * @param {string} options.method - How to force into gamut.
  *        If "clip", coordinates are just clipped to their reference range.
  *        If in the form [colorSpaceId].[coordName], that coordinate is reduced

diff --git a/types/src/toGamut.d.ts b/types/src/toGamut.d.ts
@@ -10,7 +10,7 @@ declare function toGamut(
 	options?: {
 		method?: string | undefined;
 		space?: string | ColorSpace | undefined;
-	}
+	} | string
 ): PlainColorObject;
 
 export default toGamut;
diff --git a/types/test/toGamut.ts b/types/test/toGamut.ts
@@ -10,3 +10,4 @@ toGamut("red"); // $ExpectType PlainColorObject
 toGamut(new Color("red")); // $ExpectType PlainColorObject
 toGamut(new Color("red"), { method: "clip", space: "srgb" }); // $ExpectType PlainColorObject
 toGamut(new Color("red"), { method: "clip", space: sRGB }); // $ExpectType PlainColorObject
+toGamut(new Color("red"), "srgb"); // $ExpectType PlainColorObject