@aacassandra/validator-js 中文文档教程
@aacassandra/validator-js
使用 nodejs 项目的最简单方法,如 Vue JS、React JS、Angular JS 和许多其他用于表单验证器的
Getting Started
方法如果你想为这个项目做出贡献,你可以克隆/fork 这个项目。 /src 目录中提供的主要源代码。 阅读有关开发
Features
的更多信息而这一次,验证器仅支持并在 Vue JS 上进行了测试:
- string
- number
- phone
- image
- geolocation
Installing
将其安装在您的项目根目录中。
npm i @aacassandra/validator-js
Usage
下面是如何使用此插件的示例。 首先,您必须准备一个对象,该对象将用于存储来自具有不同对象格式的表单的值,例如字符串,数字,电子邮件等
- String, Number, Email & Phone
{
val:'',
alert: {
enabled: false,
message: ''
}
}
- Image
{
val: '', //files[0] from input type file
src: '', //optional, if the url image has already
alert: {
enabled: false,
message: ''
}
}
- Geolocation
{
val: {
lat: 0,
lon: 0
},
alert: {
enabled: false,
message: ''
}
}
在创建用于存储表单值的对象之后,现在您可以使用以下代码进行验证。
import Validator from '@aacassandra/validator-js'
const validate = Validator(Data.form, {
picture: { type: 'image', max_kb: 500 },
name: { type: 'string', min:0, max:10, required: true },
phone: { type: 'phone', required: true },
email: { type: 'string', required: true },
price: { type: 'number', min:0, max:20 }
});
if (validate.status) {
//has success
}else{
//has fail
}
Development
想贡献吗? 伟大的!
要修复错误或增强现有模块,请按照以下步骤操作:
- Fork the repo
- Create a new branch (git checkout -b improve-feature)
- Make the appropriate changes in the files
- Add changes to reflect the changes made
- Commit your changes (git commit -am 'Improve feature')
- Push to the branch (git push origin improve-feature)
- Create a Pull Request
License
Copyright (c) 2019 Alauddin Afif Cassandra
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
阅读有关许可证的更多信息 LICENSE
@aacassandra/validator-js
The easiest ways with nodejs project like a Vue JS, React JS, Angular JS and many others for form validator
Getting Started
If you want constribute for this project, you can clone / fork this project. The main source code available at /src directory. read more about development
Features
While this time, the validator only support and tested on Vue JS:
- string
- number
- phone
- image
- geolocation
Installing
Install this in your project root directories.
npm i @aacassandra/validator-js
Usage
Below is an example of how to use this plugin. for the first, you must prepare an object, where the object will be used to store values from forms with different object formats such as string, number, email, and many others
- String, Number, Email & Phone
{
val:'',
alert: {
enabled: false,
message: ''
}
}
- Image
{
val: '', //files[0] from input type file
src: '', //optional, if the url image has already
alert: {
enabled: false,
message: ''
}
}
- Geolocation
{
val: {
lat: 0,
lon: 0
},
alert: {
enabled: false,
message: ''
}
}
after making an object for storing the values of form, now you can validate with following this code.
import Validator from '@aacassandra/validator-js'
const validate = Validator(Data.form, {
picture: { type: 'image', max_kb: 500 },
name: { type: 'string', min:0, max:10, required: true },
phone: { type: 'phone', required: true },
email: { type: 'string', required: true },
price: { type: 'number', min:0, max:20 }
});
if (validate.status) {
//has success
}else{
//has fail
}
Development
Want to contribute? Great!
To fix a bug or enhance an existing module, follow these steps:
- Fork the repo
- Create a new branch (git checkout -b improve-feature)
- Make the appropriate changes in the files
- Add changes to reflect the changes made
- Commit your changes (git commit -am 'Improve feature')
- Push to the branch (git push origin improve-feature)
- Create a Pull Request
License
Copyright (c) 2019 Alauddin Afif Cassandra
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
readmore about license LICENSE