Spec-Zone.ru › Mongoose

SchemaBoolean

SchemaBoolean()

Параметры:
  • path «String»
  • options «Object»
Наследует:
  • «SchemaType»

Конструктор типа схемы Boolean.

SchemaBoolean.checkRequired()

Параметры:
  • fn «Function»
Возвращает:
  • «Function»
Тип:
  • «property»

Переопределяет функцию, используемую валидатором обязательности для проверки, проходит ли булево значение проверку required.

SchemaBoolean.convertToFalse

Тип:
  • «Set»

Настройка значений, которые преобразуются в false.

Пример:

const M = mongoose.model('Test', new Schema({ b: Boolean }));
new M({ b: 'nay' }).b; // undefined
mongoose.Schema.Types.Boolean.convertToFalse.add('nay');
new M({ b: 'nay' }).b; // false

SchemaBoolean.convertToTrue

Тип:
  • «Set»

Настройка значений, которые преобразуются в true.

Пример:

const M = mongoose.model('Test', new Schema({ b: Boolean }));
new M({ b: 'affirmative' }).b; // undefined
mongoose.Schema.Boolean.convertToTrue.add('affirmative');
new M({ b: 'affirmative' }).b; // true

SchemaBoolean.get()

Параметры:
  • getter «Function»
Возвращает:
  • «this»
Тип:
  • «property»

Присоединяет getter для всех экземпляров Boolean.

Пример:

mongoose.Schema.Boolean.get(v => v === true ? 'yes' : 'no');

const Order = mongoose.model('Order', new Schema({ isPaid: Boolean }));
new Order({ isPaid: false }).isPaid; // 'no'

SchemaBoolean.get()

Параметры:
  • caster «Function»
Возвращает:
  • «Function»
Тип:
  • «property»

Получение/установка функции, используемой для преобразования произвольных значений в булевы значения.

Пример:

// Make Mongoose cast empty string '' to false.
const original = mongoose.Schema.Boolean.cast();
mongoose.Schema.Boolean.cast(v => {
  if (v === '') {
    return false;
  }
  return original(v);
});

// Or disable casting entirely
mongoose.Schema.Boolean.cast(false);

SchemaBoolean.prototype.checkRequired()

Параметры:
  • value «Any»
Возвращает:
  • «Boolean»

Проверка, удовлетворяет ли заданное значение валидатору обязательности. Для того, чтобы булево значение удовлетворяло валидатору обязательности, оно должно быть строго равно true или false.

SchemaBoolean.schemaName

Тип:
  • «property»

Имя этого типа схемы, для защиты от минификаторов, искажающих имена функций.

SchemaBoolean.set()

Параметры:
  • option «String» Желаемое значение для настройки опции
  • value «Any» Значение опции
Возвращает:
  • «undefined,void»
Тип:
  • «property»

Устанавливает значение опции по умолчанию для всех экземпляров Boolean.

Пример:

// Make all booleans have `default` of false.
mongoose.Schema.Boolean.set('default', false);

const Order = mongoose.model('Order', new Schema({ isPaid: Boolean }));
new Order({ }).isPaid; // false

© 2010 LearnBoost
Licensed under the MIT License.
https://mongoosejs.com/docs/api/schemaboolean.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API