SchemaArray


SchemaArray()

パラメーター
  • key «文字列»
  • cast «SchemaType»
  • options «オブジェクト»
  • schemaOptions «オブジェクト»
継承

配列スキーマタイプコンストラクタ


SchemaArray.checkRequired()

パラメーター
  • fn «関数»
返還値
  • «関数»

配列が必要なチェックをパスするかどうかを確認するために、必要なバリデーターが使用する関数をオーバーライドします。

// Require non-empty array to pass `required` check
mongoose.Schema.Types.Array.checkRequired(v => Array.isArray(v) && v.length);

const M = mongoose.model({ arr: { type: Array, required: true } });
new M({ arr: [] }).validateSync(); // `null`, validation fails!

SchemaArray.get()

パラメーター
  • getter «関数»
返還値
  • «this»
タイプ
  • «プロパティ»

すべての配列インスタンスのゲッターをアタッチします


SchemaArray.options

タイプ
  • «プロパティ»

すべての配列のオプションです。

  • castNonArrays: デフォルトではtrueです。falseの場合、値が配列ではない場合、MongooseはCastErrorを送出します。trueの場合、Mongooseはキャストする前に、提供された値を配列でラップします。

SchemaArray.prototype.checkRequired()

パラメーター
  • value «任意»
  • doc «ドキュメント»
返還値
  • «ブール型»

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


SchemaArray.prototype.enum()

パラメーター
  • [...args] «文字列|オブジェクト» 列挙値

返還値
  • «SchemaArray» this

文字列または数字の配列の場合、enumバリデーターを追加します。SchemaString.prototype.enum()またはSchemaNumber.prototype.enum()と同等のものです


SchemaArray.schemaName

タイプ
  • «プロパティ»

このスキーマタイプの名前は、関数名を加工するミニアファイアに対する防御に使用されます。


SchemaArray.set()

パラメーター
  • option «文字列» 値を設定するオプション

  • value «任意» オプションの値

返還値
  • «未定義、void»

すべての配列インスタンスの既定のオプションを設定します。

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

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