Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alibaba-fusion/validate
https://github.com/alibaba-fusion/validate
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/alibaba-fusion/validate
- Owner: alibaba-fusion
- License: mit
- Created: 2019-07-17T07:47:44.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-21T12:11:28.000Z (9 months ago)
- Last Synced: 2024-08-19T08:43:18.627Z (3 months ago)
- Language: TypeScript
- Size: 3.81 MB
- Stars: 1
- Watchers: 3
- Forks: 3
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Validate
Validation to be used with @alifd/field
Install with `npm install @alifd/validate`
### Basic Usage
#### Callback
```
const rules = {
myInput: function (rule, value, cb, options) {
if (value <= 100) {
cb('Value must be more than 100');
} else {
cb();
}
}
}
const validator = new Validator(rules);
validator.validate({ myInput: 90 }, (err) => { console.log(err)});
```
#### Promise
```
const rules = {
myInput: function (rule, value, cb, options) {
if (value <= 100) {
cb('Value must be more than 100');
} else {
cb();
}
}
}
const validator = new Validator(rules);
validator.validatePromise({ myInput: 90 })
.then((err) => { console.log(err)})
```
## API
### Initialization
```
let validator = new Validator(rules [, options]);
```
|Parameter | Description | Type | Optional |Default |
|-----------|------------------------------------------|------------|-------|--------|
| rules | Map of rule names to validation functions | { [ruleName] : Array of validation functions } | yes | undefined
| options | validation options | Object | yes | {} |
`options` configuration item
| Parameters | Description | Type |Default |
|-----------|------------------------------------------|-----------|--------|
| first | should only return the first error found amongst rules | Boolean | undefined
| messages | map to override default messages | Object | (see ./src/messages)
## Development
### Testing
`npm run test` - triggers a one-time full run of all unit tests
`npm run test-watch` - triggers a run of all unit tests, but watches for any changes to code or tests and reruns all tests.
### Making commits
Commits must be in the following format `TYPE(SCOPE): MESSAGE`, where `SCOPE` is optional.
e.g. `fix: validatePromise return value`
Review the `commitlint.config.js` file to see allowed types.
### Release
There are 2 main branches: Master and Develop. Master holds the latest code that is contained in the npm package. Develop is the development branch used for queueing package changes and any final validation. All development should occur on another branch and then be merged into Develop.
Travis CI will run tests on each pull request and push. If the push is to master then an additional release step runs. The release step uses `semantic-release` to determine the correct version, tag the master branch, and release the new package to npm.
NOTE: the package.json file needs to be updated manually after the release.