@rikishi/mongoose-valid8
v5.0.0
Published
Additional mongoose schema validations
Downloads
16
Maintainers
rikishiReadme
mongoose-valid8
Additional mongoose schema validations.
Requirements
Installation
npm install mongoose mongoose-valid8 --saveUsage
import mongoose from 'mongoose'
import 'mongoose-valid8'
import {model, Schema} from 'mongoose'
const User = model('User', new Schema({
email: {
type: String,
email: true
}
}));
const user = new User({ email: 'invalidemail' });
user.validate((error) => {
expect(error).to.exist;
});
user.save((error) => {
expect(error).to.exist;
});Validations
String
email: Boolean
When set to true force value to be valid email address.
new Schema({
email: {
type: String,
email: true
}
});capitalize: Boolean
When set to true it converts the first character of string to upper case and the remaining to lower case.
new Schema({
firstName: {
type: String,
capitalize: true
}
});startcase: Boolean
When set to true converts string to start case(or title case).
new Schema({
name: {
type: String,
startcase: true
}
});macaddress: Boolean
When set to true force value to be valid macaddress.
new Schema({
address: {
type: String,
macaddress: true
}
});ip: Boolean
When set to true force value to be valid ip address.
new Schema({
address: {
type: String,
ip: true
}
});fqdn: Boolean
When set to true force value to be valid full qualified domain name.
new Schema({
address: {
type: String,
fqdn: true
}
});alpha: Boolean
When set to true force value to only contain alpha.
new Schema({
address: {
type: String,
alpha: true
}
});alphanumeric: Boolean
When set to true force value to contain only alphanumeric.
new Schema({
address: {
type: String,
aphanumeric: true
}
});md5: Boolean
When set to true force value to be valid md5 hash.
new Schema({
hash: {
type: String,
md5: true
}
});uuid: Boolean
When set to true force value to be valid uuid.
new Schema({
oid: {
type: String,
uuid: true
}
});creditcard: Boolean
When set to true force value to be valid credit card.
new Schema({
card: {
type: String,
creditcard: true
}
});base64: Boolean
When set to true force value to be valid base64 content.
new Schema({
url: {
type: String,
base64: true
}
});datauri: Boolean
When set to true force value to be valid data uri.
new Schema({
url: {
type: String,
datauri: true
}
});phone: Object|Boolean
When set it force value to be valid phone number.
new Schema({
phoneNumber: {
type: String,
phone: true
}
});
new Schema({
phoneNumber: {
type: String,
phone: {
countries: ['TZ', 'US'],
e164: true
}
}
});
new Schema({
phoneNumber: {
type: String,
phone: {
mobile: true,
e164: true
}
}
});
new Schema({
phoneNumber: {
type: String,
phone: {
fixedline: true
}
}
});mimetype: Boolean
When set to true force value to be mime type value.
new Schema({
mime: {
type: String,
mimetype: true
}
});url: Boolean
When set to true force value to be valid url.
new Schema({
address: {
type: String,
url: true
}
});jwt: Boolean
When set to true force value to be valid json web token.
new Schema({
address: {
type: String,
jwt: true
}
});hexadecimal: Boolean
When set to true force value to be valid hexadecimal value.
new Schema({
address: {
type: String,
hexadecimal: true
}
});hexacolor: Boolean
When set to true force value to be valid hexacolor value.
new Schema({
address: {
type: String,
hexacolor: true
}
});Number
numeric: Boolean
When set to true force value to be numeric.
new Schema({
value: {
type: Number,
numeric: true
}
});integer: Boolean
When set to true force value to be integer.
new Schema({
step: {
type: Number,
integer: true
}
});float: Boolean
When set to true force value to float.
new Schema({
price: {
type: Number,
float: true
}
});Array
empty: Boolean
When set to false force non empty array value.
new Schema({
email: {
type: [String],
empty: false
}
});compact: Boolean
When set to true will remove falsey values.
new Schema({
email: {
type: [String],
compact: true
}
})duplicate: Boolean|Function
When set to false or comparator will remove duplicate values.
new Schema({
to: {
type: [String],
duplicate: false
}
})
or
new Schema({
to: {
type: [String],
duplicate: (a, b) => a === b
}
})
sort: Boolean|String
When set to true, asc or desc create sorted elements.
new Schema({
to: {
type: [String],
sort: false
}
})
or
new Schema({
to: {
type: [String],
sort: 'desc'
}
})
Testing
Clone this repository
Install all development dependencies
npm install- Run example
npm run dev- Then run test
npm testContribute
It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.
License
The MIT License (MIT)
Copyright (c) CodeTanzania & Contributors
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:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.