diff --git a/docs/Next/classes/AbstractCursor.html b/docs/Next/classes/AbstractCursor.html index 48ecb1cea34..c338ffa1c4f 100644 --- a/docs/Next/classes/AbstractCursor.html +++ b/docs/Next/classes/AbstractCursor.html @@ -303,7 +303,7 @@
Abstract
Returns AbstractCursor<TSchema, AbstractCursorEvents>
const<
Static
addStatic
addOptional
options: { Optional
cause?: unknownOverrides Binary.createFromBase64
Static
createOverrides Binary.createFromHexString
Static
generateStatic
Static
isInherited from AbstractCursor.forEach
Inherited from AbstractCursor.hasNext
Inherited from AbstractCursor.next
Inherited from AbstractCursor.rewind
Inherited from AbstractCursor.toArray
Inherited from AbstractCursor.tryNext
Inherited from AbstractCursor.withReadConcern
Inherited from AbstractCursor.withReadPreference
Static
addStatic
fromStatic
fromStatic
fromInherited from AbstractCursor.forEach
Inherited from AbstractCursor.hasNext
const<
Inherited from AbstractCursor.map
-- Defined in src/cursor/abstract_cursor.ts:500
Inherited from AbstractCursor.maxTimeMS
Inherited from AbstractCursor.next
Inherited from AbstractCursor.rewind
Inherited from AbstractCursor.toArray
Inherited from AbstractCursor.tryNext
Inherited from AbstractCursor.withReadConcern
Inherited from AbstractCursor.withReadPreference
Static
addInherited from AbstractCursor.addCursorFlag
Inherited from AbstractCursor.batchSize
Inherited from AbstractCursor.close
Inherited from AbstractCursor.forEach
Inherited from AbstractCursor.hasNext
const<
Inherited from AbstractCursor.map
-- Defined in src/cursor/abstract_cursor.ts:500
Inherited from AbstractCursor.maxTimeMS
Inherited from AbstractCursor.next
Inherited from AbstractCursor.rewind
Inherited from AbstractCursor.toArray
Inherited from AbstractCursor.tryNext
Inherited from AbstractCursor.withReadConcern
Inherited from AbstractCursor.withReadPreference
Static
addInherited from AggregationCursor.addCursorFlag
Inherited from AggregationCursor.batchSize
Inherited from AggregationCursor.close
Inherited from AggregationCursor.forEach
Inherited from AggregationCursor.hasNext
Inherited from AggregationCursor.maxTimeMS
Inherited from AggregationCursor.next
Inherited from AggregationCursor.rewind
Inherited from AggregationCursor.toArray
Inherited from AggregationCursor.tryNext
Inherited from AggregationCursor.withReadConcern
Inherited from AggregationCursor.withReadPreference
Static
addThis class is only meant to be constructed within the driver.
Overrides MongoDriverError.constructor
-
Inherited from MongoDriverError.errmsg
Inherited from MongoDriverError.errorLabels
Overrides MongoDriverError.name
Inherited from MongoDriverError.addErrorLabel
Inherited from MongoDriverError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoRuntimeError.constructor
-
Inherited from MongoRuntimeError.errmsg
Inherited from MongoRuntimeError.errorLabels
Overrides MongoRuntimeError.name
Inherited from MongoRuntimeError.addErrorLabel
Inherited from MongoRuntimeError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoRuntimeError.constructor
-
Inherited from MongoRuntimeError.errmsg
Inherited from MongoRuntimeError.errorLabels
Overrides MongoRuntimeError.name
Inherited from MongoRuntimeError.addErrorLabel
Inherited from MongoRuntimeError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoAPIError.constructor
-
Inherited from MongoAPIError.errmsg
Inherited from MongoAPIError.errorLabels
Overrides MongoAPIError.name
Inherited from MongoAPIError.addErrorLabel
Inherited from MongoAPIError.hasErrorLabel
Static
captureOptional
codeInherited from MongoServerError.codeName
Optional
connectionOptional
errInherited from MongoServerError.errInfo
Optional
ok?: numberInherited from MongoServerError.ok
Optional
writeInherited from MongoServerError.writeConcernError
Inherited from MongoServerError.errmsg
Inherited from MongoServerError.errorLabels
Inherited from MongoServerError.addErrorLabel
Inherited from MongoServerError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoRuntimeError.constructor
-
Inherited from MongoRuntimeError.errmsg
Inherited from MongoRuntimeError.errorLabels
Overrides MongoRuntimeError.name
Inherited from MongoRuntimeError.addErrorLabel
Inherited from MongoRuntimeError.hasErrorLabel
Static
captureOptional
Returns MongoClientOverrides TypedEventEmitter.constructor
MongoOptions
docs.mongodb.org/manual/reference/connection-string/
Optional
Returns Db
A ClientSession instance may only be passed to operations bei MongoClient it was started from.
watch() accepts two generic arguments for distinct use cases:
Static
addThe programmatically provided options take precedence over th
https://www.mongodb.com/docs/manual/reference/connection-string/
Static
getThis class is only meant to be constructed within the driver.
Overrides MongoAPIError.constructor
-
Inherited from MongoAPIError.errmsg
Inherited from MongoAPIError.errorLabels
Overrides MongoAPIError.name
Inherited from MongoAPIError.addErrorLabel
Inherited from MongoAPIError.hasErrorLabel
Static
captureInherited from MongoCryptError.errmsg
Inherited from MongoCryptError.errorLabels
Inherited from MongoCryptError.addErrorLabel
Inherited from MongoCryptError.hasErrorLabel
Static
captureInherited from MongoCryptError.errmsg
Inherited from MongoCryptError.errorLabels
Inherited from MongoCryptError.addErrorLabel
Inherited from MongoCryptError.hasErrorLabel
Static
captureInherited from MongoCryptError.errmsg
Inherited from MongoCryptError.errorLabels
Inherited from MongoCryptError.addErrorLabel
Inherited from MongoCryptError.hasErrorLabel
Static
captureInherited from MongoError.errmsg
Inherited from MongoError.errorLabels
Inherited from MongoError.addErrorLabel
Inherited from MongoError.hasErrorLabel
Static
captureInherited from MongoCryptError.errmsg
Inherited from MongoCryptError.errorLabels
Inherited from MongoCryptError.addErrorLabel
Inherited from MongoCryptError.hasErrorLabel
Static
captureInherited from MongoCryptError.errmsg
Inherited from MongoCryptError.errorLabels
Inherited from MongoCryptError.addErrorLabel
Inherited from MongoCryptError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoAPIError.constructor
-
Inherited from MongoAPIError.errmsg
Inherited from MongoAPIError.errorLabels
Overrides MongoAPIError.name
Inherited from MongoAPIError.addErrorLabel
Inherited from MongoAPIError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoAPIError.constructor
-
Inherited from MongoAPIError.errmsg
Inherited from MongoAPIError.errorLabels
Overrides MongoAPIError.name
Inherited from MongoAPIError.addErrorLabel
Inherited from MongoAPIError.hasErrorLabel
Static
captureOverrides MongoDBNamespace.constructor
Inherited from MongoDBNamespace.collection
Inherited from MongoDBNamespace.db
Inherited from MongoDBNamespace.toString
Inherited from MongoDBNamespace.withCollection
Static
fromOptional
Returns MongoDBCollectionNamespaceOverrides MongoDBNamespace.fromString
Overrides MongoError.constructor
Inherited from MongoError.errmsg
Inherited from MongoError.errorLabels
Overrides MongoError.name
Inherited from MongoError.addErrorLabel
Inherited from MongoError.hasErrorLabel
Static
captureOverrides Error.name
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoAPIError.constructor
-
Inherited from MongoAPIError.errmsg
Inherited from MongoAPIError.errorLabels
Overrides MongoAPIError.name
Inherited from MongoAPIError.addErrorLabel
Inherited from MongoAPIError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoRuntimeError.constructor
-
Inherited from MongoRuntimeError.errmsg
Inherited from MongoRuntimeError.errorLabels
Overrides MongoRuntimeError.name
Inherited from MongoRuntimeError.addErrorLabel
Inherited from MongoRuntimeError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoRuntimeError.constructor
-
Inherited from MongoRuntimeError.errmsg
Inherited from MongoRuntimeError.errorLabels
Overrides MongoRuntimeError.name
Inherited from MongoRuntimeError.addErrorLabel
Inherited from MongoRuntimeError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoAPIError.constructor
-
Inherited from MongoAPIError.errmsg
Inherited from MongoAPIError.errorLabels
Overrides MongoAPIError.name
Inherited from MongoAPIError.addErrorLabel
Inherited from MongoAPIError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoRuntimeError.constructor
-
Inherited from MongoRuntimeError.errmsg
Inherited from MongoRuntimeError.errorLabels
Overrides MongoRuntimeError.name
Inherited from MongoRuntimeError.addErrorLabel
Inherited from MongoRuntimeError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoAPIError.constructor
-
Inherited from MongoAPIError.errmsg
Inherited from MongoAPIError.errorLabels
Overrides MongoAPIError.name
Inherited from MongoAPIError.addErrorLabel
Inherited from MongoAPIError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoAPIError.constructor
-
Inherited from MongoAPIError.errmsg
Inherited from MongoAPIError.errorLabels
Overrides MongoAPIError.name
Inherited from MongoAPIError.addErrorLabel
Inherited from MongoAPIError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoError.constructor
-
Inherited from MongoError.errmsg
Inherited from MongoError.errorLabels
Overrides MongoError.name
Inherited from MongoError.addErrorLabel
Inherited from MongoError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoNetworkError.constructor
-
Inherited from MongoNetworkError.errmsg
Inherited from MongoNetworkError.errorLabels
Overrides MongoNetworkError.name
Inherited from MongoNetworkError.addErrorLabel
Inherited from MongoNetworkError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoAPIError.constructor
-
Inherited from MongoAPIError.errmsg
Inherited from MongoAPIError.errorLabels
Overrides MongoAPIError.name
Inherited from MongoAPIError.addErrorLabel
Inherited from MongoAPIError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoDriverError.constructor
-
Inherited from MongoDriverError.errmsg
Inherited from MongoDriverError.errorLabels
Overrides MongoDriverError.name
Inherited from MongoDriverError.addErrorLabel
Inherited from MongoDriverError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoDriverError.constructor
-
Inherited from MongoDriverError.errmsg
Inherited from MongoDriverError.errorLabels
Overrides MongoDriverError.name
Inherited from MongoDriverError.addErrorLabel
Inherited from MongoDriverError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoAPIError.constructor
-
Inherited from MongoAPIError.errmsg
Inherited from MongoAPIError.errorLabels
Overrides MongoAPIError.name
Inherited from MongoAPIError.addErrorLabel
Inherited from MongoAPIError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoError.constructor
-
Optional
Optional
codeOptional
connectionOptional
Optional
errOptional
okOptional
stackOptional
Optional
writeStatic
Optional
prepareInherited from MongoError.errmsg
Inherited from MongoError.errorLabels
Overrides MongoError.name
Inherited from MongoError.addErrorLabel
Inherited from MongoError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoSystemError.constructor
-
Optional
Inherited from MongoSystemError.reason
Optional
stackInherited from MongoSystemError.errmsg
Inherited from MongoSystemError.errorLabels
Overrides MongoSystemError.name
Inherited from MongoSystemError.addErrorLabel
Inherited from MongoSystemError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoError.constructor
-
Optional
Optional
stackInherited from MongoError.errmsg
Inherited from MongoError.errorLabels
Overrides MongoError.name
Inherited from MongoError.addErrorLabel
Inherited from MongoError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoAPIError.constructor
-
Inherited from MongoAPIError.errmsg
Inherited from MongoAPIError.errorLabels
Overrides MongoAPIError.name
Inherited from MongoAPIError.addErrorLabel
Inherited from MongoAPIError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoAPIError.constructor
-
Inherited from MongoAPIError.errmsg
Inherited from MongoAPIError.errorLabels
Overrides MongoAPIError.name
Inherited from MongoAPIError.addErrorLabel
Inherited from MongoAPIError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoAPIError.constructor
-
Inherited from MongoAPIError.errmsg
Inherited from MongoAPIError.errorLabels
Overrides MongoAPIError.name
Inherited from MongoAPIError.addErrorLabel
Inherited from MongoAPIError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoRuntimeError.constructor
-
Inherited from MongoRuntimeError.errmsg
Inherited from MongoRuntimeError.errorLabels
Overrides MongoRuntimeError.name
Inherited from MongoRuntimeError.addErrorLabel
Inherited from MongoRuntimeError.hasErrorLabel
Static
captureThis class is only meant to be constructed within the driver.
Overrides MongoServerError.constructor
-
Optional
codeInherited from MongoServerError.codeName
Optional
connectionOptional
errInherited from MongoServerError.errInfo
Optional
ok?: numberInherited from MongoServerError.ok
Optional
resultOptional
Optional
stackOptional
writeInherited from MongoServerError.writeConcernError
Static
Optional
prepareInherited from MongoServerError.errmsg
Inherited from MongoServerError.errorLabels
Overrides MongoServerError.name
Inherited from MongoServerError.addErrorLabel
Inherited from MongoServerError.hasErrorLabel
Static
captureInherited from AbstractCursor.close
Inherited from AbstractCursor.forEach
Inherited from AbstractCursor.hasNext
const<
Inherited from AbstractCursor.map
-- Defined in src/cursor/abstract_cursor.ts:500
Inherited from AbstractCursor.next
Inherited from AbstractCursor.rewind
Inherited from AbstractCursor.toArray
Inherited from AbstractCursor.tryNext
Inherited from AbstractCursor.withReadPreference
Static
addInherited from BSONSerializeOptions.promoteBuffers
Optional
promotetrue
Inherited from BSONSerializeOptions.promoteLongs
Optional
promotetrue
Inherited from BSONSerializeOptions.promoteValues
Optional
rawfalse
Inherited from BSONSerializeOptions.serializeFunctions
Optional
sessionfalse
Inherited from BSONSerializeOptions.useBigInt64
Inherited from CommandOperationOptions.fieldsAsRaw
Optional
hinttrue
Inherited from CommandOperationOptions.ignoreUndefined
Optional
letfalse
Inherited from CommandOperationOptions.promoteBuffers
Optional
promotetrue
Inherited from CommandOperationOptions.promoteLongs
Optional
promotetrue
Inherited from CommandOperationOptions.promoteValues
Optional
rawfalse
Inherited from CommandOperationOptions.serializeFunctions
Optional
sessionfalse
Inherited from CommandOperationOptions.useBigInt64
Optional
willfalse
Inherited from AggregateOptions.bsonRegExp
Optional
bypassfalse
Inherited from AggregateOptions.checkKeys
Optional
collationnull
Inherited from AggregateOptions.fieldsAsRaw
Optional
hinttrue
Inherited from AggregateOptions.ignoreUndefined
Optional
letfalse
Inherited from AggregateOptions.promoteBuffers
Optional
promotetrue
Inherited from AggregateOptions.promoteLongs
Optional
promotetrue
Inherited from AggregateOptions.promoteValues
Optional
rawfalse
Inherited from AggregateOptions.serializeFunctions
Optional
sessionfalse
Inherited from AggregateOptions.useBigInt64
Optional
willOptional
Optional
usernameOptional
Optional
validation// disables va
Inherited from Omit.promoteBuffers
Optional
promotetrue
Inherited from Omit.promoteLongs
Optional
promotetrue
Inherited from Omit.promoteValues
Optional
rawfalse
Inherited from Omit.serializeFunctions
Optional
usefalse
Inherited from Omit.useBigInt64
Inherited from CommandOperationOptions.fieldsAsRaw
Optional
forcetrue
Inherited from CommandOperationOptions.ignoreUndefined
Optional
letfalse
Inherited from CommandOperationOptions.promoteBuffers
Optional
promotetrue
Inherited from CommandOperationOptions.promoteLongs
Optional
promotetrue
Inherited from CommandOperationOptions.promoteValues
Optional
rawfalse
Inherited from CommandOperationOptions.serializeFunctions
Optional
sessionfalse
Inherited from CommandOperationOptions.useBigInt64
Optional
willfalse
Inherited from Omit.bsonRegExp
Optional
bypassfalse
Inherited from Omit.checkKeys
Optional
collationnull
Inherited from Omit.fieldsAsRaw
Optional
fulltrue
Inherited from Omit.ignoreUndefined
Optional
letfalse
Inherited from Omit.promoteBuffers
Optional
promotetrue
Inherited from Omit.promoteLongs
Optional
promotetrue
Inherited from Omit.promoteValues
Optional
rawfalse
Inherited from Omit.serializeFunctions
Optional
sessionfalse
Inherited from Omit.useBigInt64
Optional
willOptional
forceInherited from BSONSerializeOptions.fieldsAsRaw
Optional
ignoretrue
Inherited from BSONSerializeOptions.ignoreUndefined
Optional
promotefalse
Inherited from BSONSerializeOptions.promoteBuffers
Optional
promotetrue
Inherited from BSONSerializeOptions.promoteLongs
Optional
promotetrue
Inherited from BSONSerializeOptions.promoteValues
Optional
rawfalse
Inherited from BSONSerializeOptions.serializeFunctions
Optional
usefalse
Inherited from BSONSerializeOptions.useBigInt64
Optional
writefalse
Inherited from OperationOptions.bsonRegExp
Optional
checkfalse
Inherited from OperationOptions.checkKeys
Optional
collationnull
Inherited from OperationOptions.fieldsAsRaw
Optional
ignoretrue
Inherited from OperationOptions.ignoreUndefined
Optional
maxfalse
Inherited from OperationOptions.promoteBuffers
Optional
promotetrue
Inherited from OperationOptions.promoteLongs
Optional
promotetrue
Inherited from OperationOptions.promoteValues
Optional
rawfalse
Inherited from OperationOptions.serializeFunctions
Optional
sessionfalse
Inherited from OperationOptions.useBigInt64
Optional
willOptional
Optional
cancellationOptional
certOptional
Optional
connectOptional
credentialsOptional
crlOptional
generationOptional
hintsOptional
hostOptional
keyOptional
metadataOptional
minDHSizeOptional
monitorOptional
noOptional
passphraseOptional
proxyInherited from ProxyOptions.proxyHost
Optional
proxyInherited from ProxyOptions.proxyPassword
Optional
proxyInherited from ProxyOptions.proxyPort
Optional
proxyInherited from ProxyOptions.proxyUsername
Optional
rejectOptional
Optional
serverOptional
servernameOptional
Optional
socketInherited from Omit.hostAddress
Optional
keyOverrides Omit.loadBalanced
Optional
localInherited from Omit.metadata
Optional
minDHSizeInherited from Omit.monitorCommands
Optional
noInherited from Omit.noDelay
Optional
passphraseOptional
proxyInherited from Omit.proxyHost
Optional
proxyInherited from Omit.proxyPassword
Optional
proxyInherited from Omit.proxyPort
Optional
proxyInherited from Omit.proxyUsername
Optional
rejectOptional
serverInherited from Omit.serverApi
Optional
servernameOptional
socketInherited from Omit.socketTimeoutMS
Inherited from Omit.tls
Inherited from AggregateOptions.fieldsAsRaw
Optional
hinttrue
Inherited from AggregateOptions.ignoreUndefined
Optional
letfalse
Inherited from AggregateOptions.promoteBuffers
Optional
promotetrue
Inherited from AggregateOptions.promoteLongs
Optional
promotetrue
Inherited from AggregateOptions.promoteValues
Optional
rawfalse
Inherited from AggregateOptions.serializeFunctions
Optional
sessionfalse
Inherited from AggregateOptions.useBigInt64
Optional
willfalse
Inherited from CommandOperationOptions.bsonRegExp
Optional
checkfalse
Inherited from CommandOperationOptions.checkKeys
Optional
collationnull
Inherited from CommandOperationOptions.fieldsAsRaw
Optional
hinttrue
Inherited from CommandOperationOptions.ignoreUndefined
Optional
limitfalse
Inherited from CommandOperationOptions.promoteBuffers
Optional
promotetrue
Inherited from CommandOperationOptions.promoteLongs
Optional
promotetrue
Inherited from CommandOperationOptions.promoteValues
Optional
rawfalse
Inherited from CommandOperationOptions.serializeFunctions
Optional
sessionfalse
Inherited from CommandOperationOptions.useBigInt64
Optional
willfalse
Inherited from CommandOperationOptions.bsonRegExp
Optional
cappedfalse
Inherited from CommandOperationOptions.checkKeys
Optional
clusterednull
Inherited from CommandOperationOptions.fieldsAsRaw
Optional
flagstrue
Inherited from CommandOperationOptions.ignoreUndefined
Optional
indexfalse
Inherited from CommandOperationOptions.promoteBuffers
Optional
promotetrue
Inherited from CommandOperationOptions.promoteLongs
Optional
promotetrue
Inherited from CommandOperationOptions.promoteValues
Optional
rawfalse
Inherited from CommandOperationOptions.serializeFunctions
Optional
sessionfalse
Inherited from CommandOperationOptions.useBigInt64
Optional
validationfalse
Inherited from Omit.bsonRegExp
Optional
bucketfalse
Inherited from Omit.checkKeys
Optional
collationnull
Inherited from Omit.fieldsAsRaw
Optional
hiddentrue
Inherited from Omit.ignoreUndefined
Optional
language_false
Inherited from Omit.promoteBuffers
Optional
promotetrue
Inherited from Omit.promoteLongs
Optional
promotetrue
Inherited from Omit.promoteValues
Optional
rawfalse
Inherited from Omit.serializeFunctions
Optional
sessionfalse
Inherited from Omit.useBigInt64
Optional
versionfalse
Inherited from BSONSerializeOptions.bsonRegExp
Optional
checkfalse
Inherited from BSONSerializeOptions.checkKeys
Optional
enablenull
Inherited from BSONSerializeOptions.fieldsAsRaw
Optional
forcetrue
Inherited from BSONSerializeOptions.ignoreUndefined
Optional
pkfalse
Inherited from BSONSerializeOptions.promoteBuffers
Optional
promotetrue
Inherited from BSONSerializeOptions.promoteLongs
Optional
promotetrue
Inherited from BSONSerializeOptions.promoteValues
Optional
rawfalse
Inherited from BSONSerializeOptions.serializeFunctions
Optional
usefalse
Inherited from BSONSerializeOptions.useBigInt64
Optional
writefalse
Inherited from CommandOperationOptions.bsonRegExp
Optional
checkfalse
Inherited from CommandOperationOptions.checkKeys
Optional
collationnull
Inherited from CommandOperationOptions.fieldsAsRaw
Optional
ignoretrue
Inherited from CommandOperationOptions.ignoreUndefined
Optional
maxfalse
Inherited from CommandOperationOptions.promoteBuffers
Optional
promotetrue
Inherited from CommandOperationOptions.promoteLongs
Optional
promotetrue
Inherited from CommandOperationOptions.promoteValues
Optional
rawfalse
Inherited from CommandOperationOptions.serializeFunctions
Optional
sessionfalse
Inherited from CommandOperationOptions.useBigInt64
Optional
willfalse
Inherited from CommandOperationOptions.bsonRegExp
Optional
checkfalse
Inherited from CommandOperationOptions.checkKeys
Optional
collationnull
Inherited from CommandOperationOptions.fieldsAsRaw
Optional
hinttrue
Inherited from CommandOperationOptions.ignoreUndefined
Optional
letfalse
Inherited from CommandOperationOptions.promoteBuffers
Optional
promotetrue
Inherited from CommandOperationOptions.promoteLongs
Optional
promotetrue
Inherited from CommandOperationOptions.promoteValues
Optional
rawfalse
Inherited from CommandOperationOptions.serializeFunctions
Optional
sessionfalse
Inherited from CommandOperationOptions.useBigInt64
Optional
willOptional
nameOptional
platformOptional
versionInherited from CommandOperationOptions.fieldsAsRaw
Optional
ignoretrue
Inherited from CommandOperationOptions.ignoreUndefined
Optional
maxfalse
Inherited from CommandOperationOptions.promoteBuffers
Optional
promotetrue
Inherited from CommandOperationOptions.promoteLongs
Optional
promotetrue
Inherited from CommandOperationOptions.promoteValues
Optional
rawfalse
Inherited from CommandOperationOptions.serializeFunctions
Optional
sessionfalse
Inherited from CommandOperationOptions.useBigInt64
Optional
willfalse
Inherited from CommandOperationOptions.bsonRegExp
Optional
checkfalse
Inherited from CommandOperationOptions.checkKeys
Optional
collationnull
Inherited from CommandOperationOptions.fieldsAsRaw
Optional
ignoretrue
Inherited from CommandOperationOptions.ignoreUndefined
Optional
maxfalse
Inherited from CommandOperationOptions.promoteBuffers
Optional
promotetrue
Inherited from CommandOperationOptions.promoteLongs
Optional
promotetrue
Inherited from CommandOperationOptions.promoteValues
Optional
rawfalse
Inherited from CommandOperationOptions.serializeFunctions
Optional
sessionfalse
Inherited from CommandOperationOptions.useBigInt64
Optional
willOptional
__id?: undefinedInherited from NonObjectIdLikeDocument.__id
Optional
idInherited from NonObjectIdLikeDocument.id
Optional
toInherited from NonObjectIdLikeDocument.toHexString
Inherited from CommandOperationOptions.fieldsAsRaw
Optional
hinttrue
Inherited from CommandOperationOptions.ignoreUndefined
Optional
includefalse
Inherited from CommandOperationOptions.promoteBuffers
Optional
promotetrue
Inherited from CommandOperationOptions.promoteLongs
Optional
promotetrue
Inherited from CommandOperationOptions.promoteValues
Optional
rawfalse
Inherited from CommandOperationOptions.serializeFunctions
Optional
sessionfalse
Inherited from CommandOperationOptions.useBigInt64
Optional
willfalse
Inherited from CommandOperationOptions.bsonRegExp
Optional
bypassfalse
Inherited from CommandOperationOptions.checkKeys
Optional
collationnull
Inherited from CommandOperationOptions.fieldsAsRaw
Optional
hinttrue
Inherited from CommandOperationOptions.ignoreUndefined
Optional
includeReturn the ModifyResult instead of the modified document. Defaults to true -but will default to false in the next major version.
+Return the ModifyResult instead of the modified document. Defaults to false
Optional
letfalse
Inherited from CommandOperationOptions.promoteBuffers
Optional
promotetrue
Inherited from CommandOperationOptions.promoteLongs
Optional
promotetrue
Inherited from CommandOperationOptions.promoteValues
Optional
rawfalse
Inherited from CommandOperationOptions.serializeFunctions
Optional
sessionfalse
Inherited from CommandOperationOptions.useBigInt64
Optional
willOptional
Optional
authdbfalse
Inherited from CommandOperationOptions.bsonRegExp
Optional
bypassOptional
Optional
checkfalse
Inherited from CommandOperationOptions.checkKeys
Optional
collationnull
Inherited from CommandOperationOptions.fieldsAsRaw
Optional
hintOptional
Optional
ignoretrue
Inherited from CommandOperationOptions.ignoreUndefined
Optional
includeReturn the ModifyResult instead of the modified document. Defaults to true -but will default to false in the next major version.
+Return the ModifyResult instead of the modified document. Defaults to false
Optional
letOptional
Optional
maxOptional
Optional
promotefalse
Inherited from CommandOperationOptions.promoteBuffers
Optional
promotetrue
Inherited from CommandOperationOptions.promoteLongs
Optional
promotetrue
Inherited from CommandOperationOptions.promoteValues
Optional
rawOptional
Optional
serializefalse
Inherited from CommandOperationOptions.serializeFunctions
Optional
sessionOptional
Optional
upsertOptional
Optional
usefalse
Inherited from CommandOperationOptions.useBigInt64
Optional
willfalse
Inherited from Omit.bsonRegExp
Optional
checkfalse
Inherited from Omit.checkKeys
Optional
collationnull
Inherited from Omit.fieldsAsRaw
Optional
hinttrue
Inherited from Omit.ignoreUndefined
Optional
letfalse
Inherited from Omit.promoteBuffers
Optional
promotetrue
Inherited from Omit.promoteLongs
Optional
promotetrue
Inherited from Omit.promoteValues
Optional
rawfalse
Inherited from Omit.serializeFunctions
Optional
sessionfalse
Inherited from Omit.useBigInt64
Optional
willfalse
Inherited from CommandOperationOptions.bsonRegExp
Optional
bypassfalse
Inherited from CommandOperationOptions.checkKeys
Optional
collationnull
Inherited from CommandOperationOptions.fieldsAsRaw
Optional
forcetrue
Inherited from CommandOperationOptions.ignoreUndefined
Optional
maxfalse
Inherited from CommandOperationOptions.promoteBuffers
Optional
promotetrue
Inherited from CommandOperationOptions.promoteLongs
Optional
promotetrue
Inherited from CommandOperationOptions.promoteValues
Optional
rawfalse
Inherited from CommandOperationOptions.serializeFunctions
Optional
sessionfalse
Inherited from CommandOperationOptions.useBigInt64
Optional
willfalse
Inherited from Omit.bsonRegExp
Optional
checkfalse
Inherited from Omit.checkKeys
Optional
collationnull
Inherited from Omit.fieldsAsRaw
Optional
ignoretrue
Inherited from Omit.ignoreUndefined
Optional
maxfalse
Inherited from Omit.promoteBuffers
Optional
promotetrue
Inherited from Omit.promoteLongs
Optional
promotetrue
Inherited from Omit.promoteValues
Optional
rawfalse
Inherited from Omit.serializeFunctions
Optional
sessionfalse
Inherited from Omit.useBigInt64
Optional
willfalse
Inherited from CommandOperationOptions.bsonRegExp
Optional
checkfalse
Inherited from CommandOperationOptions.checkKeys
Optional
collationnull
Inherited from CommandOperationOptions.fieldsAsRaw
Optional
filtertrue
Inherited from CommandOperationOptions.ignoreUndefined
Optional
maxfalse
Inherited from CommandOperationOptions.promoteBuffers
Optional
promotetrue
Inherited from CommandOperationOptions.promoteLongs
Optional
promotetrue
Inherited from CommandOperationOptions.promoteValues
Optional
rawfalse
Inherited from CommandOperationOptions.serializeFunctions
Optional
sessionfalse
Inherited from CommandOperationOptions.useBigInt64
Optional
willfalse
Inherited from Omit.bsonRegExp
Optional
checkfalse
Inherited from Omit.checkKeys
Optional
collationnull
Inherited from Omit.fieldsAsRaw
Optional
ignoretrue
Inherited from Omit.ignoreUndefined
Optional
maxfalse
Inherited from Omit.promoteBuffers
Optional
promotetrue
Inherited from Omit.promoteLongs
Optional
promotetrue
Inherited from Omit.promoteValues
Optional
rawfalse
Inherited from Omit.serializeFunctions
Optional
sessionfalse
Inherited from Omit.useBigInt64
Optional
willOptional
Optional
authOptional
Optional
authOptional
Optional
authOptional
Optional
authOptional
Optional
autoAutomatic encryption is an enterprise only feature that only
If an internal MongoClient is created, it is configured with the same options as the parent MongoClient except minPoolSize is set to 0 and AutoEncryptionOptions is omitted.
Optional
bsonfalse
Inherited from BSONSerializeOptions.bsonRegExp
Optional
cafalse
Inherited from BSONSerializeOptions.checkKeys
Optional
checkOptional
Optional
connectOptional
Optional
crlOptional
Optional
driverOptional
Optional
ecdhnull
Inherited from BSONSerializeOptions.fieldsAsRaw
Optional
forceOptional
Optional
heartbeatOptional
Optional
hintstrue
Inherited from BSONSerializeOptions.ignoreUndefined
Optional
journalOptional
DeprecatedPlease use the writeConcern
option instead
Optional
keyOptional
Optional
localOptional
Optional
lookupOptional
Optional
maxOptional
Optional
maxOptional
Optional
maxOptional
Optional
minDHSizeOptional
Optional
minOptional
Optional
monitorOptional
Optional
noOptional
Optional
passphraseOptional
Optional
promotefalse
Inherited from BSONSerializeOptions.promoteBuffers
Optional
promotetrue
Inherited from BSONSerializeOptions.promoteLongs
Optional
promotetrue
Inherited from BSONSerializeOptions.promoteValues
Optional
proxyOptional
Optional
proxyOptional
Optional
proxyOptional
Optional
proxyOptional
Optional
rawOptional
Optional
readOptional
Optional
readOptional
Optional
readOptional
Optional
rejectOptional
Optional
retryOptional
Optional
retryOptional
Optional
securefalse
Inherited from BSONSerializeOptions.serializeFunctions
Optional
serverOptional
Optional
serverOptional
Optional
serverOptional
Optional
servernameOptional
Optional
srvOptional
Optional
srvOptional
Optional
sslOptional
Optional
tlsOptional
Optional
tlsOptional
Optional
tlsOptional
Optional
tlsCAFileOptional
Optional
tlsCRLFileOptional
Optional
tlsOptional
Optional
tlsOptional
Optional
tlsOptional
Optional
usefalse
Inherited from BSONSerializeOptions.useBigInt64
Optional
wOptional
DeprecatedPlease use the writeConcern
option instead
Optional
waitOptional
Optional
writeOptional
Seehttps://www.mongodb.com/docs/manual/reference/write-concern/
Optional
wtimeoutMSOptional
DeprecatedPlease use the writeConcern
option instead
Optional
zlibOptional
Inherited from Required.driverInfo
Optional
ecdhInherited from Required.forceServerObjectId
Inherited from Required.heartbeatFrequencyMS
Optional
hintsOptional
hostsOptional
keyOptional
loadOptional
localInherited from Required.localThresholdMS
Optional
lookupInherited from Required.maxConnecting
Inherited from Required.maxIdleTimeMS
Inherited from Required.maxPoolSize
Optional
minDHSizeInherited from Required.minHeartbeatFrequencyMS
Inherited from Required.minPoolSize
Inherited from Required.monitorCommands
Inherited from Required.noDelay
Optional
passphraseInherited from Required.pkFactory
Optional
proxyOptional
proxyOptional
proxyOptional
proxyPlease note there is a known limitation where this option can
Optional
rejectInherited from Required.replicaSet
Inherited from Required.retryReads
Inherited from Required.retryWrites
Optional
secureOptional
serverInherited from Required.serverSelectionTimeoutMS
Optional
servernameInherited from Required.socketTimeoutMS
Optional
srvInherited from Required.srvMaxHosts
Inherited from Required.srvServiceName
Inherited from Required.tlsAllowInvalidCertificates
Inherited from Required.tlsAllowInvalidHostnames
Optional
tlsCAFileOptional
tlsCRLFileOptional
tlsInherited from Required.tlsInsecure
Inherited from Required.waitQueueTimeoutMS
Inherited from Required.zlibCompressionLevel
Inherited from Omit.metadata
Optional
minDHSizeInherited from Omit.monitorCommands
Optional
noInherited from Omit.noDelay
Optional
passphraseOptional
proxyInherited from Omit.proxyHost
Optional
proxyInherited from Omit.proxyPassword
Optional
proxyInherited from Omit.proxyPort
Optional
proxyInherited from Omit.proxyUsername
Optional
rejectOptional
serverInherited from Omit.serverApi
Optional
socketInherited from Omit.socketTimeoutMS
Inherited from Omit.tls
Inherited from BSONSerializeOptions.fieldsAsRaw
Optional
ignoretrue
Inherited from BSONSerializeOptions.ignoreUndefined
Optional
omitfalse
Inherited from BSONSerializeOptions.promoteBuffers
Optional
promotetrue
Inherited from BSONSerializeOptions.promoteLongs
Optional
promotetrue
Inherited from BSONSerializeOptions.promoteValues
Optional
rawfalse
Inherited from BSONSerializeOptions.serializeFunctions
Optional
sessionfalse
Inherited from BSONSerializeOptions.useBigInt64
Optional
willInherited from CommandOperationOptions.ignoreUndefined
Optional
maxfalse
Inherited from CommandOperationOptions.promoteBuffers
Optional
promotetrue
Inherited from CommandOperationOptions.promoteLongs
Optional
promotetrue
Inherited from CommandOperationOptions.promoteValues
Optional
rawfalse
Inherited from CommandOperationOptions.serializeFunctions
Optional
sessionfalse
Inherited from CommandOperationOptions.useBigInt64
Optional
willfalse
Inherited from CommandOperationOptions.bsonRegExp
Optional
bypassfalse
Inherited from CommandOperationOptions.checkKeys
Optional
collationnull
Inherited from CommandOperationOptions.fieldsAsRaw
Optional
hinttrue
Inherited from CommandOperationOptions.ignoreUndefined
Optional
letfalse
Inherited from CommandOperationOptions.promoteBuffers
Optional
promotetrue
Inherited from CommandOperationOptions.promoteLongs
Optional
promotetrue
Inherited from CommandOperationOptions.promoteValues
Optional
rawfalse
Inherited from CommandOperationOptions.serializeFunctions
Optional
sessionfalse
Inherited from CommandOperationOptions.useBigInt64
Optional
willOptional
deprecationOptional
strictInherited from CommandOperationOptions.fieldsAsRaw
Optional
ignoretrue
Inherited from CommandOperationOptions.ignoreUndefined
Optional
maxfalse
Inherited from CommandOperationOptions.promoteBuffers
Optional
promotetrue
Inherited from CommandOperationOptions.promoteLongs
Optional
promotetrue
Inherited from CommandOperationOptions.promoteValues
Optional
rawfalse
Inherited from CommandOperationOptions.serializeFunctions
Optional
sessionfalse
Inherited from CommandOperationOptions.useBigInt64
Optional
willfalse
Inherited from CommandOperationOptions.bsonRegExp
Optional
bypassfalse
Inherited from CommandOperationOptions.checkKeys
Optional
collationnull
Inherited from CommandOperationOptions.fieldsAsRaw
Optional
hinttrue
Inherited from CommandOperationOptions.ignoreUndefined
Optional
letfalse
Inherited from CommandOperationOptions.promoteBuffers
Optional
promotetrue
Inherited from CommandOperationOptions.promoteLongs
Optional
promotetrue
Inherited from CommandOperationOptions.promoteValues
Optional
rawfalse
Inherited from CommandOperationOptions.serializeFunctions
Optional
sessionfalse
Inherited from CommandOperationOptions.useBigInt64
Optional
willfalse
Inherited from CommandOperationOptions.bsonRegExp
Optional
checkfalse
Inherited from CommandOperationOptions.checkKeys
Optional
collationnull
Inherited from CommandOperationOptions.fieldsAsRaw
Optional
ignoretrue
Inherited from CommandOperationOptions.ignoreUndefined
Optional
maxfalse
Inherited from CommandOperationOptions.promoteBuffers
Optional
promotetrue
Inherited from CommandOperationOptions.promoteLongs
Optional
promotetrue
Inherited from CommandOperationOptions.promoteValues
Optional
rawfalse
Inherited from CommandOperationOptions.serializeFunctions
Optional
sessionfalse
Inherited from CommandOperationOptions.useBigInt64
Optional
will
Create an ObjectId type
+Create ObjectId from a number.
+Parameters
++-
+
+
inputId: number
+A number.
+Returns ObjectId
+Deprecated
Instead, use
+static createFromTime()
to set a numeric value for the new ObjectId.Overrides BSONValue.constructor
++- Defined in node_modules/bson/bson.d.ts:1002
Create ObjectId from a 24 character hex string.
+Parameters
++-
+
+
inputId: string
+A 24 character hex string.
+Returns ObjectId
+Overrides BSONValue.constructor
++- Defined in node_modules/bson/bson.d.ts:1008
Create ObjectId from the BSON ObjectId type.
+Parameters
++-
+
+
inputId: ObjectId
+The BSON ObjectId type.
+Returns ObjectId
+Overrides BSONValue.constructor
++- Defined in node_modules/bson/bson.d.ts:1014
Create ObjectId from the object type that has the toHexString method.
+Parameters
++-
+
+
inputId: ObjectIdLike
+The ObjectIdLike type.
+Returns ObjectId
+Overrides BSONValue.constructor
++- Defined in node_modules/bson/bson.d.ts:1020
Create ObjectId from a 12 byte binary Buffer.
+Parameters
++-
+
+
inputId: Uint8Array
+A 12 byte binary Buffer.
+Returns ObjectId
+Overrides BSONValue.constructor
++- Defined in node_modules/bson/bson.d.ts:1026
To generate a new ObjectId, use ObjectId() with no argument.
+Returns ObjectId
+Overrides BSONValue.constructor
++- Defined in node_modules/bson/bson.d.ts:1028
Implementation overload.
Parameters
-Optional
inputId: string | number | Uint8Array | ObjectId | ObjectIdLikeCan be a 24 character hex string, 12 byte binary Buffer, or a number.
+All input types that are used in the constructor implementation.
Returns ObjectId
Overrides BSONValue.constructor
+Overrides BSONValue.constructor
-- Defined in node_modules/bson/bson.d.ts:1001
Properties
idReturns Uint8Array
-- Defined in node_modules/bson/bson.d.ts:1006
Methods
otherId: Returns boolean
-- Defined in node_modules/bson/bson.d.ts:1030
get Timestamp
@@ -143,7 +239,7 @@
get TimestampReturns Date
-- Defined in node_modules/bson/bson.d.ts:1032
inspect
@@ -165,7 +261,7 @@
Returns string
Overrides BSONValue.inspect
-- Defined in node_modules/bson/bson.d.ts:1060
to Hex String
@@ -176,7 +272,7 @@
to Hex StringReturns string
-- Defined in node_modules/bson/bson.d.ts:1009
toJSON
@@ -187,7 +283,7 @@
toJSONReturns string
-- Defined in node_modules/bson/bson.d.ts:1023
to String
@@ -206,7 +302,7 @@
Optional
Returns string-- Defined in node_modules/bson/bson.d.ts:1021
Static
create@@ -222,7 +318,7 @@
base64: Returns ObjectId
-- Defined in node_modules/bson/bson.d.ts:1047
Static
create@@ -241,7 +337,7 @@
hexString: Returns ObjectId
-- Defined in node_modules/bson/bson.d.ts:1045
Static
create@@ -260,7 +356,7 @@
time: Returns ObjectId
-- Defined in node_modules/bson/bson.d.ts:1039
Static
generate@@ -279,7 +375,7 @@
Optional
Returns Uint8Array-- Defined in node_modules/bson/bson.d.ts:1016
Static
is@@ -298,7 +394,7 @@
id: Returns boolean
-- Defined in node_modules/bson/bson.d.ts:1052