prop-types-plus

Another library of custom PropType validators. It is greatly inspired by airbnb/prop-types, which probably already offers the same custom types and more. I just wanted to create my own. 🙃

---

Installation

1yarn add prop-types-plus

Validators

[!NOTE] Since PropTypes are only useful for developement, when NODE_ENV is set to production mock functions are exported instead of the real validators.

arrayOfShape

Validates the type of the entries in an array in the given order.

Signature

1arrayOfShape(shape: PropTypes[])

Usage

1import { string, number } from "prop-type";
2import { arrayOfShape } from "prop-types-plus";
3
4const propTypes = {
5  foo: arrayOfShape([string, number.isRequired]),
6  fooRequired: arrayOfShape([string, number.isRequired]).isRequired
7};

requiredIf

Tests whether a prop is required based on a given condition.

Signature

1requiredIf(
2  type: PropTypes,
3  condition: (props: object) => boolean,
4  errorMessage?: string
5)

Usage

1import { string } from "prop-type";
2import { requiredIf } from "prop-types-plus";
3
4const propTypes = {
5  foo: requiredIf(
6    string,
7    (props) => props.bar
8    "The prop `foo` is required when there is `bar`."
9  )
10};

stringOfShape

Tests whether a string match the given regex.

Signature

1stringOfShape(regex: RegExp)

Usage

1import { stringOfShape } from "prop-types-plus";
2
3const propTypes = {
4  foo: stringOfShape(/^#.+/),
5  fooRequired: stringOfShape(/^#.+/).isRequired
6};

unnecessaryWhen

Tests whether a prop is unnecessary based on a given condition.

Signature

1unnecessaryWhen(
2  type: PropTypes,
3  condition: (props: object) => boolean,
4  errorMessage?: string
5)

Usage

1import { string } from "prop-type";
2import { unnecessaryWhen } from "prop-types-plus";
3
4const propTypes = {
5  foo: requiredIf(
6    string,
7    (props) => props.bar
8    "The prop `foo` is unnecessary when there is `bar`."
9  )
10};