prop-types-extended v0.2.1

prop-types-extended

Extracted from React.PropTypes and extended version of propTypes. To use without a dependency on React.

Install

npm install --save prop-types-extended

API: PropTypesExtended.validate

Example

Pass a PropType schema, a props object, and a descriptive name for warnings. In React the descriptive name would be the displayName of a component.

import PropTypesExtended from 'prop-types-extended';

var schema = {
  ham: PropTypesExtended.string.isRequired
};

PropTypesExtended.validate(schema, {ham: 'delicious'}, 'Ham');

API: PropTypesExtended.validateWithErrors

Similar to PropTypesExtended.validate but will throw errors instead of logging warnings to the console.

API: PropTypesExtended

{
  // You can declare that a prop is a specific JS primitive. By default, these
  // are all optional.
  optionalArray: PropTypesExtended.array,
  optionalBool: PropTypesExtended.bool,
  optionalFunc: PropTypesExtended.func,
  optionalNumber: PropTypesExtended.number,
  optionalObject: PropTypesExtended.object,
  optionalString: PropTypesExtended.string,

  // You can also declare that a prop is an instance of a class. This uses
  // JS's instanceof operator.
  optionalMessage: PropTypesExtended.instanceOf(Message),

  // You can ensure that your prop is limited to specific values by treating
  // it as an enum.
  optionalEnum: PropTypesExtended.oneOf(['News', 'Photos']),

  // An object that could be one of many types
  optionalUnion: PropTypesExtended.oneOfType([
    PropTypesExtended.string,
    PropTypesExtended.number,
    PropTypesExtended.instanceOf(Message)
  ]),

  // An array of a certain type
  optionalArrayOf: PropTypesExtended.arrayOf(PropTypesExtended.number),

  // An object with property values of a certain type
  optionalObjectOf: PropTypesExtended.objectOf(PropTypesExtended.number),

  // An object taking on a particular shape
  optionalObjectWithShape: PropTypesExtended.shape({
    color: PropTypesExtended.string,
    fontSize: PropTypesExtended.number
  }),

  // You can chain any of the above with `isRequired` to make sure a warning
  // is shown if the prop isn't provided.
  requiredFunc: PropTypesExtended.func.isRequired,

  // A value of any data type
  requiredAny: PropTypesExtended.any.isRequired,

  // You can also specify a custom validator. It should return an Error
  // object if the validation fails. Don't `console.warn` or throw, as this
  // won't work inside `oneOfType`.
  customProp: function(props, propName, descriptiveName) {
    if (!/matchme/.test(props[propName])) {
      return new Error('Validation failed!');
    }
  }
}

Caveat

This is not an exact drop-in, validations related to React have been stripped out. PropTypesExtended.element and PropTypesExtended.node are not included.