Document using only either minimum or maximum (#8)

sindresorhus · Jan 17, 2024 · 0f3f702 · 0f3f702
1 parent 7a98531
commit 0f3f702
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/readme.md b/readme.md
@@ -15,11 +15,17 @@ import mathClamp from 'math-clamp';
 
 mathClamp(1, {minimum: 2, maximum: 4});
 //=> 2
+
+mathClamp(1, {minimum: 2});
+//=> 2
+
+mathClamp(5, {maximum: 4});
+//=> 4
 ```
 
 ## API
 
-### mathClamp(number, {minimum, maximum})
+### mathClamp(number, {minimum?, maximum?})
 
 ## Related
 

diff --git a/test.js b/test.js
@@ -6,4 +6,10 @@ test('main', t => {
 	t.is(mathClamp(2, {minimum: 1, maximum: 3}), 2);
 	t.is(mathClamp(1, {minimum: 2, maximum: 4}), 2);
 	t.is(mathClamp(5, {minimum: 1, maximum: 4}), 4);
+	t.is(mathClamp(5, {minimum: 1}), 5);
+	t.is(mathClamp(1, {minimum: 1}), 1);
+	t.is(mathClamp(0, {minimum: 1}), 1);
+	t.is(mathClamp(5, {maximum: 1}), 1);
+	t.is(mathClamp(1, {maximum: 1}), 1);
+	t.is(mathClamp(0, {maximum: 1}), 0);
 });