SchemaArray
SchemaArray()
SchemaArray.checkRequired()
SchemaArray.get()
SchemaArray.options
SchemaArray.prototype.checkRequired()
SchemaArray.prototype.enum()
SchemaArray.schemaName
SchemaArray.set()
SchemaArray()
参数
key
«字符串»cast
«模式类型»options
«对象»schemaOptions
«对象»
继承
数组模式类型构造函数
SchemaArray.checkRequired()
参数
fn
«函数»
返回值
- «函数»
覆盖必需验证器用来检查数组是否通过必需检查的函数。
示例
// Require non-empty array to pass `required` check
mongoose.Schema.Types.Array.checkRequired(v => Array.isArray(v) && v.length);
const M = mongoose.model({ arr: { type: Array, required: true } });
new M({ arr: [] }).validateSync(); // `null`, validation fails!
SchemaArray.get()
参数
getter
«函数»
返回值
- «this»
类型
- «属性»
为所有数组实例附加一个 getter
SchemaArray.options
类型
- «属性»
所有数组的选项。
castNonArrays
: 默认值为true
。如果为false
,则 Mongoose 会在值不是数组时抛出 CastError。如果为true
,则 Mongoose 会在强制转换之前将提供的值包装在数组中。
SchemaArray.prototype.checkRequired()
参数
value
«任何»doc
«文档»
返回值
- «布尔值»
检查给定值是否满足必需验证器。
SchemaArray.prototype.enum()
参数
[...args]
«字符串|对象» 枚举值
返回值
- «SchemaArray» this
如果这是字符串或数字的数组,则添加枚举验证器。等效于 SchemaString.prototype.enum()
或 SchemaNumber.prototype.enum()
SchemaArray.schemaName
类型
- «属性»
此模式类型的名称,以防御混淆函数名称的混淆器。
SchemaArray.set()
参数
option
«字符串» 你想设置值的选项value
«任何» 选项的值
返回值
- «未定义,无效»
为所有数组实例设置默认选项。
示例
// Make all Array instances have `required` of true by default.
mongoose.Schema.Array.set('required', true);
const User = mongoose.model('User', new Schema({ test: Array }));
new User({ }).validateSync().errors.test.message; // Path `test` is required.