Skip to content

Commit 0e6f566

Browse files
committed
docs
1 parent 907a1a8 commit 0e6f566

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/mongo_types.ts

+5-3
Original file line numberDiff line numberDiff line change
@@ -483,9 +483,11 @@ export type Abortable = {
483483
* The `signal.reason` value is used as the error thrown.
484484
*
485485
* @remarks
486-
* **NOTE:** Currently, aborting an in-progress operation causes the in-use Connection (e.g, during socket read or write) to close.
487-
* If signals are aborted at a high rate it will cause many connections that are otherwise healthy
488-
* to be discarded. We plan to mitigate this in a future release, please follow NODE-6062 (`timeoutMS` expiration suffers the same limitation).
486+
* **NOTE:** If an abort signal aborts an operation while the driver is writing to the underlying
487+
* socket or reading the response from the server, the socket will be closed.
488+
* If signals are aborted at a high rate during socket read/writes this can lead to a high rate of connection reestablishment.
489+
*
490+
* We plan to mitigate this in a future release, please follow NODE-6062 (`timeoutMS` expiration suffers the same limitation).
489491
*
490492
* AbortSignals are likely a best fit for human interactive interruption (ex. ctrl-C) where the frequency
491493
* of cancellation is reasonably low. If a signal is programmatically aborted for 100s of operations you can empty

0 commit comments

Comments
 (0)