SchemaDocumentArray
SchemaDocumentArray()SchemaDocumentArray.get()SchemaDocumentArray.optionsSchemaDocumentArray.prototype.discriminator()SchemaDocumentArray.schemaNameSchemaDocumentArray.set()
SchemaDocumentArray()
パラメータ
key«文字列»スキーマ«スキーマ»オプション«オブジェクト»schemaOptions«オブジェクト»
継承
SubdocsArray SchemaType コンストラクター
SchemaDocumentArray.get()
パラメータ
ゲッター«関数»
返り値
- «this»
タイプ
- «プロパティ»
すべての DocumentArrayPath インスタンスのゲットアタッチ
SchemaDocumentArray.options
タイプ
- «プロパティ»
ドキュメントアレイのすべてのオプション
castNonArrays: 既定値はtrue。falseの場合、Mongoose は値が配列でないときに CastError をスローします。trueの場合、Mongoose は配列をキャストする前に、提供された値を配列内にラップします。
SchemaDocumentArray.prototype.discriminator()
パラメータ
name«文字列»スキーマ«スキーマ» このサブクラスのインスタンスに対するスキーマに追加されるフィールド[オプション]«オブジェクト|文字列» 文字列の場合、options.valueと同じです。[options.value]«文字列»discriminatorKeyプロパティに格納される文字列。指定されていない場合、Mongoose はnameパラメータを使用します。[options.clone=true]«boolean» 既定では、discriminator()は指定されたschemaを複製します。複製をスキップするにはfalseに設定します。
返り値
- «関数» この識別子モデルのインスタンスの作成に Mongoose が使用するコンストラクター
参照
このドキュメントアレイに識別子を追加します。
例
const shapeSchema = Schema({ name: String }, { discriminatorKey: 'kind' });
const schema = Schema({ shapes: [shapeSchema] });
const docArrayPath = parentSchema.path('shapes');
docArrayPath.discriminator('Circle', Schema({ radius: Number }));SchemaDocumentArray.schemaName
タイプ
- «プロパティ»
このスキーマタイプの名前は、関数の名前を操作するミニファイアに対して防御します。
SchemaDocumentArray.set()
パラメータ
オプション«文字列» 設定するオプションの名前 (例: トリム、小文字、など)値«任意» 設定するオプションの値
返り値
- «void,void»
タイプ
- «プロパティ»
すべての DocumentArray インスタンスのデフォルトオプションを設定します。
例
// Make all numbers have option `min` equal to 0.
mongoose.Schema.DocumentArray.set('_id', false);