Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FindOneAndReplaceOptions

Hierarchy

Index

Properties

authdb?: string
bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.

bypassDocumentValidation?: boolean

Allow driver to bypass schema validation in MongoDB 3.2 or higher.

checkKeys?: boolean

the serializer will check if keys are valid.

collation?: CollationOptions

Collation

comment?: unknown

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.

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
deprecated

This option does nothing

hint?: Document

An optional hint for query optimization. See the update command reference for more information.

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).

maxTimeMS?: number
noResponse?: boolean
omitReadPreference?: boolean
projection?: Document

Limits the fields to return for all matching documents.

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

returnDocument?: ReturnDocument

When set to 'after', returns the updated document rather than the original. The default is 'before'.

serializeFunctions?: boolean

serialize the javascript functions (default:false).

session?: ClientSession

Specify ClientSession for this command

sort?: Sort

Determines which document the operation modifies if the query selects multiple documents.

upsert?: boolean

Upsert the document if it does not exist.

willRetryWrite?: boolean

Write Concern as an object

Generated using TypeDoc