S

Loading…

Interface

FindOptions

interface FindOptions<TDocument extends object = Document, TProjection extends Projection<TDocument> | undefined = undefined> extends QueryBudgetOptions

Defined in packages/driver/src/collection.ts:88

Hierarchy

Properties#

P

maxTimeMS

#
readonly maxTimeMS?: number

The most milliseconds the server may spend on the request. The server looks at the clock while it examines documents, so a limit can be passed by a little before the request stops, and a long sort or group is not interrupted once its documents are read. A positive integer.

This is separate from the client's requestTimeoutMS, which gives up waiting for the answer. Keep requestTimeoutMS larger than maxTimeMS, or the client may stop waiting first.

Inherited from QueryBudgetOptions.maxTimeMS

Defined in packages/driver/src/budget.ts:22

P

projection

#
readonly projection?: TProjection

The fields to return. See Projection. It is applied after sorting, so a query can sort by a field it does not return. The cursor's result type follows the projection when it is written inline.

Defined in packages/driver/src/collection.ts:110

P

sort

#
readonly sort?: Sort<TDocument>

Sort order as [path, direction] pairs, where direction is 1 for ascending and -1 for descending. Earlier pairs take priority.

Defined in packages/driver/src/collection.ts:100

Used by#