SingleNestedPath


SingleNestedPath()

Parameters
  • schema «Schema»
  • key «String»
  • options «Object»
Inherits:
  • «SchemaType»

Single nested subdocument SchemaType constructor.


SingleNestedPath.prototype.discriminator()

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

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

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

Adds a discriminator to this single nested subdocument.

Example:

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

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