Optional allowAllows disk use for blocking sort operations exceeding 100MB memory. (MongoDB 3.2 or higher)
Optional allowFor queries against a sharded collection, allows the command (or subsequent getMore commands) to return partial results, rather than an error, if one or more queried shards are unavailable.
Optional authdbOptional awaitSpecify if the cursor is a tailable-await cursor. Requires tailable to be true
Optional batchSet the batchSize for the getMoreCommand when iterating over the query results.
Optional bsonreturn BSON regular expressions as BSONRegExp instances.
false
Optional checkthe serializer will check if keys are valid.
false
Optional collationSpecify collation (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields).
Optional commentComment to apply to the operation.
In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
Optional dbOptional enableEnable utf8 validation when deserializing BSON documents. Defaults to true.
Optional explainSpecifies the verbosity mode for the explain output.
Optional fieldsallow to specify if there what fields we wish to return as unserialized raw buffer.
null
Optional hintTell the query to use specific indexes in the query. Object of indexes to use, {'_id':1}
Optional ignoreserialize will not emit undefined fields
note that the driver sets this to false
true
Optional letMap of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).
Optional limitSets the limit of documents returned in the query.
Optional maxThe exclusive upper bound for a specific index
Optional maxThe maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. Requires tailable and awaitData to be true
Optional maxNumber of milliseconds to wait before aborting the query.
Optional minThe inclusive lower bound for a specific index
Optional noThe server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.
Optional noOptional omitOptional oplogOption to enable an optimized code path for queries looking for a particular range of ts values in the oplog. Requires tailable to be true.
Starting from MongoDB 4.4 this flag is not needed and will be ignored.
Optional projectionThe fields to return in the query. Object of fields to either include or exclude (one of, not both), {'a':1, 'b': 1} or {'a': 0, 'b': 0}
Optional promotewhen deserializing a Binary will return it as a node.js Buffer instance.
false
Optional promotewhen deserializing a Long will fit it into a Number if it's smaller than 53 bits.
true
Optional promotewhen deserializing will promote BSON values to their Node.js closest equivalent types.
true
Optional rawEnabling the raw option will return a Node.js Buffer which is allocated using allocUnsafe API. See this section from the Node.js Docs here for more detail about what "unsafe" refers to in this context. If you need to maintain your own editable clone of the bytes returned for an extended life time of the process, it is recommended you allocate your own buffer and clone the contents:
const raw = await collection.findOne({}, { raw: true });
const myBuffer = Buffer.alloc(raw.byteLength);
myBuffer.set(raw, 0);
// Only save and use `myBuffer` beyond this point
Please note there is a known limitation where this option cannot be used at the MongoClient level (see NODE-3946).
It does correctly work at Db, Collection, and per operation the same as other BSON options work.
Optional readSpecify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
Optional readThe preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).
Optional retryShould retry failed writes
Optional returnIf true, returns only the index keys in the resulting documents.
Optional serializeserialize the javascript functions
false
Optional sessionSpecify ClientSession for this command
Optional showDetermines whether to return the record identifier for each document. If true, adds a field $recordId to the returned documents.
Optional singleDetermines whether to close the cursor after the first batch. Defaults to false.
Optional skipSet to skip N documents ahead in your query (useful for pagination).
Optional sortSet to sort the documents coming back from the query. Array of indexes, [['a', 1]] etc.
Optional tailableSpecify if the cursor is tailable.
Optional timeoutSpecify if the cursor can timeout.
Optional usewhen deserializing a Long return as a BigInt.
false
Optional willGenerated using TypeDoc
Unused schema definition, deprecated usage, only specify
FindOptionswith no generic