pi-cursor-sdk 0.1.50 → 0.1.52

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (279) hide show
  1. package/CHANGELOG.md +31 -0
  2. package/README.md +1 -1
  3. package/docs/cursor-live-smoke-checklist.md +4 -4
  4. package/docs/cursor-model-ux-spec.md +5 -5
  5. package/docs/cursor-native-tool-replay.md +2 -2
  6. package/docs/cursor-native-tool-visual-audit.md +1 -1
  7. package/docs/cursor-testing-lessons.md +1 -1
  8. package/package.json +3 -12
  9. package/src/cursor-fallback-models.generated.ts +536 -302
  10. package/src/cursor-provider-errors.ts +29 -0
  11. package/src/cursor-provider-turn-runner.ts +1 -1
  12. package/src/cursor-provider.ts +9 -2
  13. package/src/cursor-session-turn-queue.ts +52 -0
  14. package/src/cursor-tool-manifest.ts +1 -1
  15. package/node_modules/@connectrpc/connect-node/README.md +0 -141
  16. package/node_modules/@connectrpc/connect-node/dist/cjs/compression.d.ts +0 -15
  17. package/node_modules/@connectrpc/connect-node/dist/cjs/compression.js +0 -89
  18. package/node_modules/@connectrpc/connect-node/dist/cjs/connect-node-adapter.d.ts +0 -42
  19. package/node_modules/@connectrpc/connect-node/dist/cjs/connect-node-adapter.js +0 -61
  20. package/node_modules/@connectrpc/connect-node/dist/cjs/connect-transport.d.ts +0 -100
  21. package/node_modules/@connectrpc/connect-node/dist/cjs/connect-transport.js +0 -25
  22. package/node_modules/@connectrpc/connect-node/dist/cjs/grpc-transport.d.ts +0 -96
  23. package/node_modules/@connectrpc/connect-node/dist/cjs/grpc-transport.js +0 -25
  24. package/node_modules/@connectrpc/connect-node/dist/cjs/grpc-web-transport.d.ts +0 -96
  25. package/node_modules/@connectrpc/connect-node/dist/cjs/grpc-web-transport.js +0 -25
  26. package/node_modules/@connectrpc/connect-node/dist/cjs/http2-session-manager.d.ts +0 -146
  27. package/node_modules/@connectrpc/connect-node/dist/cjs/http2-session-manager.js +0 -536
  28. package/node_modules/@connectrpc/connect-node/dist/cjs/index.d.ts +0 -15
  29. package/node_modules/@connectrpc/connect-node/dist/cjs/index.js +0 -36
  30. package/node_modules/@connectrpc/connect-node/dist/cjs/node-error.d.ts +0 -45
  31. package/node_modules/@connectrpc/connect-node/dist/cjs/node-error.js +0 -154
  32. package/node_modules/@connectrpc/connect-node/dist/cjs/node-headers-polyfill.d.ts +0 -1
  33. package/node_modules/@connectrpc/connect-node/dist/cjs/node-headers-polyfill.js +0 -29
  34. package/node_modules/@connectrpc/connect-node/dist/cjs/node-transport-options.d.ts +0 -89
  35. package/node_modules/@connectrpc/connect-node/dist/cjs/node-transport-options.js +0 -58
  36. package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-client.d.ts +0 -54
  37. package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-client.js +0 -326
  38. package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-handler.d.ts +0 -41
  39. package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-handler.js +0 -234
  40. package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-header.d.ts +0 -19
  41. package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-header.js +0 -97
  42. package/node_modules/@connectrpc/connect-node/dist/cjs/package.json +0 -1
  43. package/node_modules/@connectrpc/connect-node/dist/esm/compression.d.ts +0 -15
  44. package/node_modules/@connectrpc/connect-node/dist/esm/compression.js +0 -86
  45. package/node_modules/@connectrpc/connect-node/dist/esm/connect-node-adapter.d.ts +0 -42
  46. package/node_modules/@connectrpc/connect-node/dist/esm/connect-node-adapter.js +0 -58
  47. package/node_modules/@connectrpc/connect-node/dist/esm/connect-transport.d.ts +0 -100
  48. package/node_modules/@connectrpc/connect-node/dist/esm/connect-transport.js +0 -22
  49. package/node_modules/@connectrpc/connect-node/dist/esm/grpc-transport.d.ts +0 -96
  50. package/node_modules/@connectrpc/connect-node/dist/esm/grpc-transport.js +0 -22
  51. package/node_modules/@connectrpc/connect-node/dist/esm/grpc-web-transport.d.ts +0 -96
  52. package/node_modules/@connectrpc/connect-node/dist/esm/grpc-web-transport.js +0 -22
  53. package/node_modules/@connectrpc/connect-node/dist/esm/http2-session-manager.d.ts +0 -146
  54. package/node_modules/@connectrpc/connect-node/dist/esm/http2-session-manager.js +0 -532
  55. package/node_modules/@connectrpc/connect-node/dist/esm/index.d.ts +0 -15
  56. package/node_modules/@connectrpc/connect-node/dist/esm/index.js +0 -23
  57. package/node_modules/@connectrpc/connect-node/dist/esm/node-error.d.ts +0 -45
  58. package/node_modules/@connectrpc/connect-node/dist/esm/node-error.js +0 -147
  59. package/node_modules/@connectrpc/connect-node/dist/esm/node-headers-polyfill.d.ts +0 -1
  60. package/node_modules/@connectrpc/connect-node/dist/esm/node-headers-polyfill.js +0 -27
  61. package/node_modules/@connectrpc/connect-node/dist/esm/node-transport-options.d.ts +0 -89
  62. package/node_modules/@connectrpc/connect-node/dist/esm/node-transport-options.js +0 -58
  63. package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-client.d.ts +0 -54
  64. package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-client.js +0 -324
  65. package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-handler.d.ts +0 -41
  66. package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-handler.js +0 -230
  67. package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-header.d.ts +0 -19
  68. package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-header.js +0 -93
  69. package/node_modules/@connectrpc/connect-node/package.json +0 -46
  70. package/node_modules/undici/LICENSE +0 -21
  71. package/node_modules/undici/README.md +0 -741
  72. package/node_modules/undici/docs/docs/api/Agent.md +0 -84
  73. package/node_modules/undici/docs/docs/api/BalancedPool.md +0 -99
  74. package/node_modules/undici/docs/docs/api/CacheStorage.md +0 -30
  75. package/node_modules/undici/docs/docs/api/CacheStore.md +0 -164
  76. package/node_modules/undici/docs/docs/api/Client.md +0 -288
  77. package/node_modules/undici/docs/docs/api/ClientStats.md +0 -27
  78. package/node_modules/undici/docs/docs/api/Connector.md +0 -115
  79. package/node_modules/undici/docs/docs/api/ContentType.md +0 -57
  80. package/node_modules/undici/docs/docs/api/Cookies.md +0 -128
  81. package/node_modules/undici/docs/docs/api/Debug.md +0 -62
  82. package/node_modules/undici/docs/docs/api/DiagnosticsChannel.md +0 -315
  83. package/node_modules/undici/docs/docs/api/Dispatcher.md +0 -1392
  84. package/node_modules/undici/docs/docs/api/EnvHttpProxyAgent.md +0 -159
  85. package/node_modules/undici/docs/docs/api/Errors.md +0 -49
  86. package/node_modules/undici/docs/docs/api/EventSource.md +0 -45
  87. package/node_modules/undici/docs/docs/api/Fetch.md +0 -60
  88. package/node_modules/undici/docs/docs/api/GlobalInstallation.md +0 -139
  89. package/node_modules/undici/docs/docs/api/H2CClient.md +0 -263
  90. package/node_modules/undici/docs/docs/api/MockAgent.md +0 -603
  91. package/node_modules/undici/docs/docs/api/MockCallHistory.md +0 -197
  92. package/node_modules/undici/docs/docs/api/MockCallHistoryLog.md +0 -43
  93. package/node_modules/undici/docs/docs/api/MockClient.md +0 -81
  94. package/node_modules/undici/docs/docs/api/MockErrors.md +0 -12
  95. package/node_modules/undici/docs/docs/api/MockPool.md +0 -555
  96. package/node_modules/undici/docs/docs/api/Pool.md +0 -84
  97. package/node_modules/undici/docs/docs/api/PoolStats.md +0 -35
  98. package/node_modules/undici/docs/docs/api/ProxyAgent.md +0 -229
  99. package/node_modules/undici/docs/docs/api/RedirectHandler.md +0 -93
  100. package/node_modules/undici/docs/docs/api/RetryAgent.md +0 -50
  101. package/node_modules/undici/docs/docs/api/RetryHandler.md +0 -118
  102. package/node_modules/undici/docs/docs/api/RoundRobinPool.md +0 -145
  103. package/node_modules/undici/docs/docs/api/SnapshotAgent.md +0 -616
  104. package/node_modules/undici/docs/docs/api/Socks5ProxyAgent.md +0 -275
  105. package/node_modules/undici/docs/docs/api/Util.md +0 -25
  106. package/node_modules/undici/docs/docs/api/WebSocket.md +0 -141
  107. package/node_modules/undici/docs/docs/api/api-lifecycle.md +0 -91
  108. package/node_modules/undici/docs/docs/best-practices/client-certificate.md +0 -64
  109. package/node_modules/undici/docs/docs/best-practices/crawling.md +0 -58
  110. package/node_modules/undici/docs/docs/best-practices/mocking-request.md +0 -190
  111. package/node_modules/undici/docs/docs/best-practices/proxy.md +0 -127
  112. package/node_modules/undici/docs/docs/best-practices/undici-vs-builtin-fetch.md +0 -224
  113. package/node_modules/undici/docs/docs/best-practices/writing-tests.md +0 -63
  114. package/node_modules/undici/index-fetch.js +0 -65
  115. package/node_modules/undici/index.d.ts +0 -3
  116. package/node_modules/undici/index.js +0 -234
  117. package/node_modules/undici/lib/api/abort-signal.js +0 -59
  118. package/node_modules/undici/lib/api/api-connect.js +0 -110
  119. package/node_modules/undici/lib/api/api-pipeline.js +0 -252
  120. package/node_modules/undici/lib/api/api-request.js +0 -214
  121. package/node_modules/undici/lib/api/api-stream.js +0 -209
  122. package/node_modules/undici/lib/api/api-upgrade.js +0 -111
  123. package/node_modules/undici/lib/api/index.js +0 -7
  124. package/node_modules/undici/lib/api/readable.js +0 -580
  125. package/node_modules/undici/lib/cache/memory-cache-store.js +0 -234
  126. package/node_modules/undici/lib/cache/sqlite-cache-store.js +0 -461
  127. package/node_modules/undici/lib/core/connect.js +0 -153
  128. package/node_modules/undici/lib/core/constants.js +0 -143
  129. package/node_modules/undici/lib/core/diagnostics.js +0 -227
  130. package/node_modules/undici/lib/core/errors.js +0 -477
  131. package/node_modules/undici/lib/core/request.js +0 -453
  132. package/node_modules/undici/lib/core/socks5-client.js +0 -422
  133. package/node_modules/undici/lib/core/socks5-utils.js +0 -212
  134. package/node_modules/undici/lib/core/symbols.js +0 -75
  135. package/node_modules/undici/lib/core/tree.js +0 -160
  136. package/node_modules/undici/lib/core/util.js +0 -992
  137. package/node_modules/undici/lib/dispatcher/agent.js +0 -158
  138. package/node_modules/undici/lib/dispatcher/balanced-pool.js +0 -219
  139. package/node_modules/undici/lib/dispatcher/client-h1.js +0 -1722
  140. package/node_modules/undici/lib/dispatcher/client-h2.js +0 -995
  141. package/node_modules/undici/lib/dispatcher/client.js +0 -664
  142. package/node_modules/undici/lib/dispatcher/dispatcher-base.js +0 -184
  143. package/node_modules/undici/lib/dispatcher/dispatcher.js +0 -48
  144. package/node_modules/undici/lib/dispatcher/env-http-proxy-agent.js +0 -146
  145. package/node_modules/undici/lib/dispatcher/fixed-queue.js +0 -135
  146. package/node_modules/undici/lib/dispatcher/h2c-client.js +0 -51
  147. package/node_modules/undici/lib/dispatcher/pool-base.js +0 -214
  148. package/node_modules/undici/lib/dispatcher/pool.js +0 -118
  149. package/node_modules/undici/lib/dispatcher/proxy-agent.js +0 -319
  150. package/node_modules/undici/lib/dispatcher/retry-agent.js +0 -35
  151. package/node_modules/undici/lib/dispatcher/round-robin-pool.js +0 -137
  152. package/node_modules/undici/lib/dispatcher/socks5-proxy-agent.js +0 -260
  153. package/node_modules/undici/lib/encoding/index.js +0 -33
  154. package/node_modules/undici/lib/global.js +0 -59
  155. package/node_modules/undici/lib/handler/cache-handler.js +0 -578
  156. package/node_modules/undici/lib/handler/cache-revalidation-handler.js +0 -124
  157. package/node_modules/undici/lib/handler/decorator-handler.js +0 -67
  158. package/node_modules/undici/lib/handler/deduplication-handler.js +0 -460
  159. package/node_modules/undici/lib/handler/redirect-handler.js +0 -238
  160. package/node_modules/undici/lib/handler/retry-handler.js +0 -394
  161. package/node_modules/undici/lib/handler/unwrap-handler.js +0 -106
  162. package/node_modules/undici/lib/handler/wrap-handler.js +0 -105
  163. package/node_modules/undici/lib/interceptor/cache.js +0 -495
  164. package/node_modules/undici/lib/interceptor/decompress.js +0 -259
  165. package/node_modules/undici/lib/interceptor/deduplicate.js +0 -117
  166. package/node_modules/undici/lib/interceptor/dns.js +0 -571
  167. package/node_modules/undici/lib/interceptor/dump.js +0 -112
  168. package/node_modules/undici/lib/interceptor/redirect.js +0 -21
  169. package/node_modules/undici/lib/interceptor/response-error.js +0 -95
  170. package/node_modules/undici/lib/interceptor/retry.js +0 -19
  171. package/node_modules/undici/lib/llhttp/.gitkeep +0 -0
  172. package/node_modules/undici/lib/llhttp/constants.d.ts +0 -195
  173. package/node_modules/undici/lib/llhttp/constants.js +0 -531
  174. package/node_modules/undici/lib/llhttp/llhttp-wasm.js +0 -15
  175. package/node_modules/undici/lib/llhttp/llhttp_simd-wasm.js +0 -15
  176. package/node_modules/undici/lib/llhttp/utils.d.ts +0 -2
  177. package/node_modules/undici/lib/llhttp/utils.js +0 -12
  178. package/node_modules/undici/lib/mock/mock-agent.js +0 -232
  179. package/node_modules/undici/lib/mock/mock-call-history.js +0 -248
  180. package/node_modules/undici/lib/mock/mock-client.js +0 -68
  181. package/node_modules/undici/lib/mock/mock-errors.js +0 -29
  182. package/node_modules/undici/lib/mock/mock-interceptor.js +0 -209
  183. package/node_modules/undici/lib/mock/mock-pool.js +0 -68
  184. package/node_modules/undici/lib/mock/mock-symbols.js +0 -32
  185. package/node_modules/undici/lib/mock/mock-utils.js +0 -486
  186. package/node_modules/undici/lib/mock/pending-interceptors-formatter.js +0 -43
  187. package/node_modules/undici/lib/mock/snapshot-agent.js +0 -353
  188. package/node_modules/undici/lib/mock/snapshot-recorder.js +0 -588
  189. package/node_modules/undici/lib/mock/snapshot-utils.js +0 -158
  190. package/node_modules/undici/lib/util/cache.js +0 -414
  191. package/node_modules/undici/lib/util/date.js +0 -653
  192. package/node_modules/undici/lib/util/promise.js +0 -28
  193. package/node_modules/undici/lib/util/runtime-features.js +0 -124
  194. package/node_modules/undici/lib/util/stats.js +0 -32
  195. package/node_modules/undici/lib/util/timers.js +0 -425
  196. package/node_modules/undici/lib/web/cache/cache.js +0 -864
  197. package/node_modules/undici/lib/web/cache/cachestorage.js +0 -152
  198. package/node_modules/undici/lib/web/cache/util.js +0 -45
  199. package/node_modules/undici/lib/web/cookies/constants.js +0 -12
  200. package/node_modules/undici/lib/web/cookies/index.js +0 -199
  201. package/node_modules/undici/lib/web/cookies/parse.js +0 -314
  202. package/node_modules/undici/lib/web/cookies/util.js +0 -282
  203. package/node_modules/undici/lib/web/eventsource/eventsource-stream.js +0 -399
  204. package/node_modules/undici/lib/web/eventsource/eventsource.js +0 -501
  205. package/node_modules/undici/lib/web/eventsource/util.js +0 -29
  206. package/node_modules/undici/lib/web/fetch/LICENSE +0 -21
  207. package/node_modules/undici/lib/web/fetch/body.js +0 -509
  208. package/node_modules/undici/lib/web/fetch/constants.js +0 -131
  209. package/node_modules/undici/lib/web/fetch/data-url.js +0 -596
  210. package/node_modules/undici/lib/web/fetch/formdata-parser.js +0 -586
  211. package/node_modules/undici/lib/web/fetch/formdata.js +0 -259
  212. package/node_modules/undici/lib/web/fetch/global.js +0 -40
  213. package/node_modules/undici/lib/web/fetch/headers.js +0 -719
  214. package/node_modules/undici/lib/web/fetch/index.js +0 -2413
  215. package/node_modules/undici/lib/web/fetch/request.js +0 -1115
  216. package/node_modules/undici/lib/web/fetch/response.js +0 -641
  217. package/node_modules/undici/lib/web/fetch/util.js +0 -1522
  218. package/node_modules/undici/lib/web/infra/index.js +0 -229
  219. package/node_modules/undici/lib/web/subresource-integrity/Readme.md +0 -9
  220. package/node_modules/undici/lib/web/subresource-integrity/subresource-integrity.js +0 -307
  221. package/node_modules/undici/lib/web/webidl/index.js +0 -1006
  222. package/node_modules/undici/lib/web/websocket/connection.js +0 -329
  223. package/node_modules/undici/lib/web/websocket/constants.js +0 -126
  224. package/node_modules/undici/lib/web/websocket/events.js +0 -331
  225. package/node_modules/undici/lib/web/websocket/frame.js +0 -133
  226. package/node_modules/undici/lib/web/websocket/permessage-deflate.js +0 -100
  227. package/node_modules/undici/lib/web/websocket/receiver.js +0 -507
  228. package/node_modules/undici/lib/web/websocket/sender.js +0 -109
  229. package/node_modules/undici/lib/web/websocket/stream/websocketerror.js +0 -104
  230. package/node_modules/undici/lib/web/websocket/stream/websocketstream.js +0 -498
  231. package/node_modules/undici/lib/web/websocket/util.js +0 -347
  232. package/node_modules/undici/lib/web/websocket/websocket.js +0 -758
  233. package/node_modules/undici/package.json +0 -152
  234. package/node_modules/undici/scripts/strip-comments.js +0 -10
  235. package/node_modules/undici/types/README.md +0 -6
  236. package/node_modules/undici/types/agent.d.ts +0 -32
  237. package/node_modules/undici/types/api.d.ts +0 -43
  238. package/node_modules/undici/types/balanced-pool.d.ts +0 -30
  239. package/node_modules/undici/types/cache-interceptor.d.ts +0 -179
  240. package/node_modules/undici/types/cache.d.ts +0 -36
  241. package/node_modules/undici/types/client-stats.d.ts +0 -15
  242. package/node_modules/undici/types/client.d.ts +0 -139
  243. package/node_modules/undici/types/connector.d.ts +0 -36
  244. package/node_modules/undici/types/content-type.d.ts +0 -21
  245. package/node_modules/undici/types/cookies.d.ts +0 -30
  246. package/node_modules/undici/types/diagnostics-channel.d.ts +0 -74
  247. package/node_modules/undici/types/dispatcher.d.ts +0 -275
  248. package/node_modules/undici/types/env-http-proxy-agent.d.ts +0 -22
  249. package/node_modules/undici/types/errors.d.ts +0 -177
  250. package/node_modules/undici/types/eventsource.d.ts +0 -66
  251. package/node_modules/undici/types/fetch.d.ts +0 -231
  252. package/node_modules/undici/types/formdata.d.ts +0 -114
  253. package/node_modules/undici/types/global-dispatcher.d.ts +0 -9
  254. package/node_modules/undici/types/global-origin.d.ts +0 -7
  255. package/node_modules/undici/types/h2c-client.d.ts +0 -73
  256. package/node_modules/undici/types/handlers.d.ts +0 -14
  257. package/node_modules/undici/types/header.d.ts +0 -160
  258. package/node_modules/undici/types/index.d.ts +0 -91
  259. package/node_modules/undici/types/interceptors.d.ts +0 -80
  260. package/node_modules/undici/types/mock-agent.d.ts +0 -68
  261. package/node_modules/undici/types/mock-call-history.d.ts +0 -111
  262. package/node_modules/undici/types/mock-client.d.ts +0 -27
  263. package/node_modules/undici/types/mock-errors.d.ts +0 -12
  264. package/node_modules/undici/types/mock-interceptor.d.ts +0 -94
  265. package/node_modules/undici/types/mock-pool.d.ts +0 -27
  266. package/node_modules/undici/types/patch.d.ts +0 -29
  267. package/node_modules/undici/types/pool-stats.d.ts +0 -19
  268. package/node_modules/undici/types/pool.d.ts +0 -41
  269. package/node_modules/undici/types/proxy-agent.d.ts +0 -29
  270. package/node_modules/undici/types/readable.d.ts +0 -68
  271. package/node_modules/undici/types/retry-agent.d.ts +0 -8
  272. package/node_modules/undici/types/retry-handler.d.ts +0 -125
  273. package/node_modules/undici/types/round-robin-pool.d.ts +0 -41
  274. package/node_modules/undici/types/snapshot-agent.d.ts +0 -109
  275. package/node_modules/undici/types/socks5-proxy-agent.d.ts +0 -25
  276. package/node_modules/undici/types/util.d.ts +0 -18
  277. package/node_modules/undici/types/utility.d.ts +0 -7
  278. package/node_modules/undici/types/webidl.d.ts +0 -347
  279. package/node_modules/undici/types/websocket.d.ts +0 -188
@@ -1,229 +0,0 @@
1
- # Class: ProxyAgent
2
-
3
- Extends: `undici.Dispatcher`
4
-
5
- A Proxy Agent class that implements the Agent API. It allows the connection through proxy in a simple way.
6
-
7
- ## `new ProxyAgent([options])`
8
-
9
- Arguments:
10
-
11
- * **options** `ProxyAgentOptions` (required) - It extends the `Agent` options.
12
-
13
- Returns: `ProxyAgent`
14
-
15
- ### Parameter: `ProxyAgentOptions`
16
-
17
- Extends: [`AgentOptions`](/docs/docs/api/Agent.md#parameter-agentoptions)
18
- > It ommits `AgentOptions#connect`.
19
-
20
- > **Note:** When `AgentOptions#connections` is set, and different from `0`, the non-standard [`proxy-connection` header](https://udger.com/resources/http-request-headers-detail?header=Proxy-Connection) will be set to `keep-alive` in the request.
21
-
22
- * **uri** `string | URL` (required) - The URI of the proxy server. This can be provided as a string, as an instance of the URL class, or as an object with a `uri` property of type string.
23
- If the `uri` is provided as a string or `uri` is an object with an `uri` property of type string, then it will be parsed into a `URL` object according to the [WHATWG URL Specification](https://url.spec.whatwg.org).
24
- For detailed information on the parsing process and potential validation errors, please refer to the ["Writing" section](https://url.spec.whatwg.org/#writing) of the WHATWG URL Specification.
25
- * **token** `string` (optional) - It can be passed by a string of token for authentication.
26
- * **auth** `string` (**deprecated**) - Use token.
27
- * **clientFactory** `(origin: URL, opts: Object) => Dispatcher` (optional) - Default: `(origin, opts) => new Pool(origin, opts)`
28
- * **requestTls** `BuildOptions` (optional) - Options object passed when creating the underlying socket via the connector builder for the request. It extends from [`Client#ConnectOptions`](/docs/docs/api/Client.md#parameter-connectoptions).
29
- * **proxyTls** `BuildOptions` (optional) - Options object passed when creating the underlying socket via the connector builder for the proxy server. It extends from [`Client#ConnectOptions`](/docs/docs/api/Client.md#parameter-connectoptions).
30
- * **proxyTunnel** `boolean` (optional) - For connections involving secure protocols, Undici will always establish a tunnel via the HTTP2 CONNECT extension. If proxyTunnel is set to true, this will occur for unsecured proxy/endpoint connections as well. Currently, there is no way to facilitate HTTP1 IP tunneling as described in https://www.rfc-editor.org/rfc/rfc9484.html#name-http-11-request. If proxyTunnel is set to false (the default), ProxyAgent connections where both the Proxy and Endpoint are unsecured will issue all requests to the Proxy, and prefix the endpoint request path with the endpoint origin address.
31
-
32
- Examples:
33
-
34
- ```js
35
- import { ProxyAgent } from 'undici'
36
-
37
- const proxyAgent = new ProxyAgent('my.proxy.server')
38
- // or
39
- const proxyAgent = new ProxyAgent(new URL('my.proxy.server'))
40
- // or
41
- const proxyAgent = new ProxyAgent({ uri: 'my.proxy.server' })
42
- // or
43
- const proxyAgent = new ProxyAgent({
44
- uri: new URL('my.proxy.server'),
45
- proxyTls: {
46
- signal: AbortSignal.timeout(1000)
47
- }
48
- })
49
- ```
50
-
51
- #### Example - Basic ProxyAgent instantiation
52
-
53
- This will instantiate the ProxyAgent. It will not do anything until registered as the agent to use with requests.
54
-
55
- ```js
56
- import { ProxyAgent } from 'undici'
57
-
58
- const proxyAgent = new ProxyAgent('my.proxy.server')
59
- ```
60
-
61
- #### Example - Basic Proxy Request with global agent dispatcher
62
-
63
- ```js
64
- import { setGlobalDispatcher, request, ProxyAgent } from 'undici'
65
-
66
- const proxyAgent = new ProxyAgent('my.proxy.server')
67
- setGlobalDispatcher(proxyAgent)
68
-
69
- const { statusCode, body } = await request('http://localhost:3000/foo')
70
-
71
- console.log('response received', statusCode) // response received 200
72
-
73
- for await (const data of body) {
74
- console.log('data', data.toString('utf8')) // data foo
75
- }
76
- ```
77
-
78
- #### Example - Basic Proxy Request with local agent dispatcher
79
-
80
- ```js
81
- import { ProxyAgent, request } from 'undici'
82
-
83
- const proxyAgent = new ProxyAgent('my.proxy.server')
84
-
85
- const {
86
- statusCode,
87
- body
88
- } = await request('http://localhost:3000/foo', { dispatcher: proxyAgent })
89
-
90
- console.log('response received', statusCode) // response received 200
91
-
92
- for await (const data of body) {
93
- console.log('data', data.toString('utf8')) // data foo
94
- }
95
- ```
96
-
97
- #### Example - Basic Proxy Request with authentication
98
-
99
- ```js
100
- import { setGlobalDispatcher, request, ProxyAgent } from 'undici';
101
-
102
- const proxyAgent = new ProxyAgent({
103
- uri: 'my.proxy.server',
104
- // token: 'Bearer xxxx'
105
- token: `Basic ${Buffer.from('username:password').toString('base64')}`
106
- });
107
- setGlobalDispatcher(proxyAgent);
108
-
109
- const { statusCode, body } = await request('http://localhost:3000/foo');
110
-
111
- console.log('response received', statusCode); // response received 200
112
-
113
- for await (const data of body) {
114
- console.log('data', data.toString('utf8')); // data foo
115
- }
116
- ```
117
-
118
- ### `ProxyAgent.close()`
119
-
120
- Closes the proxy agent and waits for registered pools and clients to also close before resolving.
121
-
122
- Returns: `Promise<void>`
123
-
124
- #### Example - clean up after tests are complete
125
-
126
- ```js
127
- import { ProxyAgent, setGlobalDispatcher } from 'undici'
128
-
129
- const proxyAgent = new ProxyAgent('my.proxy.server')
130
- setGlobalDispatcher(proxyAgent)
131
-
132
- await proxyAgent.close()
133
- ```
134
-
135
- ### `ProxyAgent.dispatch(options, handlers)`
136
-
137
- Implements [`Agent.dispatch(options, handlers)`](/docs/docs/api/Agent.md#parameter-agentdispatchoptions).
138
-
139
- ### `ProxyAgent.request(options[, callback])`
140
-
141
- See [`Dispatcher.request(options [, callback])`](/docs/docs/api/Dispatcher.md#dispatcherrequestoptions-callback).
142
-
143
-
144
- #### Example - ProxyAgent with Fetch
145
-
146
- This example demonstrates how to use `fetch` with a proxy via `ProxyAgent`. It is particularly useful for scenarios requiring proxy tunneling.
147
-
148
- ```javascript
149
- import { ProxyAgent, fetch } from 'undici';
150
-
151
- // Define the ProxyAgent
152
- const proxyAgent = new ProxyAgent('http://localhost:8000');
153
-
154
- // Make a GET request through the proxy
155
- const response = await fetch('http://localhost:3000/foo', {
156
- dispatcher: proxyAgent,
157
- method: 'GET',
158
- });
159
-
160
- console.log('Response status:', response.status);
161
- console.log('Response data:', await response.text());
162
- ```
163
-
164
- ---
165
-
166
- #### Example - ProxyAgent with a Custom Proxy Server
167
-
168
- This example shows how to create a custom proxy server and use it with `ProxyAgent`.
169
-
170
- ```javascript
171
- import * as http from 'node:http';
172
- import { createProxy } from 'proxy';
173
- import { ProxyAgent, fetch } from 'undici';
174
-
175
- // Create a proxy server
176
- const proxyServer = createProxy(http.createServer());
177
- proxyServer.listen(8000, () => {
178
- console.log('Proxy server running on port 8000');
179
- });
180
-
181
- // Define and use the ProxyAgent
182
- const proxyAgent = new ProxyAgent('http://localhost:8000');
183
-
184
- const response = await fetch('http://example.com', {
185
- dispatcher: proxyAgent,
186
- method: 'GET',
187
- });
188
-
189
- console.log('Response status:', response.status);
190
- console.log('Response data:', await response.text());
191
- ```
192
-
193
- ---
194
-
195
- #### Example - ProxyAgent with HTTPS Tunneling
196
-
197
- This example demonstrates how to perform HTTPS tunneling using a proxy.
198
-
199
- ```javascript
200
- import { ProxyAgent, fetch } from 'undici';
201
-
202
- // Define a ProxyAgent for HTTPS proxy
203
- const proxyAgent = new ProxyAgent('https://secure.proxy.server');
204
-
205
- // Make a request to an HTTPS endpoint via the proxy
206
- const response = await fetch('https://secure.endpoint.com/api/data', {
207
- dispatcher: proxyAgent,
208
- method: 'GET',
209
- });
210
-
211
- console.log('Response status:', response.status);
212
- console.log('Response data:', await response.json());
213
- ```
214
-
215
- #### Example - ProxyAgent as a Global Dispatcher
216
-
217
- `ProxyAgent` can be configured as a global dispatcher, making it available for all requests without explicitly passing it. This simplifies code and is useful when a single proxy configuration applies to all requests.
218
-
219
- ```javascript
220
- import { ProxyAgent, setGlobalDispatcher, fetch } from 'undici';
221
-
222
- // Define and configure the ProxyAgent
223
- const proxyAgent = new ProxyAgent('http://localhost:8000');
224
- setGlobalDispatcher(proxyAgent);
225
-
226
- // Make requests without specifying the dispatcher
227
- const response = await fetch('http://example.com');
228
- console.log('Response status:', response.status);
229
- console.log('Response data:', await response.text());
@@ -1,93 +0,0 @@
1
- # Class: RedirectHandler
2
-
3
- A class that handles redirection logic for HTTP requests.
4
-
5
- ## `new RedirectHandler(dispatch, maxRedirections, opts, handler)`
6
-
7
- Arguments:
8
-
9
- - **dispatch** `function` - The dispatch function to be called after every retry.
10
- - **maxRedirections** `number` - Maximum number of redirections allowed.
11
- - **opts** `object` - Options for handling redirection.
12
- - **handler** `object` - An object containing handlers for different stages of the request lifecycle.
13
-
14
- Returns: `RedirectHandler`
15
-
16
- ### Parameters
17
-
18
- - **dispatch** `(options: Dispatch.DispatchOptions, handlers: Dispatch.DispatchHandler) => Promise<Dispatch.DispatchResponse>` (required) - Dispatch function to be called after every redirection.
19
- - **maxRedirections** `number` (required) - Maximum number of redirections allowed.
20
- - **opts** `object` (required) - Options for handling redirection.
21
- - **handler** `object` (required) - Handlers for different stages of the request lifecycle.
22
-
23
- ### Properties
24
-
25
- - **location** `string` - The current redirection location.
26
- - **abort** `function` - The abort function.
27
- - **opts** `object` - The options for handling redirection.
28
- - **maxRedirections** `number` - Maximum number of redirections allowed.
29
- - **handler** `object` - Handlers for different stages of the request lifecycle.
30
- - **history** `Array` - An array representing the history of URLs during redirection.
31
-
32
- ### Methods
33
-
34
- #### `onConnect(abort)`
35
-
36
- Called when the connection is established.
37
-
38
- Parameters:
39
-
40
- - **abort** `function` - The abort function.
41
-
42
- #### `onUpgrade(statusCode, headers, socket)`
43
-
44
- Called when an upgrade is requested.
45
-
46
- Parameters:
47
-
48
- - **statusCode** `number` - The HTTP status code.
49
- - **headers** `object` - The headers received in the response.
50
- - **socket** `object` - The socket object.
51
-
52
- #### `onError(error)`
53
-
54
- Called when an error occurs.
55
-
56
- Parameters:
57
-
58
- - **error** `Error` - The error that occurred.
59
-
60
- #### `onHeaders(statusCode, headers, resume, statusText)`
61
-
62
- Called when headers are received.
63
-
64
- Parameters:
65
-
66
- - **statusCode** `number` - The HTTP status code.
67
- - **headers** `object` - The headers received in the response.
68
- - **resume** `function` - The resume function.
69
- - **statusText** `string` - The status text.
70
-
71
- #### `onData(chunk)`
72
-
73
- Called when data is received.
74
-
75
- Parameters:
76
-
77
- - **chunk** `Buffer` - The data chunk received.
78
-
79
- #### `onComplete(trailers)`
80
-
81
- Called when the request is complete.
82
-
83
- Parameters:
84
-
85
- - **trailers** `object` - The trailers received.
86
-
87
- #### `onBodySent(chunk)`
88
-
89
- Called when the request body is sent.
90
-
91
- Parameters:
92
-
93
- - **chunk** `Buffer` - The chunk of the request body sent.
@@ -1,50 +0,0 @@
1
- # Class: RetryAgent
2
-
3
- Extends: `undici.Dispatcher`
4
-
5
- A `undici.Dispatcher` that allows to automatically retry a request.
6
- Wraps a `undici.RetryHandler`.
7
-
8
- ## `new RetryAgent(dispatcher, [options])`
9
-
10
- Arguments:
11
-
12
- * **dispatcher** `undici.Dispatcher` (required) - the dispatcher to wrap
13
- * **options** `RetryHandlerOptions` (optional) - the options
14
-
15
- Returns: `ProxyAgent`
16
-
17
- ### Parameter: `RetryHandlerOptions`
18
-
19
- - **throwOnError** `boolean` (optional) - Disable to prevent throwing error on last retry attept, useful if you need the body on errors from server or if you have custom error handler. Default: `true`
20
- - **retry** `(err: Error, context: RetryContext, callback: (err?: Error | null) => void) => void` (optional) - Function to be called after every retry. It should pass error if no more retries should be performed.
21
- - **maxRetries** `number` (optional) - Maximum number of retries. Default: `5`
22
- - **maxTimeout** `number` (optional) - Maximum number of milliseconds to wait before retrying. Default: `30000` (30 seconds)
23
- - **minTimeout** `number` (optional) - Minimum number of milliseconds to wait before retrying. Default: `500` (half a second)
24
- - **timeoutFactor** `number` (optional) - Factor to multiply the timeout by for each retry attempt. Default: `2`
25
- - **retryAfter** `boolean` (optional) - It enables automatic retry after the `Retry-After` header is received. Default: `true`
26
- -
27
- - **methods** `string[]` (optional) - Array of HTTP methods to retry. Default: `['GET', 'PUT', 'HEAD', 'OPTIONS', 'DELETE']`
28
- - **statusCodes** `number[]` (optional) - Array of HTTP status codes to retry. Default: `[429, 500, 502, 503, 504]`
29
- - **errorCodes** `string[]` (optional) - Array of Error codes to retry. Default: `['ECONNRESET', 'ECONNREFUSED', 'ENOTFOUND', 'ENETDOWN','ENETUNREACH', 'EHOSTDOWN', 'UND_ERR_SOCKET']`
30
-
31
- **`RetryContext`**
32
-
33
- - `state`: `RetryState` - Current retry state. It can be mutated.
34
- - `opts`: `Dispatch.DispatchOptions & RetryOptions` - Options passed to the retry handler.
35
-
36
- Example:
37
-
38
- ```js
39
- import { Agent, RetryAgent } from 'undici'
40
-
41
- const agent = new RetryAgent(new Agent())
42
-
43
- const res = await agent.request({
44
- method: 'GET',
45
- origin: 'http://example.com',
46
- path: '/',
47
- })
48
- console.log(res.statusCode)
49
- console.log(await res.body.text())
50
- ```
@@ -1,118 +0,0 @@
1
- # Class: RetryHandler
2
-
3
- Extends: `undici.DispatcherHandlers`
4
-
5
- A handler class that implements the retry logic for a request.
6
-
7
- ## `new RetryHandler(dispatchOptions, retryHandlers, [retryOptions])`
8
-
9
- Arguments:
10
-
11
- - **options** `Dispatch.DispatchOptions & RetryOptions` (required) - It is an intersection of `Dispatcher.DispatchOptions` and `RetryOptions`.
12
- - **retryHandlers** `RetryHandlers` (required) - Object containing the `dispatch` to be used on every retry, and `handler` for handling the `dispatch` lifecycle.
13
-
14
- Returns: `retryHandler`
15
-
16
- ### Parameter: `Dispatch.DispatchOptions & RetryOptions`
17
-
18
- Extends: [`Dispatch.DispatchOptions`](/docs/docs/api/Dispatcher.md#parameter-dispatchoptions).
19
-
20
- #### `RetryOptions`
21
-
22
- - **throwOnError** `boolean` (optional) - Disable to prevent throwing error on last retry attept, useful if you need the body on errors from server or if you have custom error handler.
23
- - **retry** `(err: Error, context: RetryContext, callback: (err?: Error | null) => void) => number | null` (optional) - Function to be called after every retry. It should pass error if no more retries should be performed.
24
- - **maxRetries** `number` (optional) - Maximum number of retries. Default: `5`
25
- - **maxTimeout** `number` (optional) - Maximum number of milliseconds to wait before retrying. Default: `30000` (30 seconds)
26
- - **minTimeout** `number` (optional) - Minimum number of milliseconds to wait before retrying. Default: `500` (half a second)
27
- - **timeoutFactor** `number` (optional) - Factor to multiply the timeout by for each retry attempt. Default: `2`
28
- - **retryAfter** `boolean` (optional) - It enables automatic retry after the `Retry-After` header is received. Default: `true`
29
- -
30
- - **methods** `string[]` (optional) - Array of HTTP methods to retry. Default: `['GET', 'PUT', 'HEAD', 'OPTIONS', 'DELETE']`
31
- - **statusCodes** `number[]` (optional) - Array of HTTP status codes to retry. Default: `[429, 500, 502, 503, 504]`
32
- - **errorCodes** `string[]` (optional) - Array of Error codes to retry. Default: `['ECONNRESET', 'ECONNREFUSED', 'ENOTFOUND', 'ENETDOWN','ENETUNREACH', 'EHOSTDOWN', 'UND_ERR_SOCKET']`
33
-
34
- **`RetryContext`**
35
-
36
- - `state`: `RetryState` - Current retry state. It can be mutated.
37
- - `opts`: `Dispatch.DispatchOptions & RetryOptions` - Options passed to the retry handler.
38
-
39
- **`RetryState`**
40
-
41
- It represents the retry state for a given request.
42
-
43
- - `counter`: `number` - Current retry attempt.
44
-
45
- ### Parameter `RetryHandlers`
46
-
47
- - **dispatch** `(options: Dispatch.DispatchOptions, handlers: Dispatch.DispatchHandler) => Promise<Dispatch.DispatchResponse>` (required) - Dispatch function to be called after every retry.
48
- - **handler** Extends [`Dispatch.DispatchHandler`](/docs/docs/api/Dispatcher.md#dispatcherdispatchoptions-handler) (required) - Handler function to be called after the request is successful or the retries are exhausted.
49
-
50
- >__Note__: The `RetryHandler` does not retry over stateful bodies (e.g. streams, AsyncIterable) as those, once consumed, are left in a state that cannot be reutilized. For these situations the `RetryHandler` will identify
51
- >the body as stateful and will not retry the request rejecting with the error `UND_ERR_REQ_RETRY`.
52
-
53
- Examples:
54
-
55
- ```js
56
- const client = new Client(`http://localhost:${server.address().port}`);
57
- const chunks = [];
58
- const handler = new RetryHandler(
59
- {
60
- ...dispatchOptions,
61
- retryOptions: {
62
- // custom retry function
63
- retry: function (err, state, callback) {
64
- counter++;
65
-
66
- if (err.code && err.code === "UND_ERR_DESTROYED") {
67
- callback(err);
68
- return;
69
- }
70
-
71
- if (err.statusCode === 206) {
72
- callback(err);
73
- return;
74
- }
75
-
76
- setTimeout(() => callback(null), 1000);
77
- },
78
- },
79
- },
80
- {
81
- dispatch: (...args) => {
82
- return client.dispatch(...args);
83
- },
84
- handler: {
85
- onConnect() {},
86
- onBodySent() {},
87
- onHeaders(status, _rawHeaders, resume, _statusMessage) {
88
- // do something with headers
89
- },
90
- onData(chunk) {
91
- chunks.push(chunk);
92
- return true;
93
- },
94
- onComplete() {},
95
- onError() {
96
- // handle error properly
97
- },
98
- },
99
- }
100
- );
101
- ```
102
-
103
- #### Example - Basic RetryHandler with defaults
104
-
105
- ```js
106
- const client = new Client(`http://localhost:${server.address().port}`);
107
- const handler = new RetryHandler(dispatchOptions, {
108
- dispatch: client.dispatch.bind(client),
109
- handler: {
110
- onConnect() {},
111
- onBodySent() {},
112
- onHeaders(status, _rawHeaders, resume, _statusMessage) {},
113
- onData(chunk) {},
114
- onComplete() {},
115
- onError(err) {},
116
- },
117
- });
118
- ```
@@ -1,145 +0,0 @@
1
- # Class: RoundRobinPool
2
-
3
- Extends: `undici.Dispatcher`
4
-
5
- A pool of [Client](/docs/docs/api/Client.md) instances connected to the same upstream target with round-robin client selection.
6
-
7
- Unlike [`Pool`](/docs/docs/api/Pool.md), which always selects the first available client, `RoundRobinPool` cycles through clients in a round-robin fashion. This ensures even distribution of requests across all connections, which is particularly useful when the upstream target is behind a load balancer that round-robins TCP connections across multiple backend servers (e.g., Kubernetes Services).
8
-
9
- Requests are not guaranteed to be dispatched in order of invocation.
10
-
11
- ## `new RoundRobinPool(url[, options])`
12
-
13
- Arguments:
14
-
15
- * **url** `URL | string` - It should only include the **protocol, hostname, and port**.
16
- * **options** `RoundRobinPoolOptions` (optional)
17
-
18
- ### Parameter: `RoundRobinPoolOptions`
19
-
20
- Extends: [`ClientOptions`](/docs/docs/api/Client.md#parameter-clientoptions)
21
-
22
- * **factory** `(origin: URL, opts: Object) => Dispatcher` - Default: `(origin, opts) => new Client(origin, opts)`
23
- * **connections** `number | null` (optional) - Default: `null` - The number of `Client` instances to create. When set to `null`, the `RoundRobinPool` instance will create an unlimited amount of `Client` instances.
24
- * **clientTtl** `number | null` (optional) - Default: `null` - The amount of time before a `Client` instance is removed from the `RoundRobinPool` and closed. When set to `null`, `Client` instances will not be removed or closed based on age.
25
-
26
- ## Use Case
27
-
28
- `RoundRobinPool` is designed for scenarios where:
29
-
30
- 1. You connect to a single origin (e.g., `http://my-service.namespace.svc`)
31
- 2. That origin is backed by a load balancer distributing TCP connections across multiple servers
32
- 3. You want requests evenly distributed across all backend servers
33
-
34
- **Example**: In Kubernetes, when using a Service DNS name with multiple Pod replicas, kube-proxy load balances TCP connections. `RoundRobinPool` ensures each connection (and thus each Pod) receives an equal share of requests.
35
-
36
- ### Important: Backend Distribution Considerations
37
-
38
- `RoundRobinPool` distributes **HTTP requests** evenly across **TCP connections**. Whether this translates to even backend server distribution depends on the load balancer's behavior:
39
-
40
- **✓ Works when the load balancer**:
41
- - Assigns different backends to different TCP connections from the same client
42
- - Uses algorithms like: round-robin, random, least-connections (without client affinity)
43
- - Example: Default Kubernetes Services without `sessionAffinity`
44
-
45
- **✗ Does NOT work when**:
46
- - Load balancer has client/source IP affinity (all connections from one IP → same backend)
47
- - Load balancer uses source-IP-hash or sticky sessions
48
-
49
- **How it works:**
50
- 1. `RoundRobinPool` creates N TCP connections to the load balancer endpoint
51
- 2. Load balancer assigns each TCP connection to a backend (per its algorithm)
52
- 3. `RoundRobinPool` cycles HTTP requests across those N connections
53
- 4. Result: Requests distributed proportionally to how the LB distributed the connections
54
-
55
- If the load balancer assigns all connections to the same backend (e.g., due to session affinity), `RoundRobinPool` cannot overcome this. In such cases, consider using [`BalancedPool`](/docs/docs/api/BalancedPool.md) with direct backend addresses (e.g., individual pod IPs) instead of a load-balanced endpoint.
56
-
57
- ## Instance Properties
58
-
59
- ### `RoundRobinPool.closed`
60
-
61
- Implements [Client.closed](/docs/docs/api/Client.md#clientclosed)
62
-
63
- ### `RoundRobinPool.destroyed`
64
-
65
- Implements [Client.destroyed](/docs/docs/api/Client.md#clientdestroyed)
66
-
67
- ### `RoundRobinPool.stats`
68
-
69
- Returns [`PoolStats`](PoolStats.md) instance for this pool.
70
-
71
- ## Instance Methods
72
-
73
- ### `RoundRobinPool.close([callback])`
74
-
75
- Implements [`Dispatcher.close([callback])`](/docs/docs/api/Dispatcher.md#dispatcherclosecallback-promise).
76
-
77
- ### `RoundRobinPool.destroy([error, callback])`
78
-
79
- Implements [`Dispatcher.destroy([error, callback])`](/docs/docs/api/Dispatcher.md#dispatcherdestroyerror-callback-promise).
80
-
81
- ### `RoundRobinPool.connect(options[, callback])`
82
-
83
- See [`Dispatcher.connect(options[, callback])`](/docs/docs/api/Dispatcher.md#dispatcherconnectoptions-callback).
84
-
85
- ### `RoundRobinPool.dispatch(options, handler)`
86
-
87
- Implements [`Dispatcher.dispatch(options, handler)`](/docs/docs/api/Dispatcher.md#dispatcherdispatchoptions-handler).
88
-
89
- ### `RoundRobinPool.pipeline(options, handler)`
90
-
91
- See [`Dispatcher.pipeline(options, handler)`](/docs/docs/api/Dispatcher.md#dispatcherpipelineoptions-handler).
92
-
93
- ### `RoundRobinPool.request(options[, callback])`
94
-
95
- See [`Dispatcher.request(options [, callback])`](/docs/docs/api/Dispatcher.md#dispatcherrequestoptions-callback).
96
-
97
- ### `RoundRobinPool.stream(options, factory[, callback])`
98
-
99
- See [`Dispatcher.stream(options, factory[, callback])`](/docs/docs/api/Dispatcher.md#dispatcherstreamoptions-factory-callback).
100
-
101
- ### `RoundRobinPool.upgrade(options[, callback])`
102
-
103
- See [`Dispatcher.upgrade(options[, callback])`](/docs/docs/api/Dispatcher.md#dispatcherupgradeoptions-callback).
104
-
105
- ## Instance Events
106
-
107
- ### Event: `'connect'`
108
-
109
- See [Dispatcher Event: `'connect'`](/docs/docs/api/Dispatcher.md#event-connect).
110
-
111
- ### Event: `'disconnect'`
112
-
113
- See [Dispatcher Event: `'disconnect'`](/docs/docs/api/Dispatcher.md#event-disconnect).
114
-
115
- ### Event: `'drain'`
116
-
117
- See [Dispatcher Event: `'drain'`](/docs/docs/api/Dispatcher.md#event-drain).
118
-
119
- ## Example
120
-
121
- ```javascript
122
- import { RoundRobinPool } from 'undici'
123
-
124
- const pool = new RoundRobinPool('http://my-service.default.svc.cluster.local', {
125
- connections: 10
126
- })
127
-
128
- // Requests will be distributed evenly across all 10 connections
129
- for (let i = 0; i < 100; i++) {
130
- const { body } = await pool.request({
131
- path: '/api/data',
132
- method: 'GET'
133
- })
134
- console.log(await body.json())
135
- }
136
-
137
- await pool.close()
138
- ```
139
-
140
- ## See Also
141
-
142
- - [Pool](/docs/docs/api/Pool.md) - Connection pool without round-robin
143
- - [BalancedPool](/docs/docs/api/BalancedPool.md) - Load balancing across multiple origins
144
- - [Issue #3648](https://github.com/nodejs/undici/issues/3648) - Original issue describing uneven distribution
145
-