SchemaTypeOptions

Параметры, определённые для типа схемы.

Пример:

const schema = new Schema({ name: String });
schema.path('name').options instanceof mongoose.SchemaTypeOptions; // true

Позволяет переопределить логику преобразования для данного пути. Если строка, данная строка переписывает стандартное сообщение об ошибке преобразования Mongoose.

Пример:

const schema = new Schema({
  num: {
    type: Number,
    cast: '{VALUE} is not a valid number'
  }
});

// Throws 'CastError: "bad" is not a valid number'
schema.path('num').cast('bad');

const Model = mongoose.model('Test', schema);
const doc = new Model({ num: 'fail' });
const err = doc.validateSync();

err.errors['num']; // 'CastError: "fail" is not a valid number'

Значение по умолчанию для этого пути. Если функция, Mongoose выполняет функцию и использует возвращаемое значение в качестве значения по умолчанию.

Если истинно, Mongoose запретит изменения этому пути после первого сохранения документа в базе данных. Подробнее об иммутабельности в Mongoose.

Если истинно, Mongoose создаст индекс по этому пути при компиляции модели.

Модель, которую populate() должен использовать для заполнения этого пути.

Путь в документе, который populate() должен использовать для поиска модели.

Если true, добавляет валидатор обязательности к этому пути, который гарантирует, что этот путь не может быть установлен в значение null или undefined. Если функция, Mongoose вызывает функцию и проверяет только значения null и undefined, если функция возвращает истинное значение.

Включать или исключать этот путь по умолчанию при загрузке документов с помощью find(), findOne(), и т.д.

Если истинно, Mongoose создаст разреженный индекс по этому пути.

Если истинно, Mongoose создаст индекс типа «полный текст» по этому пути.

Определяет функцию преобразования для данного типа схемы. Вызывается только при вызове toJSON() или toObject().

Пример:

const schema = Schema({
  myDate: {
    type: Date,
    transform: v => v.getFullYear()
  }
});
const Model = mongoose.model('Test', schema);

const doc = new Model({ myDate: new Date('2019/06/01') });
doc.myDate instanceof Date; // true

const res = doc.toObject({ transform: true });
res.myDate; // 2019

Тип, к которому необходимо преобразовать этот путь.

Если истинно, Mongoose создаст уникальный индекс по этому пути при компиляции модели. Параметр unique не является валидатором.

Функция или объект, описывающий, как валидировать этот тип схемы.