lib/schema/number.js
'use strict';
/*!
* Module requirements.
*/
var SchemaType = require('../schematype')
, CastError = SchemaType.CastError
, errorMessages = require('../error').messages;
/**
* Number SchemaType constructor.
*
* @param {String} key
* @param {Object} options
* @inherits SchemaType
* @api private
*/
function NumberSchema (key, options) {
SchemaType.call(this, key, options, 'Number');
}
/*!
* Inherits from SchemaType.
*/
NumberSchema.prototype = Object.create( SchemaType.prototype );
NumberSchema.prototype.constructor = NumberSchema;
/**
* Required validator for number
*
* @api private
*/
NumberSchema.prototype.checkRequired = function ( value ) {
if ( SchemaType._isRef( this, value ) ) {
return null != value;
} else {
return typeof value === 'number' || value instanceof Number;
}
};
/**
* Sets a minimum number validator.
*
* ####Example:
*
* var s = new Schema({ n: { type: Number, min: 10 })
* var M = db.model('M', s)
* var m = new M({ n: 9 })
* m.save(function (err) {
* console.error(err) // validator error
* m.n = 10;
* m.save() // success
* })
*
* // custom error messages
* // We can also use the special {MIN} token which will be replaced with the invalid value
* var min = [10, 'The value of path `{PATH}` ({VALUE}) is beneath the limit ({MIN}).'];
* var schema = new Schema({ n: { type: Number, min: min })
* var M = mongoose.model('Measurement', schema);
* var s= new M({ n: 4 });
* s.validate(function (err) {
* console.log(String(err)) // ValidationError: The value of path `n` (4) is beneath the limit (10).
* })
*
* @param {Number} value minimum number
* @param {String} [message] optional custom error message
* @return {SchemaType} this
* @see Customized Error Messages #error_messages_StorageError-messages
* @api public
*/
NumberSchema.prototype.min = function (value, message) {
if (this.minValidator) {
this.validators = this.validators.filter(function (v) {
return v.validator != this.minValidator;
}, this);
}
if (null != value) {
var msg = message || errorMessages.Number.min;
msg = msg.replace(/{MIN}/, value);
this.validators.push({
validator: this.minValidator = function (v) {
return v === null || v >= value;
},
message: msg,
type: 'min'
});
}
return this;
};
/**
* Sets a maximum number validator.
*
* ####Example:
*
* var s = new Schema({ n: { type: Number, max: 10 })
* var M = db.model('M', s)
* var m = new M({ n: 11 })
* m.save(function (err) {
* console.error(err) // validator error
* m.n = 10;
* m.save() // success
* })
*
* // custom error messages
* // We can also use the special {MAX} token which will be replaced with the invalid value
* var max = [10, 'The value of path `{PATH}` ({VALUE}) exceeds the limit ({MAX}).'];
* var schema = new Schema({ n: { type: Number, max: max })
* var M = mongoose.model('Measurement', schema);
* var s= new M({ n: 4 });
* s.validate(function (err) {
* console.log(String(err)) // ValidationError: The value of path `n` (4) exceeds the limit (10).
* })
*
* @param {Number} value maximum number
* @param {String} [message] optional custom error message
* @return {SchemaType} this
* @see Customized Error Messages #error_messages_StorageError-messages
* @api public
*/
NumberSchema.prototype.max = function (value, message) {
if (this.maxValidator) {
this.validators = this.validators.filter(function(v){
return v.validator != this.maxValidator;
}, this);
}
if (null != value) {
var msg = message || errorMessages.Number.max;
msg = msg.replace(/{MAX}/, value);
this.validators.push({
validator: this.maxValidator = function(v) {
return v === null || v <= value;
},
message: msg,
type: 'max'
});
}
return this;
};
/**
* Casts to number
*
* @param {Object} value value to cast
* @api private
*/
NumberSchema.prototype.cast = function ( value ) {
var val = value && value._id
? value._id // documents
: value;
if (!isNaN(val)){
if (null === val) return val;
if ('' === val) return null;
if ('string' === typeof val) val = Number(val);
if (val instanceof Number) return val;
if ('number' === typeof val) return val;
if (val.toString && !Array.isArray(val) &&
val.toString() == Number(val)) {
return new Number(val);
}
}
throw new CastError('number', value, this.path);
};
/*!
* Module exports.
*/
module.exports = NumberSchema;