when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing a Binary will return it as a node.js Buffer instance.
when deserializing will promote BSON values to their Node.js closest equivalent types.
allow to specify if there what fields we wish to return as unserialized raw buffer.
return BSON regular expressions as BSONRegExp instances.
the serializer will check if keys are valid.
serialize the javascript functions (default:false).
serialize will not emit undefined fields (default:true)
Enabling 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:
Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
Comment 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.
Should retry failed writes
Specifies the verbosity mode for the explain output.
Sets the limit of documents returned in the query.
Set to sort the documents coming back from the query. Array of indexes, [['a', 1]] etc.
The 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}
Set to skip N documents ahead in your query (useful for pagination).
Tell the query to use specific indexes in the query. Object of indexes to use, {'_id':1}
Specify if the cursor can timeout.
Specify if the cursor is tailable.
Specify if the cursor is a tailable-await cursor. Requires tailable to be true
Set the batchSize for the getMoreCommand when iterating over the query results.
If true, returns only the index keys in the resulting documents.
The inclusive lower bound for a specific index
The exclusive upper bound for a specific index
Number of milliseconds to wait before aborting the query.
The 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
The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.
Specify collation (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields).
Allows disk use for blocking sort operations exceeding 100MB memory. (MongoDB 3.2 or higher)
Determines whether to close the cursor after the first batch. Defaults to false.
For 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.
Determines whether to return the record identifier for each document. If true, adds a field $recordId to the returned documents.
Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).
Option to enable an optimized code path for queries looking for a particular range of ts values in the oplog. Requires tailable to be true.
Specify ClientSession for this command
The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).
Write Concern as an object
Generated using TypeDoc
Unused schema definition, deprecated usage, only specify
FindOptionswith no generic