Spec-Zone.ru › Mongoose

SchemaBuffer

SchemaBuffer()

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

Конструктор SchemaType для буфера

SchemaBuffer.checkRequired()

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

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

Пример:

// Allow empty strings to pass `required` check
mongoose.Schema.Types.String.checkRequired(v => v != null);

const M = mongoose.model({ buf: { type: Buffer, required: true } });
new M({ buf: Buffer.from('') }).validateSync(); // validation passes!

SchemaBuffer.get()

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

Прикрепляет метод получения для всех экземпляров буфера.

Пример:

// Always convert to string when getting an ObjectId
mongoose.Schema.Types.Buffer.get(v => v.toString('hex'));

const Model = mongoose.model('Test', new Schema({ buf: Buffer } }));
typeof (new Model({ buf: Buffer.fromString('hello') }).buf); // 'string'

SchemaBuffer.prototype.checkRequired()

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

Проверяет, удовлетворяет ли заданное значение валидатору обязательности. Для удовлетворения валидатора обязательности буфер не должен быть null или undefined и иметь ненулевую длину.

SchemaBuffer.prototype.subtype()

Параметры:
  • subtype «Number» значение по умолчанию
Возвращает:
  • «SchemaType» this

Устанавливает значение по умолчанию subtype для этого буфера. Список допустимых значений subtype вы можете найти здесь.

Пример:

const s = new Schema({ uuid: { type: Buffer, subtype: 4 });
const M = db.model('M', s);
const m = new M({ uuid: 'test string' });
m.uuid._subtype; // 4

SchemaBuffer.schemaName

Тип:
  • «property»

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

SchemaBuffer.set()

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

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

Пример:

// Make all buffers have `required` of true by default.
mongoose.Schema.Buffer.set('required', true);

const User = mongoose.model('User', new Schema({ test: Buffer }));
new User({ }).validateSync().errors.test.message; // Path `test` is required.

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

Spec-Zone.ru

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