feat: add array with length prop type validator

Author: Mohammer5

src/arrayWithLength.js

@@ -0,0 +1,59 @@
+import propTypes from 'prop-types'
+
+const arrayWithLengthFactory = ({
+    min = 0,
+    max = Infinity,
+    propType,
+    isRequired,
+}) => (props, propName, componentName) => {
+    const arr = props[propName]
+
+    if (isRequired && typeof arr === 'undefined') {
+        return new Error(`${propName} is required.`)
+    }
+
+    if (arr && !Array.isArray(arr)) {
+        return new Error(`${propName} is not an array.`)
+    }
+
+    if (arr && arr.length > max) {
+        return new Error(
+            // prettier-ignore
+            `${propName} array has a length of ${arr.length}, but the maximum is ${max}`
+        )
+    }
+
+    if (arr && arr.length < min) {
+        return new Error(
+            // prettier-ignore
+            `${propName} array has a length of ${arr.length}, but the minimum is ${min}`
+        )
+    }
+
+    if (arr && propType) {
+        const len = arr.length
+        for (let i = 0; i < len; i++) {
+            propTypes.checkPropTypes(
+                {
+                    [i]: propType,
+                },
+                arr,
+                propName,
+                componentName
+            )
+        }
+    }
+
+    return null
+}
+
+export const arrayWithLength = (min, max, propType) => {
+    const fn = arrayWithLengthFactory({ min, max, propType, isRequired: false })
+    fn.isRequired = arrayWithLengthFactory({
+        min,
+        max,
+        propType,
+        isRequired: true,
+    })
+    return fn
+}

src/index.js

@@ -1,2 +1,3 @@
+export { arrayWithLength } from './arrayWithLength'
 export { instanceOfComponent } from './instanceOfComponent'
 export { mutuallyExclusive } from './mutuallyExclusive'