Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nbbeeken committed Jan 24, 2025
1 parent 907a1a8 commit 0e6f566
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/mongo_types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -483,9 +483,11 @@ export type Abortable = {
* The `signal.reason` value is used as the error thrown.
*
* @remarks
* **NOTE:** Currently, aborting an in-progress operation causes the in-use Connection (e.g, during socket read or write) to close.
* If signals are aborted at a high rate it will cause many connections that are otherwise healthy
* to be discarded. We plan to mitigate this in a future release, please follow NODE-6062 (`timeoutMS` expiration suffers the same limitation).
* **NOTE:** If an abort signal aborts an operation while the driver is writing to the underlying
* socket or reading the response from the server, the socket will be closed.
* If signals are aborted at a high rate during socket read/writes this can lead to a high rate of connection reestablishment.
*
* We plan to mitigate this in a future release, please follow NODE-6062 (`timeoutMS` expiration suffers the same limitation).
*
* AbortSignals are likely a best fit for human interactive interruption (ex. ctrl-C) where the frequency
* of cancellation is reasonably low. If a signal is programmatically aborted for 100s of operations you can empty
Expand Down

0 comments on commit 0e6f566

Please sign in to comment.