fix(types): emitted can return undefined #1431
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.
I’m not sure how strict this project is about
undefined
types in general, but I found it confusing that the documentation advised to useexpect(…).toBeTruthy()
on a function (emitted( 'foo' )
) that was typed to always return an array (i. e., always truthy).It might be better to only add the
|undefined
to the overload with an event name, not to the overload that returns all events at once… not sure.What kind of change does this PR introduce? (check at least one)
Does this PR introduce a breaking change? (check one)
I suppose in theory it’s a breaking change? People who previously assigned the result of.emitted()
to a variable with an explicit type might now get a type error. The expected use, inline withinexpect()
, should be fine, though.Calls like
.emitted().foo[0]
or.emitted('foo')[0]
may also need to be updated, depending on TypeScript config – in the tests, I’ve used the non-null assertion operator.The PR fulfills these requirements:
dev
branch.fix #xxx[,#xxx]
, where "xxx" is the issue number)If adding a new feature, the PR's description includes:
Other information: