Made callsArg, returnsArg, and throwsArg more strict #1848
Conversation
They now throw if not called with enough arguments when before they would return undefined.
|
Inspired by a suggestion in #1846. If this merges first, that PR should be assimilated as well. |
Pull Request Test Coverage Report for Build 2559
💛 - Coveralls |
|
Note: This could be considered a breaking change to people who were expecting the silent fall through (failure?). I'm not sure. I'll leave that up to the semver gods. 😉 |
| function (error) { | ||
| return error instanceof TypeError | ||
| && error.message === | ||
| "throwArgs failed: 3 arguments required but only 2 present" |
There was a problem hiding this comment.
Of note: This message changed: throwArgs (typo?) became throwsArg.
There was a problem hiding this comment.
Yeah, seems like a typo. There is throwArg implemented on calls, but singular. throwArgs doesn't even make sense 😆
|
There is an error at the number vs. arg index in the old error messages for throwsArg. According to the doc, the index starts at 0. I think the check should be done between these two numbers: |
|
@huttli Great catch! Thanks. I pushed the fix. |
|
It doesn't matter which one goes first honestly. It would be easier and more convenient (for the contributor) to merge that PR first and then I can update this one to include it. |
|
Regarding versioning, I'd classify this as a bug. If it's breaking someones test, it's highlighting an issue that was always there and also needs fixing. Neither the semantics nor the API has changed. |
|
This has been published to NPM as |
They now throw if not called with enough arguments when before they would return undefined.
All will now throw if not called with enough arguments when before they would return undefined.
Example:
stub.returnsArg(5)('not', 'enough', 'params')would previously returnundefined. Now it throws.callsArgwould previously throw aTypeErrorcomplaining that the param (undefined) was not afunction.They all throw the same
TypeErrornow with a consistent message.