feat(alias): add .throws as alias to .raises, close #75

kensho-technologies · Sep 12, 2016 · 8cd3154 · 8cd3154
1 parent 641a522
commit 8cd3154
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 9 deletions.
diff --git a/dist/check-more-types.js b/dist/check-more-types.js
@@ -661,9 +661,10 @@ return /******/ (function(modules) { // webpackBootstrap
 	  rgb.test(value)
 	}
 
-	/** Checks if given function raises an error
+	/** Checks if given function raises an error. Alias "throws"
 
 	  @method raises
+	  @alias throws
 	*/
 	function raises (fn, errorValidator) {
 	  verify(low.fn(fn), 'expected function that raises')
@@ -715,6 +716,7 @@ return /******/ (function(modules) { // webpackBootstrap
 	  odd: odd,
 	  oneOf: curry2(oneOf, true),
 	  raises: raises,
+	  throws: raises,
 	  sameLength: sameLength,
 	  startsWith: startsWith,
 	  type: curry2(type),

diff --git a/dist/check-more-types.min.js b/dist/check-more-types.min.js
diff --git a/src/mid-level-spec.js b/src/mid-level-spec.js
@@ -179,6 +179,8 @@ describe('check-more-types mid-level predicates', function () {
       }
 
       la(check.raises(foo))
+      // has "throws" alias
+      la(check.throws(foo), 'use throws alias')
       la(!check.raises(bar))
       la(check.raises(foo, isValidError))
       la(!check.raises(foo, isInvalid))

diff --git a/src/mid-level.js b/src/mid-level.js
@@ -136,9 +136,10 @@ function hexRgb (value) {
   rgb.test(value)
 }
 
-/** Checks if given function raises an error
+/** Checks if given function raises an error. Alias "throws"
 
   @method raises
+  @alias throws
 */
 function raises (fn, errorValidator) {
   verify(low.fn(fn), 'expected function that raises')
@@ -190,6 +191,7 @@ module.exports = {
   odd: odd,
   oneOf: curry2(oneOf, true),
   raises: raises,
+  throws: raises,
   sameLength: sameLength,
   startsWith: startsWith,
   type: curry2(type),