Interface VirtualTypeOptions<HydratedDocType, DocType>

If ref is not nullish, this becomes a populated virtual.

The local field to populate on if this is a populated virtual.

The foreign field to populate on if this is a populated virtual.

By default, a populated virtual is an array. If you set justOne, the populated virtual will be a single doc or null.

If you set this to true, Mongoose will call any custom getters you defined on this virtual.

If you set this to true, populate() will set this virtual to the number of populated documents, as opposed to the documents themselves, using Query#countDocuments().

Add an extra match condition to populate().

Add a default limit to the populate() query.

Add a default skip to the populate() query.

For legacy reasons, limit with populate() may give incorrect results because it only executes a single query for every document being populated. If you set perDocumentLimit, Mongoose will ensure correct limit per document by executing a separate query for each document to populate(). For example, .find().populate({ path: 'test', perDocumentLimit: 2 }) will execute 2 additional queries if .find() returns 2 documents.

Additional options like limit and lean.