https://github.com/onface/prop-types-0.2.0
https://github.com/onface/prop-types-0.2.0
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/onface/prop-types-0.2.0
- Owner: onface
- License: other
- Created: 2018-01-31T06:45:29.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-01-31T07:00:40.000Z (over 7 years ago)
- Last Synced: 2025-02-17T09:43:11.289Z (3 months ago)
- Language: JavaScript
- Size: 7.81 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> 这是 [email protected] 的备份。因为我有些库用的是 0.2.0
Extracted from [`React.PropTypes`](http://facebook.github.io/react/docs/reusable-components.html#prop-validation). To use without a dependency on `React`.
### Install
```
npm install --save prop-types
```
### API: `PropTypes.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.
```js
import PropTypes from 'prop-types';
var schema = {
ham: PropTypes.string.isRequired
};
PropTypes.validate(schema, {ham: 'delicious'}, 'Ham');
```
### API: `PropTypes.validateWithErrors`
Similar to `PropTypes.validate` but will throw errors instead of logging warnings to the console.
### API: `PropTypes`
```js
{
// You can declare that a prop is a specific JS primitive. By default, these
// are all optional.
optionalArray: PropTypes.array,
optionalBool: PropTypes.bool,
optionalFunc: PropTypes.func,
optionalNumber: PropTypes.number,
optionalObject: PropTypes.object,
optionalString: PropTypes.string,
// You can also declare that a prop is an instance of a class. This uses
// JS's instanceof operator.
optionalMessage: PropTypes.instanceOf(Message),
// You can ensure that your prop is limited to specific values by treating
// it as an enum.
optionalEnum: PropTypes.oneOf(['News', 'Photos']),
// An object that could be one of many types
optionalUnion: PropTypes.oneOfType([
PropTypes.string,
PropTypes.number,
PropTypes.instanceOf(Message)
]),
// An array of a certain type
optionalArrayOf: PropTypes.arrayOf(PropTypes.number),
// An object with property values of a certain type
optionalObjectOf: PropTypes.objectOf(PropTypes.number),
// An object taking on a particular shape
optionalObjectWithShape: PropTypes.shape({
color: PropTypes.string,
fontSize: PropTypes.number
}),
// You can chain any of the above with `isRequired` to make sure a warning
// is shown if the prop isn't provided.
requiredFunc: PropTypes.func.isRequired,
// A value of any data type
requiredAny: PropTypes.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. `PropTypes.element` and `PropTypes.node` are not included.