Function SchemaDocumentArray

lib/schema/documentArray.js:42–91

* SubdocsArray SchemaType constructor * * @param {string} key * @param {Schema} schema * @param {object} options * @param {object} schemaOptions * @param {Schema} parentSchema * @inherits SchemaArray * @api public

(key, schema, options, schemaOptions, parentSchema)

 */

function SchemaDocumentArray(key, schema, options, schemaOptions, parentSchema) {
  if (schema.options?.timeseries) {
    throw new InvalidSchemaOptionError(key, 'timeseries');
  }
  const schemaTypeIdOption = SchemaDocumentArray.defaultOptions?._id;
  if (schemaTypeIdOption != null) {
    schemaOptions = schemaOptions || {};
    schemaOptions._id = schemaTypeIdOption;
  }

  if (schemaOptions?._id != null) {
    schema = handleIdOption(schema, schemaOptions);
  } else if (options?._id != null) {
    schema = handleIdOption(schema, options);
  }

  const Constructor = _createConstructor(schema, options);
  Constructor.prototype.$basePath = key;
  Constructor.path = key;

  const $parentSchemaType = this;
  const embeddedSchemaType = new DocumentArrayElement(key + '.$', schema, {
    ...(schemaOptions || {}),
    $parentSchemaType,
    Constructor
  });

  SchemaArray.call(this, key, embeddedSchemaType, options, null, parentSchema);

  this.schema = schema;
  // EmbeddedDocument schematype options
  this.schemaOptions = schemaOptions || {};
  this.$isMongooseDocumentArray = true;
  this.Constructor = Constructor;

  Constructor.base = schema.base;

  const fn = this.defaultValue;

  if (!('defaultValue' in this) || fn != null) {
    this.default(function() {
      let arr = fn.call(this);
      if (arr != null && !Array.isArray(arr)) {
        arr = [arr];
      }
      // Leave it up to `cast()` to convert this to a documentarray
      return arr;
    });
  }
}

/**
 * This schema type's name, to defend against minifiers that mangle