Массив схем
SchemaArray()
Параметры:
-
key«Строка» -
cast«Тип схемы» -
options«Объект» -
schemaOptions«Объект»
Наследует:
Конструктор типа схемы массива
SchemaArray.checkRequired()
Параметры:
-
fn«Функция»
Возвращает:
- «Функция»
Переопределяет функцию, которую использует валидатор обязательности, чтобы проверить, проходит ли массив проверку required.
Пример:
// 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«Функция»
Возвращает:
- «это»
Тип:
- «свойство»
Присоединяет геттер для всех экземпляров массивов
SchemaArray.options
Тип:
- «свойство»
Параметры для всех массивов.
-
castNonArrays:trueпо умолчанию. Еслиfalse, Mongoose выбросит CastError, если значение не является массивом. Еслиtrue, Mongoose обернёт предоставленное значение в массив перед преобразованием.
SchemaArray.prototype.checkRequired()
Параметры:
-
value«Любое» -
doc«Документ»
Возвращает:
- «Булево»
Проверяет, удовлетворяет ли заданное значение валидатору required.
SchemaArray.prototype.enum()
Параметры:
-
[...args]«Строка|Объект» значения перечисления
Возвращает:
- «SchemaArray» это
Добавляет валидатор перечисления, если это массив строк или чисел. Эквивалентно 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.
© 2010 LearnBoost
Licensed under the MIT License.
https://mongoosejs.com/docs/api/schemaarray.html