fix: add more should interface definitions. #8068
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.
shouldto increase type safety #5573User facing changelog
Add more
shouldinterface definitions.Additional details
To remove duplication in comments, I used union types. Without it, many functions have almost identical 4 different documentation comments.
How has the user experience changed?
Now, auto completions like
'have.lengthOf'work.Note: Why not removing fallback?
It's because there are too many valid combination for chai.js. It's simply impossible to cover all of them. And we can block valid assertions in TS codes.
It's not hard to find them. All we need to do is running the test once.
PR Tasks
cypress-documentation?type definitions?cypress.schema.json?