better-prop-types

better-prop-types

better-prop-types is a wrapper for the original prop-types library adding a few more validators and modifiers to accurately handle null and undefined values (which shouldn't be considered similar!).

The code is fully test-covered and actively used in production.

The library includes the original prop-types as a dependency.

And that's important to note that better-prop-types is only bundled as a full JavaScript module (ESM).

Features

• Add .isOptionalButNotNull and .isRequiredButNullable modifiers to all validators, besides the original .isRequired one:
  • .isOptionalButNotNull keeps the prop as optional (accepting undefined) but rejects null values
  • .isRequired marks the prop as required but rejects both null & undefined values
  • .isRequiredButNullable marks the prop as required (rejecting undefined) but accepts null values

Usage

Installation

yarn add -E better-prop-types

or:

npm i -E better-prop-types

Example

import BetterPropTypes from 'better-prop-types'

export const MyComponent = ({
  anOptionalButNonNullStringProp = 'A default string',
  aRequiredAndNonNullableBooleanProp,
  aRequiredButNullableNumberProp,
}) => (
  // ...
)

MyComponent.propTypes = {
  anOptionalButNonNullStringProp: BetterPropTypes.string.isOptionalButNotNull,
  aRequiredAndNonNullableBooleanProp: BetterPropTypes.bool.isRequired,
  aRequiredButNullableNumberProp: BetterPropTypes.number.isRequiredButNullable,
}

You can also use them with all the functional validators:

• objectOf(/* */).isRequiredButNullable
• shape(/* */).isOptionalButNotNull
• etc

Roadmap

• Integrate some prop-types-extra extra types:
  • all(...validators) => BetterPropsTypes.all(...validators)
  • deprecated(validator, reason) => BetterPropsTypes.isDeprecated(validator, reason)
  • isRequiredForA11y(validator) => BetterPropsTypes.string.isRequiredForA11y

---

Changelog

1.0.0 (2021-11-22)

Bug Fixes

• add missing main field in package (5657736)
• update isNotNull & isNullable types (d783376)

Features

• add isNotNull & isNullable modifiers to primitive validators (569e3e2)
• attach new modifiers to any validator (968c05a)
• attach new modifiers to arrayOf & objectOf validators (73fa84a)
• attach new modifiers to element & elementType validators (c97aefd)
• attach new modifiers to exact & shape validators (c4a8b65)
• attach new modifiers to instanceOf validator (6d97cc7)
• attach new modifiers to node validator (ebf5253)
• attach new modifiers to oneOf() validator (e4f9233)
• attach new modifiers to oneOfType validator (4a41a6d)