| 1 | ;
|
| 2 |
|
| 3 | Object.defineProperty(exports, "__esModule", {
|
| 4 | value: true
|
| 5 | });
|
| 6 | exports.makeRequirable = makeRequirable;
|
| 7 | exports.default = void 0;
|
| 8 |
|
| 9 | /*
|
| 10 | * The MIT License (MIT)
|
| 11 | *
|
| 12 | * Copyright (c) 2015 - present Instructure, Inc.
|
| 13 | *
|
| 14 | * Permission is hereby granted, free of charge, to any person obtaining a copy
|
| 15 | * of this software and associated documentation files (the "Software"), to deal
|
| 16 | * in the Software without restriction, including without limitation the rights
|
| 17 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
| 18 | * copies of the Software, and to permit persons to whom the Software is
|
| 19 | * furnished to do so, subject to the following conditions:
|
| 20 | *
|
| 21 | * The above copyright notice and this permission notice shall be included in all
|
| 22 | * copies or substantial portions of the Software.
|
| 23 | *
|
| 24 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
| 25 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
| 26 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
| 27 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
| 28 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
| 29 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
| 30 | * SOFTWARE.
|
| 31 | */
|
| 32 |
|
| 33 | /**
|
| 34 | * ---
|
| 35 | * category: utilities/PropTypes
|
| 36 | * ---
|
| 37 | * Given a validator function, extends the validator functionality to also
|
| 38 | * ensure that the prop has been provided if `.isRequired` is specified.
|
| 39 | *
|
| 40 | * ```js
|
| 41 | * function validator (props, propName, componentName) {
|
| 42 | * const propValue = props[propName]
|
| 43 | * if (propValue === 'purple') {
|
| 44 | * return new Error(`Purple is not accepted in ${componentName}!`)
|
| 45 | * }
|
| 46 | * }
|
| 47 | *
|
| 48 | * validator.isRequired = makeRequirable(validator)
|
| 49 | * ```
|
| 50 | *
|
| 51 | * @param {function} validator - a validator function
|
| 52 | * @returns {Error} if designated prop is not provided
|
| 53 | */
|
| 54 | function makeRequirable(validator) {
|
| 55 | return function (props, propName, componentName) {
|
| 56 | var propValue = props[propName];
|
| 57 |
|
| 58 | if (propValue === null || typeof propValue === 'undefined') {
|
| 59 | return new Error("The prop `".concat(propName, "` is marked as required in `").concat(componentName, "`, but its value is `").concat(propValue, "`"));
|
| 60 | } else {
|
| 61 | for (var _len = arguments.length, rest = new Array(_len > 3 ? _len - 3 : 0), _key = 3; _key < _len; _key++) {
|
| 62 | rest[_key - 3] = arguments[_key];
|
| 63 | }
|
| 64 |
|
| 65 | return validator.apply(void 0, [props, propName, componentName].concat(rest));
|
| 66 | }
|
| 67 | };
|
| 68 | }
|
| 69 |
|
| 70 | var _default = makeRequirable;
|
| 71 | exports.default = _default; |
| \ | No newline at end of file |