Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zt-sv/propchecker
Minimalist JavaScript object validation library
https://github.com/zt-sv/propchecker
checker javascript no-dependencies validation
Last synced: 11 days ago
JSON representation
Minimalist JavaScript object validation library
- Host: GitHub
- URL: https://github.com/zt-sv/propchecker
- Owner: zt-sv
- License: mit
- Created: 2016-08-30T21:53:50.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T18:24:45.000Z (about 2 years ago)
- Last Synced: 2024-12-19T21:53:13.742Z (about 1 month ago)
- Topics: checker, javascript, no-dependencies, validation
- Language: JavaScript
- Size: 211 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PropChecker
Minimalist JavaScript object validation library.
[](https://www.npmjs.com/package/propchecker)
[](https://www.npmjs.com/package/propchecker)
[](https://travis-ci.org/13rentgen/PropChecker)
[](https://www.codacy.com/app/13rentgen/PropChecker?utm_source=github.com&utm_medium=referral&utm_content=13rentgen/PropChecker&utm_campaign=Badge_Coverage)
[](https://www.codacy.com/app/13rentgen/PropChecker?utm_source=github.com&utm_medium=referral&utm_content=13rentgen/PropChecker&utm_campaign=Badge_Grade)
## Installation
PropChecker is packaged on npm:
```sh
$ npm install propchecker
```
## Usage Example
```javascript
var config = {
foo: [PropChecker.isRequired, PropChecker.isString],
nested: {
bar: PropChecker.isNumber,
arr: PropChecker.isArray,
anotherArray: PropChecker.isArrayOf(PropChecker.isNumber)
}
};
var obj = {
foo: 'some string',
nested: {
bar: 123,
arr: ['element1', 'element2'],
anotherArray: [1, 2, 3, 4]
}
};
var errorHandler = function(errors) {
console.log(errors);
};
PropChecker.validate(obj, config, errorHandler);
```
## Available checkers
### isRequired
Check the property value is not a null and not an undefined
### isString
Check the property value is a string
### isNumber
Check the property value is a number
### isBoolean
Check the property value is a boolean
### isArray
Check the property value is a number
### isObject
Check the property value is an object
### isDate
Check the property value is a date
### isFunction
Check the property value is a function
### isRegExp
Check the property value is a regexp
### isError
Check the property value is a error
### isArrayOf
Check the property value is an array with specific elements type. Type specified through any PropChecker validator. Basic example:
```javascript
var config = {
arrayWithString: PropChecker.isArrayOf(PropChecker.isString),
arrayWithArrayWithNumbers: PropChecker.isArrayOf(PropChecker.isArrayOf(PropChecker.isNumber))
};
var obj = {
arrayWithString: ['some string', 'another string'],
arrayWithArrayWithNumbers: [[1], [2, 3], [4, 5]]
};
PropChecker.validate(obj, config);
```
### isEqual
Check the property value is equal to primitive, using strict equality operator inside. Basic example:
```javascript
var config = {
age: PropChecker.isEqual(18)
};
var obj = {
age: 18
};
PropChecker.validate(obj, config);
```
### isInherits
Check the property value to inherits another class. Basic example:
```javascript
class BaseClass {}
class AnotherOne extends BaseClass {}
var config = {
some: PropChecker.isInherits(BaseClass)
};
var obj = {
some: AnotherOne
};
PropChecker.validate(obj, config);
```
### Not enough?
You can define your own PropCheck validator. Type checker function should return null, when the value is valid, or an error instance, when the value is invalid. Basic example:
```javascript
var myValidator = new PropChecker(function(propName, propValue) {
if (propValue > 10) {
return new TypeError(propName + ' is invalid');
}
return null;
});
var config = {
age: myValidator
};
var obj = {
age: 9
};
PropChecker.validate(obj, config);
```
## License
[MIT](LICENSE)