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はその関数を実行し、戻り値をデフォルトとして使用します。

truthyの場合、ドキュメントが最初にデータベースに保存された後、Mongooseはこのパスの変更を許可しません。Mongooseの不変性について詳しくはこちらをご覧ください。

truthyの場合、モデルがコンパイルされるときに、Mongooseはこのパスにインデックスを作成します。

このパスをポピュレートする場合にpopulate()が使用するモデル。

populate()が使用するモデルを検索するために使用する必要があるドキュメント内のパス。

trueの場合、このパスに必須バリデーターをアタッチします。これにより、このパスがnullish値に設定されないようにします。関数である場合、Mongooseはその関数を呼び出し、関数がtruthy値を返す場合にのみnullish値をチェックします。

find()、findOne()などを使用してドキュメントをロードするときに、このパスをデフォルトで含めるか除外するか。

truthyの場合、Mongooseはこのパスにスパースインデックスを作成します。

truthyの場合、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

このパスをキャストする型。

truthyの場合、モデルがコンパイルされるときに、Mongooseはこのパスに一意のインデックスを作成します。uniqueオプションはバリデーターではありません。

このスキーマタイプを検証する方法を記述する関数またはオブジェクト。