Spec-Zone.ru › Mongoose

SchemaObjectid

ObjectId()

Parameters:
  • key «String»
  • options «Object»
Inherits:
  • «SchemaType»

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

ObjectId.checkRequired()

Parameters:
  • fn «Function»
Returns:
  • «Function»
Type:
  • «property»

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

Пример:

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

const M = mongoose.model({ str: { type: String, required: true } });
new M({ str: '' }).validateSync(); // `null`, validation passes!

ObjectId.get()

Parameters:
  • getter «Function»
Returns:
  • «this»
Type:
  • «property»

Прикрепляет геттер для всех экземпляров ObjectId.

Пример:

// Always convert to string when getting an ObjectId
mongoose.ObjectId.get(v => v.toString());

const Model = mongoose.model('Test', new Schema({}));
typeof (new Model({})._id); // 'string'

ObjectId.get()

Parameters:
  • caster «Function»
Returns:
  • «Function»
Type:
  • «property»

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

Пример:

// Make Mongoose only try to cast length 24 strings. By default, any 12
// char string is a valid ObjectId.
const original = mongoose.ObjectId.cast();
mongoose.ObjectId.cast(v => {
  assert.ok(typeof v !== 'string' || v.length === 24);
  return original(v);
});

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

ObjectId.prototype.auto()

Parameters:
  • turnOn «Boolean» auto сгенерированные ObjectId по умолчанию
Returns:
  • «SchemaType» this

Добавляет автосгенерированный ObjectId по умолчанию, если turnOn true.

ObjectId.prototype.checkRequired()

Parameters:
  • value «Any»
  • doc «Document»
Returns:
  • «Boolean»

Проверяет, удовлетворяет ли заданное значение валидатору обязательности.

ObjectId.schemaName

Type:
  • «property»

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

ObjectId.set()

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

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

Пример:

// Make all object ids have option `required` equal to true.
mongoose.Schema.ObjectId.set('required', true);

const Order = mongoose.model('Order', new Schema({ userId: ObjectId }));
new Order({ }).validateSync().errors.userId.message; // Path `userId` is required.

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

Spec-Zone.ru

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