You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: etc/notes/errors.md
+7-1Lines changed: 7 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,7 +67,7 @@ Children of `MongoError` include:
67
67
### `MongoDriverError`
68
68
69
69
This class represents errors which originate in the driver itself or when the user incorrectly uses the driver. This class should **never** be directly instantiated.
70
-
Its children are the main classes of errors that most users will interact with: [**`MongoAPIError`**](#MongoAPIError) and [**`MongoRuntimeError`**](#MongoRuntimeError).
70
+
Its children are the main classes of errors that most users will interact with: [**`MongoAPIError`**](#MongoAPIError), [**`MongoRuntimeError`**](#MongoRuntimeError) and [**`MongoOperationTimeoutError`**](#MongoOperationTimeoutError).
71
71
72
72
### `MongoAPIError`
73
73
@@ -109,6 +109,12 @@ This class should **never** be directly instantiated.
109
109
|**MongoGridFSChunkError**| Thrown when a malformed or invalid chunk is encountered when reading from a GridFS Stream. |
110
110
|**MongoUnexpectedServerResponseError**| Thrown when the driver receives a **parsable** response it did not expect from the server. |
111
111
112
+
### `MongoOperationTimeoutError`
113
+
114
+
The `MongoOperationTimeoutError` class represents an error that occurs when an operation could not be completed within the specified `timeoutMS`.
115
+
It is generated by the driver in support of the "client side operation timeout" feature and inherits from `MongoDriverError`.
116
+
When `timeoutMS` is enabled `MongoServerErrors` relating to `MaxTimeExpired` errors will be converted to `MongoOperationTimeoutError`.
117
+
112
118
### MongoUnexpectedServerResponseError
113
119
114
120
Intended for the scenario where the MongoDB returns an unexpected response in relation to some state the driver is in.
0 commit comments