MongoFindOptions <T>

Options for MongoDB find operations.

Hierarchy

• MongoQueryOptions
  • MongoFindOptions

Index

Properties

• allowDiskUse
• chunkSize
• collation
• ctx
• fields
• indexHint
• limit
• loggerContext
• maxTimeMS
• offset
• orderBy
• signal

Properties

optionalinheritedallowDiskUse

allowDiskUse?: boolean

Inherited from MongoQueryOptions.allowDiskUse

optionalchunkSize

chunkSize?: number

optionalinheritedcollation

collation?: CollationOptions

Inherited from MongoQueryOptions.collation

optionalctx

ctx?: ClientSession

optionalfields

fields?: string[]

optionalinheritedindexHint

indexHint?: string | Dictionary

Inherited from MongoQueryOptions.indexHint

optionallimit

limit?: number

optionalloggerContext

loggerContext?: LoggingOptions

optionalinheritedmaxTimeMS

maxTimeMS?: number

Inherited from MongoQueryOptions.maxTimeMS

optionaloffset

offset?: number

optionalorderBy

orderBy?: QueryOrderMap<T> | QueryOrderMap<T>[]

optionalinheritedsignal

signal?: AbortSignal

Inherited from MongoQueryOptions.signal

Forwarded to the MongoDB driver. When fired, the driver aborts the in-flight operation by closing the underlying socket; the rejection reason is signal.reason.