Fix assertion message for .all and .any
#132
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sindresorhus
requested changes
Apr 19, 2021
source/index.ts
Outdated
| @@ -388,9 +388,11 @@ is.any = (predicate: Predicate | Predicate[], ...values: unknown[]): boolean => | |||
|
|
|||
| is.all = (predicate: Predicate, ...values: unknown[]): boolean => predicateOnArray(Array.prototype.every, predicate, values); | |||
|
|
|||
| const assertType = (condition: boolean, description: string, value: unknown): asserts condition => { | |||
| const assertType = (condition: boolean, description: string, value: unknown, options: { getValuesMessage?: () => string } = {}): asserts condition => { | |||
There was a problem hiding this comment.
I don't see the point in nesting it in an options object. We're only using this internally. Can just be a normal argument.
|
Does the issue also apply to |
|
@sindresorhus I tried a slightly different approach in my latest push and applied it to I decided to keep the options object for this approach because it's now a boolean flag. |
sindresorhus
changed the title
getValuesMessage option for assertType.all and .any
|
Thanks :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR fixes #131
Approach: Add an options object to
assertType. This allows a custom failure message from the calling code. It's a function that returns a string and passed in asgetValuesMessageto the options object.What do you think of the approach?