Merge pull request #398 from nover/master

Document will-throw-a assertions for functions that take input
unexpectedjs · May 22, 2017 · 0daf53f · 0daf53f
2 parents 36b7f9c + 0bf76b9
commit 0daf53f
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/documentation/assertions/function/to-throw-a.md b/documentation/assertions/function/to-throw-a.md
@@ -35,3 +35,15 @@ expected function willNotThrow() {} to throw a RangeError
   expected function willNotThrow() {} to throw
     did not throw
 ```
+
+To test functions that require input wrap the function invocation in an anonymous function
+
+```javascript
+function willThrow(input) {
+  if(input) throw new SyntaxError('The error message');
+  return input;
+}
+expect(function() {
+    willThrow('input.here')
+}, 'to throw a', SyntaxError);
+```