Optional
countWhich property(on the ref-Class) to match localField
against
Optional
gettersIf you set this to true
, Mongoose will call any custom getters you defined on this virtual.
Note: Copied from mongoose's "index.d.ts"#VirtualTypeOptions
Optional
justReturn as One Document(true) or as Array(false)
Optional
limitAdd a default limit
to the populate()
query.
Note: Copied from mongoose's "index.d.ts"#VirtualTypeOptions
Which property(on the current-Class) to match foreignField
against
Optional
matchMatch Options
Optional
virtual: VirtualTypeOptions<mongoose.Document<any, any, any>, unknown>Optional
Optional
optionsExtra Query Options
Optional
match?: AnyObjectOptional
perFor 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.
Note: Copied from mongoose's "index.d.ts"#VirtualTypeOptions
Reference another Document (Ref
Optional
skipAdd a default skip
to the populate()
query.
Note: Copied from mongoose's "index.d.ts"#VirtualTypeOptions
Generated using TypeDoc
Return the number of Documents found instead of the actual Documents