facebook/prop-types

Return value from checkPropTypes?

Open

#169 opened on Mar 1, 2018

View on GitHub
 (6 comments) (31 reactions) (0 assignees)JavaScript (4,379 stars) (389 forks)batch import
help wanted

Description

Is there a good reason not to return false if checkPropTypes fails any of the validations? I can't think of one myself. If no one disagrees I can do a PR.

This would be useful for those of us that want to use checkPropTypes for our own validation needs outside of React.

Contributor guide

Tech stack
javascript
Domain
frontenddeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptNode.jsprop types library usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue requests modifying `checkPropTypes` to return `false` when validation fails. Start by examining the current implementation of `checkPropTypes` in the source code (likely in `checkPropTypes.js`). Understand how it currently logs warnings and that it returns `undefined`. To implement, you would change the function to return a boolean indicating success/failure while maintaining backward compatibility. There are 6 comments in the issue that may provide additional context; review them for potential pitfalls or preferred approaches. No pull request is linked, so this is your chance to contribute a first PR.