Skip to content

Commit

Permalink
[New] oneOfType: Add expected types to warning
Browse files Browse the repository at this point in the history
Adds data object to returned error in checker so that the expected types can be accessed from within oneOfType check. Also, updates the tests slightly.

Fixes facebook#9.
  • Loading branch information
joshalling authored and ljharb committed Jul 20, 2018
1 parent 7161c05 commit 3910873
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 7 deletions.
2 changes: 1 addition & 1 deletion __tests__/PropTypesDevelopmentReact15.js
Original file line number Diff line number Diff line change
Expand Up @@ -1080,7 +1080,7 @@ describe('PropTypesDevelopmentReact15', () => {
typeCheckFail(
PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
[],
'Invalid prop `testProp` supplied to `testComponent`.',
'Invalid prop `testProp` supplied to `testComponent`, expected one of type [string, number].',
);

const checker = PropTypes.oneOfType([
Expand Down
2 changes: 1 addition & 1 deletion __tests__/PropTypesDevelopmentStandalone-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -1154,7 +1154,7 @@ describe('PropTypesDevelopmentStandalone', () => {
typeCheckFail(
PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
[],
'Invalid prop `testProp` supplied to `testComponent`.',
'Invalid prop `testProp` supplied to `testComponent`, expected one of type [string, number].',
);

const checker = PropTypes.oneOfType([
Expand Down
19 changes: 14 additions & 5 deletions factoryWithTypeCheckers.js
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,9 @@ module.exports = function(isValidElement, throwOnDirectAccess) {
* is prohibitively expensive if they are created too often, such as what
* happens in oneOfType() for any type before the one that matched.
*/
function PropTypeError(message) {
function PropTypeError(message, data) {
this.message = message;
this.data = data && typeof data === 'object' ? data: {};
this.stack = '';
}
// Make `instanceof Error` still work for returned errors.
Expand Down Expand Up @@ -234,7 +235,10 @@ module.exports = function(isValidElement, throwOnDirectAccess) {
// 'of type `object`'.
var preciseType = getPreciseType(propValue);

return new PropTypeError('Invalid ' + location + ' `' + propFullName + '` of type ' + ('`' + preciseType + '` supplied to `' + componentName + '`, expected ') + ('`' + expectedType + '`.'));
return new PropTypeError(
'Invalid ' + location + ' `' + propFullName + '` of type ' + ('`' + preciseType + '` supplied to `' + componentName + '`, expected ') + ('`' + expectedType + '`.'),
{expectedType: expectedType}
);
}
return null;
}
Expand Down Expand Up @@ -378,14 +382,19 @@ module.exports = function(isValidElement, throwOnDirectAccess) {
}

function validate(props, propName, componentName, location, propFullName) {
var expectedTypes = [];
for (var i = 0; i < arrayOfTypeCheckers.length; i++) {
var checker = arrayOfTypeCheckers[i];
if (checker(props, propName, componentName, location, propFullName, ReactPropTypesSecret) == null) {
var checkerResult = checker(props, propName, componentName, location, propFullName, ReactPropTypesSecret);
if (checkerResult == null) {
return null;
}
if (checkerResult.data.hasOwnProperty('expectedType')) {
expectedTypes.push(checkerResult.data.expectedType);
}
}

return new PropTypeError('Invalid ' + location + ' `' + propFullName + '` supplied to ' + ('`' + componentName + '`.'));
var expectedTypesMessage = (expectedTypes.length > 0) ? ', expected one of type [' + expectedTypes.join(', ') + ']': '';
return new PropTypeError('Invalid ' + location + ' `' + propFullName + '` supplied to ' + ('`' + componentName + '`' + expectedTypesMessage + '.'));
}
return createChainableTypeChecker(validate);
}
Expand Down

0 comments on commit 3910873

Please sign in to comment.