better-prop-types

better-prop-types

Features

• Add .isNotNull and .isNullable modifiers to primitive validators, besides the original .isRequired prop:
  • .isNotNull keeps the prop optional but rejects null (= accepts undefined but not null values)
  • .isNullable marks the prop as required but accepts null (= accepts null but not undefined values)

Usage

Installation

npm i -E better-prop-types

or:

yarn add -E better-prop-types

Example

import BetterPropTypes from 'better-prop-types'

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

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

Roadmap

• Add .isNotNull and .isNullable modifiers to ALL validators
• Integrate some prop-types-extra extra types:
  • all(...validators) => BetterPropsTypes.all(...validators)
  • deprecated(validator, reason) => BetterPropsTypes.string.isDeprecated(reason)
  • isRequiredForA11y(validator) => BetterPropsTypes.string.isRequiredForA11y

---

Changelog

1.0.0-alpha.3 (2021-11-20)

Features

• attach new modifiers to oneOf() validator (e4f9233)