SubdocumentPath

• SubdocumentPath()
• SubdocumentPath.get()
• SubdocumentPath.prototype.discriminator()
• SubdocumentPath.set()

SubdocumentPath()

Parameters:

• schema «Schema»
• path «String»
• options «Object»

Inherits:

• «SchemaType»

SubdocumentPath.get()

Parameters:

• getter «Function»

Returns:

• «this»

Type:

• «property»

SubdocumentPath.prototype.discriminator()

Parameters:

• name «String»
• schema «Schema» fields to add to the schema for instances of this sub-class

• [options] «Object|string» If string, same as options.value.

• [options.value] «String» the string stored in the discriminatorKey property. If not specified, Mongoose uses the name parameter.

• [options.clone=true] «Boolean» By default, discriminator() clones the given schema. Set to false to skip cloning.

Returns:

• «Function» the constructor Mongoose will use for creating instances of this discriminator model

See:

• discriminators

const shapeSchema = Schema({ name: String }, { discriminatorKey: 'kind' });
const schema = Schema({ shape: shapeSchema });

const singleNestedPath = parentSchema.path('shape');
singleNestedPath.discriminator('Circle', Schema({ radius: Number }));

SubdocumentPath.set()

Parameters:

• option «String» The option you'd like to set the value for

• value «Any» value for option

Returns:

• «void,void»

Type:

• «property»

// Make all numbers have option `min` equal to 0.
mongoose.Schema.SubdocumentPath.set('required', true);