Support on and off words

Fixes #25
sindresorhus · Dec 1, 2019 · 65e8faf · 65e8faf
1 parent b1cd76b
commit 65e8faf
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 6 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -23,7 +23,7 @@ declare namespace yn {
 /**
 Parse yes/no like values.
 
-The following case-insensitive values are recognized: `'y', 'yes', 'true', true, '1', 1, 'n', 'no', 'false', false, '0', 0`
+The following case-insensitive values are recognized: `'y', 'yes', 'true', true, '1', 1, 'n', 'no', 'false', false, '0', 0`, 'on', 'off'
 
 @param input - Value that should be converted.
 @returns The parsed input if it can be parsed or the default value defined in the `default` option.

diff --git a/index.js b/index.js
@@ -11,11 +11,11 @@ const yn = (value, {
 		throw new TypeError(`Expected the \`default\` option to be of type \`boolean\`, got \`${typeof default_}\``);
 	}
 
-	if (/^(?:y|yes|true|1)$/i.test(value)) {
+	if (/^(?:y|yes|true|1|on)$/i.test(value)) {
 		return true;
 	}
 
-	if (/^(?:n|no|false|0)$/i.test(value)) {
+	if (/^(?:n|no|false|0|off)$/i.test(value)) {
 		return false;
 	}
 

diff --git a/readme.md b/readme.md
@@ -9,7 +9,7 @@ Useful for validating answers of a CLI prompt.
 The following case-insensitive values are recognized:
 
 ```js
-'y', 'yes', 'true', true, '1', 1, 'n', 'no', 'false', false, '0', 0
+'y', 'yes', 'true', true, '1', 1, 'n', 'no', 'false', false, '0', 0, 'on', 'off'
 ```
 
 *Enable lenient mode to gracefully handle typos.*

diff --git a/test.js b/test.js
@@ -12,7 +12,8 @@ const truthyCases = [
 	'True',
 	true,
 	'1',
-	1
+	1,
+	'on'
 ];
 test('truthy cases', t => {
 	for (const case_ of truthyCases) {
@@ -32,7 +33,8 @@ const falseyCases = [
 	'False',
 	false,
 	'0',
-	0
+	0,
+	'off'
 ];
 test('falsey cases', t => {
 	for (const case_ of falseyCases) {