Remove withArgs method from behavior #350
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While writing the documentation (cjohansen/sinon-web#30) for the new
onCall
method (#244) I've come across an ambiguity in the API. Please consider the following explanation, which I is taken from the commit message of this pull request:stub.onCall(n).withArgs(...)
should not be an alias forstub.withArgs(...).onCall(n)
since it leads to an ambiguous andpossibly surprising api:
The stub definition seems to imply though that we are only further
distinguishing cases for the first call. It would therefore be
reasonable to expect the second call to return undefined. This is not
the case if the alias removed by this commit is in effect.
Even worse, keeping the alias might lead to clashes in the api once
argument filtering for single calls as implied above shall be added to
the codebase.
We therefore for now throw an error which explains that calling
withArgs on a behavior is not yet supported, deferring the discussion
what it should mean.