Align Docs Is Allowed Example With Type Definition #546
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.
Describe the issue/change
The docs show a wrong example of the
isAllowed
callback. It returns theinputObj
if it passes the check orundefined
. This actually works in JavaScript because of type coercion (IMO still a bad practice). However, in TypeScript the type definition enforces aboolean
to be returned.The type definition requires a
boolean
:Describe the changes proposed/implemented in this PR
Aligned the
isAllowed
example in the docs with the method's type definition.