diff --git a/README.md b/README.md index b47a5fe367c..8fa1c94d697 100644 --- a/README.md +++ b/README.md @@ -337,7 +337,8 @@ See [Dispatcher.upgrade](./docs/docs/api/Dispatcher.md#dispatcherupgradeoptions- * dispatcher `Dispatcher` -Sets the global dispatcher used by Common API Methods. +Sets the global dispatcher used by Common API Methods. Global dispatcher is shared among compatible undici modules, +including undici that is bundled internally with node.js. ### `undici.getGlobalDispatcher()` diff --git a/docs/docs/api/Errors.md b/docs/docs/api/Errors.md index c32868912a6..dfba3b39ce0 100644 --- a/docs/docs/api/Errors.md +++ b/docs/docs/api/Errors.md @@ -28,6 +28,7 @@ import { errors } from 'undici' | `ResponseExceededMaxSizeError` | `UND_ERR_RES_EXCEEDED_MAX_SIZE` | response body exceed the max size allowed | | `SecureProxyConnectionError` | `UND_ERR_PRX_TLS` | tls connection to a proxy failed | +Be aware of the possible difference between the global dispatcher version and the actual undici version you might be using. We recommend to avoid the check `instanceof errors.UndiciError` and seek for the `error.code === ''` instead to avoid inconsistencies. ### `SocketError` The `SocketError` has a `.socket` property which holds socket metadata: