DocumentArrayPath
DocumentArrayPath()
DocumentArrayPath.options
DocumentArrayPath.prototype.discriminator()
DocumentArrayPath.schemaName
DocumentArrayPath.set()
DocumentArrayPath()
Parameters:
key
«String»schema
«Schema»options
«Object»schemaOptions
«Object»
Inherits:
SubdocsArray SchemaType constructor
DocumentArrayPath.options
Type:
- «property»
Options for all document arrays.
castNonArrays
:true
by default. Iffalse
, Mongoose will throw a CastError when a value isn't an array. Iftrue
, Mongoose will wrap the provided value in an array before casting.
DocumentArrayPath.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 asoptions.value
.[options.value]
«String» the string stored in thediscriminatorKey
property. If not specified, Mongoose uses thename
parameter.[options.clone=true]
«Boolean» By default,discriminator()
clones the givenschema
. Set tofalse
to skip cloning.
Returns:
- «Function» the constructor Mongoose will use for creating instances of this discriminator model
See:
Adds a discriminator to this document array.
Example:
const shapeSchema = Schema({ name: String }, { discriminatorKey: 'kind' });
const schema = Schema({ shapes: [shapeSchema] });
const docArrayPath = parentSchema.path('shapes');
docArrayPath.discriminator('Circle', Schema({ radius: Number }));
DocumentArrayPath.schemaName
Type:
- «property»
This schema type's name, to defend against minifiers that mangle function names.
DocumentArrayPath.set()
Parameters:
option
«String» The name of the option you'd like to set (e.g. trim, lowercase, etc...)value
«Any» The value of the option you'd like to set.
Returns:
- «void,void»
Type:
- «property»
Sets a default option for all DocumentArray instances.
Example:
// Make all numbers have option `min` equal to 0.
mongoose.Schema.DocumentArray.set('_id', false);