From a7a782a652ed7496ca1dfae405c46e72d713037b Mon Sep 17 00:00:00 2001 From: durran <9030+durran@users.noreply.github.com> Date: Thu, 17 Oct 2024 21:35:18 +0000 Subject: [PATCH] [create-pull-request] automated change --- docs/404.html | 14 +- docs/Next/assets/navigation.js | 2 +- docs/Next/assets/search.js | 2 +- docs/Next/classes/AbstractCursor.html | 2 +- docs/Next/classes/AggregationCursor.html | 4 +- docs/Next/classes/Batch.html | 4 +- docs/Next/classes/BulkOperationBase.html | 10 +- docs/Next/classes/BulkWriteResult.html | 32 +- docs/Next/classes/ClientSession.html | 28 +- docs/Next/classes/CommandFailedEvent.html | 8 +- docs/Next/classes/CommandStartedEvent.html | 8 +- docs/Next/classes/CommandSucceededEvent.html | 8 +- docs/Next/classes/Db.html | 6 +- docs/Next/classes/FindCursor.html | 4 +- docs/Next/classes/FindOperators.html | 22 +- docs/Next/classes/HostAddress.html | 4 +- docs/Next/classes/ListCollectionsCursor.html | 4 +- docs/Next/classes/ListIndexesCursor.html | 2 +- .../Next/classes/ListSearchIndexesCursor.html | 4 +- docs/Next/classes/MongoAPIError.html | 10 +- docs/Next/classes/MongoAWSError.html | 10 +- docs/Next/classes/MongoAzureError.html | 10 +- .../classes/MongoBatchReExecutionError.html | 10 +- docs/Next/classes/MongoBulkWriteError.html | 26 +- docs/Next/classes/MongoChangeStreamError.html | 10 +- docs/Next/classes/MongoClient.html | 33 +- .../MongoClientBulkWriteCursorError.html | 29 ++ .../classes/MongoClientBulkWriteError.html | 42 ++ .../MongoClientBulkWriteExecutionError.html | 29 ++ .../Next/classes/MongoCompatibilityError.html | 10 +- docs/Next/classes/MongoCredentials.html | 18 +- .../MongoCryptAzureKMSRequestError.html | 8 +- .../classes/MongoCryptCreateDataKeyError.html | 8 +- ...goCryptCreateEncryptedCollectionError.html | 8 +- docs/Next/classes/MongoCryptError.html | 8 +- .../MongoCryptInvalidArgumentError.html | 8 +- ...ngoCryptKMSRequestNetworkTimeoutError.html | 8 +- .../classes/MongoCursorExhaustedError.html | 10 +- docs/Next/classes/MongoCursorInUseError.html | 10 +- .../classes/MongoDBCollectionNamespace.html | 8 +- docs/Next/classes/MongoDBNamespace.html | 8 +- .../Next/classes/MongoDecompressionError.html | 10 +- docs/Next/classes/MongoDriverError.html | 10 +- docs/Next/classes/MongoError.html | 10 +- .../classes/MongoExpiredSessionError.html | 10 +- docs/Next/classes/MongoGCPError.html | 10 +- docs/Next/classes/MongoGridFSChunkError.html | 10 +- docs/Next/classes/MongoGridFSStreamError.html | 10 +- .../classes/MongoInvalidArgumentError.html | 14 +- docs/Next/classes/MongoKerberosError.html | 10 +- .../classes/MongoMissingCredentialsError.html | 10 +- .../classes/MongoMissingDependencyError.html | 12 +- docs/Next/classes/MongoNetworkError.html | 10 +- .../classes/MongoNetworkTimeoutError.html | 10 +- docs/Next/classes/MongoNotConnectedError.html | 10 +- docs/Next/classes/MongoOIDCError.html | 10 +- docs/Next/classes/MongoParseError.html | 10 +- docs/Next/classes/MongoRuntimeError.html | 10 +- docs/Next/classes/MongoServerClosedError.html | 10 +- docs/Next/classes/MongoServerError.html | 12 +- .../classes/MongoServerSelectionError.html | 12 +- docs/Next/classes/MongoSystemError.html | 12 +- .../classes/MongoTailableCursorError.html | 10 +- .../classes/MongoTopologyClosedError.html | 10 +- docs/Next/classes/MongoTransactionError.html | 10 +- .../MongoUnexpectedServerResponseError.html | 10 +- docs/Next/classes/MongoWriteConcernError.html | 14 +- docs/Next/classes/OrderedBulkOperation.html | 8 +- docs/Next/classes/ServerDescription.html | 18 +- docs/Next/classes/ServerSession.html | 6 +- docs/Next/classes/TopologyDescription.html | 8 +- docs/Next/classes/UnorderedBulkOperation.html | 10 +- docs/Next/classes/WriteConcern.html | 19 +- docs/Next/classes/WriteConcernError.html | 10 +- docs/Next/classes/WriteError.html | 14 +- docs/Next/hierarchy.html | 2 +- docs/Next/interfaces/AggregateOptions.html | 60 +-- .../interfaces/AggregationCursorOptions.html | 26 +- docs/Next/interfaces/Auth.html | 6 +- .../interfaces/AuthMechanismProperties.html | 12 +- .../interfaces/BulkWriteOperationError.html | 4 +- docs/Next/interfaces/BulkWriteOptions.html | 20 +- docs/Next/interfaces/ChangeStreamOptions.html | 30 +- .../Next/interfaces/ClientBulkWriteError.html | 3 + .../interfaces/ClientBulkWriteOptions.html | 80 ++++ .../interfaces/ClientBulkWriteResult.html | 17 + .../interfaces/ClientDeleteManyModel.html | 11 + .../Next/interfaces/ClientDeleteOneModel.html | 11 + docs/Next/interfaces/ClientDeleteResult.html | 3 + ...ncryptionCreateDataKeyProviderOptions.html | 4 +- .../Next/interfaces/ClientInsertOneModel.html | 6 + .../interfaces/ClientInsertOneResult.html | 3 + .../interfaces/ClientReplaceOneModel.html | 15 + .../interfaces/ClientUpdateManyModel.html | 19 + .../Next/interfaces/ClientUpdateOneModel.html | 19 + docs/Next/interfaces/ClientUpdateResult.html | 12 + docs/Next/interfaces/ClientWriteModel.html | 3 + .../interfaces/CommandOperationOptions.html | 14 +- docs/Next/interfaces/ConnectionOptions.html | 6 +- .../interfaces/ConnectionPoolOptions.html | 6 +- .../interfaces/CountDocumentsOptions.html | 34 +- docs/Next/interfaces/CountOptions.html | 14 +- .../interfaces/CreateCollectionOptions.html | 14 +- .../Next/interfaces/CreateIndexesOptions.html | 14 +- docs/Next/interfaces/DbStatsOptions.html | 14 +- docs/Next/interfaces/DeleteManyModel.html | 8 +- docs/Next/interfaces/DeleteOneModel.html | 8 +- docs/Next/interfaces/DeleteOptions.html | 14 +- docs/Next/interfaces/DriverInfo.html | 4 +- .../interfaces/DropCollectionOptions.html | 14 +- docs/Next/interfaces/ErrorDescription.html | 4 +- .../EstimatedDocumentCountOptions.html | 14 +- .../interfaces/ExplainCommandOptions.html | 5 + docs/Next/interfaces/ExplainOptions.html | 18 +- .../interfaces/FindOneAndDeleteOptions.html | 14 +- .../interfaces/FindOneAndReplaceOptions.html | 14 +- .../interfaces/FindOneAndUpdateOptions.html | 14 +- docs/Next/interfaces/FindOptions.html | 63 +-- docs/Next/interfaces/InsertOneModel.html | 4 +- docs/Next/interfaces/InsertOneOptions.html | 14 +- .../interfaces/ListCollectionsOptions.html | 14 +- .../Next/interfaces/ListDatabasesOptions.html | 14 +- docs/Next/interfaces/MongoClientOptions.html | 118 ++--- .../interfaces/MongoCredentialsOptions.html | 4 +- .../interfaces/MongoNetworkErrorOptions.html | 4 +- docs/Next/interfaces/MongoOptions.html | 76 ++-- docs/Next/interfaces/MonitorOptions.html | 6 +- docs/Next/interfaces/OperationOptions.html | 10 +- docs/Next/interfaces/PkFactory.html | 4 +- docs/Next/interfaces/RenameOptions.html | 14 +- docs/Next/interfaces/ReplaceOneModel.html | 12 +- docs/Next/interfaces/ReplaceOptions.html | 14 +- docs/Next/interfaces/ServerApi.html | 4 +- docs/Next/interfaces/TransactionOptions.html | 12 +- docs/Next/interfaces/UpdateManyModel.html | 14 +- docs/Next/interfaces/UpdateOneModel.html | 14 +- docs/Next/interfaces/UpdateOptions.html | 14 +- .../interfaces/ValidateCollectionOptions.html | 14 +- .../interfaces/WriteConcernErrorData.html | 4 +- .../interfaces/WriteConcernErrorResult.html | 4 +- docs/Next/modules.html | 18 + docs/Next/types/AnyBulkWriteOperation.html | 2 +- docs/Next/types/AnyClientBulkWriteModel.html | 3 + docs/Next/types/AnyError.html | 2 +- docs/Next/types/BatchType.html | 2 +- docs/Next/types/Callback.html | 2 +- docs/Next/types/EventEmitterWithState.html | 2 +- docs/Next/types/ExplainVerbosity.html | 2 +- docs/Next/types/ExplainVerbosityLike.html | 5 +- docs/Next/types/Hint.html | 2 +- docs/Next/types/MongoClientEvents.html | 2 +- docs/Next/types/MongoErrorLabel.html | 2 +- docs/Next/types/ServerApiVersion.html | 2 +- docs/Next/types/ServerSessionId.html | 2 +- .../types/SupportedNodeConnectionOptions.html | 2 +- docs/Next/types/SupportedSocketOptions.html | 2 +- .../types/SupportedTLSConnectionOptions.html | 2 +- .../Next/types/SupportedTLSSocketOptions.html | 2 +- docs/Next/types/WithSessionCallback.html | 2 +- docs/Next/variables/BatchType-1.html | 2 +- docs/Next/variables/ExplainVerbosity-1.html | 2 +- docs/Next/variables/MongoErrorLabel-1.html | 2 +- docs/Next/variables/ServerApiVersion-1.html | 2 +- docs/categories/index.xml | 5 +- docs/index.html | 420 +++++++++--------- docs/index.xml | 5 +- docs/tags/index.xml | 5 +- 167 files changed, 1390 insertions(+), 1033 deletions(-) create mode 100644 docs/Next/classes/MongoClientBulkWriteCursorError.html create mode 100644 docs/Next/classes/MongoClientBulkWriteError.html create mode 100644 docs/Next/classes/MongoClientBulkWriteExecutionError.html create mode 100644 docs/Next/interfaces/ClientBulkWriteError.html create mode 100644 docs/Next/interfaces/ClientBulkWriteOptions.html create mode 100644 docs/Next/interfaces/ClientBulkWriteResult.html create mode 100644 docs/Next/interfaces/ClientDeleteManyModel.html create mode 100644 docs/Next/interfaces/ClientDeleteOneModel.html create mode 100644 docs/Next/interfaces/ClientDeleteResult.html create mode 100644 docs/Next/interfaces/ClientInsertOneModel.html create mode 100644 docs/Next/interfaces/ClientInsertOneResult.html create mode 100644 docs/Next/interfaces/ClientReplaceOneModel.html create mode 100644 docs/Next/interfaces/ClientUpdateManyModel.html create mode 100644 docs/Next/interfaces/ClientUpdateOneModel.html create mode 100644 docs/Next/interfaces/ClientUpdateResult.html create mode 100644 docs/Next/interfaces/ClientWriteModel.html create mode 100644 docs/Next/interfaces/ExplainCommandOptions.html create mode 100644 docs/Next/types/AnyClientBulkWriteModel.html diff --git a/docs/404.html b/docs/404.html index 665301be22..ef939e8cf6 100644 --- a/docs/404.html +++ b/docs/404.html @@ -21,16 +21,16 @@
- +Optional
[captureRest
...args: AnyRestAdd a cursor flag to the cursor
-The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.
+The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.
The flag boolean value.
Alias for emitter.on(eventName, listener)
.
v0.1.26
diff --git a/docs/Next/classes/AggregationCursor.html b/docs/Next/classes/AggregationCursor.html index 1a09062a71..9ca04c3edc 100644 --- a/docs/Next/classes/AggregationCursor.html +++ b/docs/Next/classes/AggregationCursor.html @@ -114,7 +114,7 @@A killCursors
command was attempted on this cursor.
This is performed if the cursor id is non zero.
Optional
[captureRest
...args: AnyRestAdd a cursor flag to the cursor
-The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.
+The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.
The flag boolean value.
Alias for emitter.on(eventName, listener)
.
v0.1.26
@@ -148,7 +148,7 @@Execute the explain for the cursor
-Optional
verbosity: ExplainVerbosityLikeIterates over all the documents for this cursor using the iterator, callback pattern.
+Optional
verbosity: ExplainVerbosityLike | ExplainCommandOptionsIterates over all the documents for this cursor using the iterator, callback pattern.
If the iterator returns false
, iteration will stop.
A
killCursors
command was attempted on this cursor. This is performed if the cursor id is non zero.