Add ability to disable the spinner (#34)

sindresorhus · Jan 17, 2017 · 425b21a · 425b21a
1 parent 4ceeedd
commit 425b21a
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 4 deletions.
diff --git a/index.js b/index.js
@@ -31,7 +31,7 @@ class Ora {
 		this.stream = this.options.stream;
 		this.id = null;
 		this.frameIndex = 0;
-		this.enabled = this.options.enabled || ((this.stream && this.stream.isTTY) && !process.env.CI);
+		this.enabled = typeof this.options.enabled === 'boolean' ? this.options.enabled : ((this.stream && this.stream.isTTY) && !process.env.CI);
 	}
 	frame() {
 		const frames = this.spinner.frames;

diff --git a/readme.md b/readme.md
@@ -88,10 +88,9 @@ You could for example set this to `process.stdout` instead.
 
 ##### enabled
 
-Type: `boolean`<br>
-Default: `false`
+Type: `boolean`
 
-Force enabling of the spinner regardless of the `stream` not being run inside a TTY context and/or in a CI environment.
+Force enable/disable the spinner. If not specified, the spinner will be enabled if the `stream` is being run inside a TTY context (not spawned or piped) and/or not in a CI environment.
 
 ### Instance