SchemaSubdocument
SchemaSubdocument()
SchemaSubdocument.get()
SchemaSubdocument.prototype.discriminator()
SchemaSubdocument.set()
SchemaSubdocument()
パラメータ
schema
«スキーマ»パス
«文字列»オプション
«オブジェクト»
継承する
単一のネストされたサブドキュメントスキーマタイプコンストラクタ。
SchemaSubdocument.get()
パラメータ
ゲッター
«関数»
返値
- «this»
タイプ
- «プロパティ»
すべてのサブドキュメントインスタンスのゲッターをアタッチします
SchemaSubdocument.prototype.discriminator()
パラメータ
名前
«文字列»スキーマ
«スキーマ» このサブクラスのインスタンスのスキーマに追加するフィールド[オプション]
«オブジェクト|文字列» 文字列の場合は、options.value
と同じ[オプション.value]
«文字列»discriminatorKey
プロパティに格納される文字列。指定しない場合、Mongooseはname
パラメータを使用します。[オプション.clone=true]
«ブール値» デフォルトでは、discriminator()
は指定されたschema
を複製します。複製をスキップするには、false
に設定します。
返値
- «関数» Mongooseがこの識別子モデルのインスタンスを作成するために使用するコンストラクタ
参照してください
識別子をこの単一のネストされたサブドキュメントに追加します。
例
const shapeSchema = Schema({ name: String }, { discriminatorKey: 'kind' });
const schema = Schema({ shape: shapeSchema });
const singleNestedPath = parentSchema.path('shape');
singleNestedPath.discriminator('Circle', Schema({ radius: Number }));
SchemaSubdocument.set()
パラメータ
オプション
«文字列» 値を設定したいオプション値
«任意» オプションの値
返値
- «void,void»
タイプ
- «プロパティ»
すべてのサブドキュメントインスタンスのデフォルトオプションを設定します。
例
// Make all numbers have option `min` equal to 0.
mongoose.Schema.Subdocument.set('required', true);