npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

better-prop-types

v1.1.1

Published

Better PropTypes.

Downloads

90

Readme

better-prop-types

License CI Status Code Coverage NPM Version

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. It also provides accurate Typescript declarations.

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:

  • BetterPropsTypes.objectOf(/* */).isRequiredButNullable
  • BetterPropsTypes.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
  • Improve original error messages for arrays validated via functional validators with explicit property naming.