Require at least one of provided props

requireOneOf.js

import PropTypes from 'prop-types'

/**
 * Require at least one of provided props
 *
 * @example
 *
 * const requireOneOfProps = requireOneOf({
 *      entity: PropTypes.string,
 *      entities: PropTypes.arrayOf(PropTypes.string)
 * })
 *
 * Component.propTypes = {
 *      entity: requireOneOfProps,
 *      entities: requireOneOfProps
 * }
 *
 * @param {Object} propsToCheck
 * @returns {Function}
 */
const requireOneOf = propsToCheck => {
    return (props, propName, compName) => {
        const requirePropNames = Object.keys(propsToCheck)

        const found = requirePropNames.find(propRequired => props[propRequired])

        try {
            if (!found) {
                throw new Error(`One of ${requirePropNames.join(',')} is required by '${compName}' component.`)
            }
            PropTypes.checkPropTypes(propsToCheck, props, propName, compName)
        } catch (e) {
            return e
        }
        return null
    }
}

export { requireOneOf }