• Public
  • Public/Protected
  • All

Interface FindOptions<TSchema>

Type parameters

  • TSchema: Document = Document

    Unused schema definition, deprecated usage, only specify FindOptions with no generic




allowDiskUse?: boolean

Allows disk use for blocking sort operations exceeding 100MB memory. (MongoDB 3.2 or higher)

allowPartialResults?: boolean

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.

authdb?: string
awaitData?: boolean

Specify if the cursor is a tailable-await cursor. Requires tailable to be true

batchSize?: number

Set the batchSize for the getMoreCommand when iterating over the query results.

bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.

bypassPinningCheck?: boolean
checkKeys?: boolean

the serializer will check if keys are valid.

collation?: CollationOptions

Specify collation (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields).

comment?: string | Document

You can put a $comment field on a query to make looking in the profiler logs simpler.

dbName?: string
enableUtf8Validation?: boolean

Enable utf8 validation when deserializing BSON documents. Defaults to true.

Specifies the verbosity mode for the explain output.

fieldsAsRaw?: Document

allow to specify if there what fields we wish to return as unserialized raw buffer.

fullResponse?: boolean

This option does nothing

hint?: Hint

Tell the query to use specific indexes in the query. Object of indexes to use, {'_id':1}

ignoreUndefined?: boolean

serialize will not emit undefined fields (default:true)

let?: Document

Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).

limit?: number

Sets the limit of documents returned in the query.

max?: Document

The exclusive upper bound for a specific index

maxAwaitTimeMS?: number

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

maxTimeMS?: number

Number of milliseconds to wait before aborting the query.

min?: Document

The inclusive lower bound for a specific index

noCursorTimeout?: boolean

The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.

noResponse?: boolean
omitReadPreference?: boolean
projection?: Document

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}

promoteBuffers?: boolean

when deserializing a Binary will return it as a node.js Buffer instance.

promoteLongs?: boolean

when deserializing a Long will fit it into a Number if it's smaller than 53 bits

promoteValues?: boolean

when deserializing will promote BSON values to their Node.js closest equivalent types.

raw?: boolean

Return BSON filled buffers from operations

readConcern?: ReadConcernLike

Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)

readPreference?: ReadPreferenceLike

The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).

retryWrites?: boolean

Should retry failed writes

returnKey?: boolean

If true, returns only the index keys in the resulting documents.

serializeFunctions?: boolean

serialize the javascript functions (default:false).

session?: ClientSession

Specify ClientSession for this command

showRecordId?: boolean

Determines whether to return the record identifier for each document. If true, adds a field $recordId to the returned documents.

singleBatch?: boolean

Determines whether to close the cursor after the first batch. Defaults to false.

skip?: number

Set to skip N documents ahead in your query (useful for pagination).

sort?: Sort

Set to sort the documents coming back from the query. Array of indexes, [['a', 1]] etc.

tailable?: boolean

Specify if the cursor is tailable.

timeout?: boolean

Specify if the cursor can timeout.

willRetryWrites?: boolean

Write Concern as an object

Generated using TypeDoc