Add support for boolean value for color option (#244)

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>
sindresorhus · Feb 2, 2025 · fe951e5 · fe951e5
1 parent 86aca37
commit fe951e5
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -58,7 +58,7 @@ export type Options = {
 
 	@default 'cyan'
 	*/
-	readonly color?: Color;
+	readonly color?: Color | boolean;
 
 	/**
 	Set to `false` to stop Ora from hiding the cursor.
@@ -186,7 +186,7 @@ export interface Ora {
 	/**
 	Change the spinner color.
 	*/
-	color: Color;
+	color: Color | boolean;
 
 	/**
 	Change the spinner indent.

diff --git a/readme.md b/readme.md
@@ -76,9 +76,9 @@ Or an object like:
 
 ##### color
 
-Type: `string`\
+Type: `string | boolean`\
 Default: `'cyan'`\
-Values: `'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray'`
+Values: `'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray' | boolean`
 
 The color of the spinner.