SchemaObjectId

ObjectId スキーマタイプコンストラクタ。

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 インスタンスにゲッターをアタッチします

例

// 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'

任意の値をオブジェクト ID にキャストするために使用される関数を取得/設定します。

例

// 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);

turnOn が true の場合に、自動生成された ObjectId 既定値を追加します。

指定された値が必須のバリデータを満たしているかどうかを確認します。

このスキーマタイプの名前であり、関数名を変更する難読化ツールからの防御に使用されます。

すべての 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.