css-variable-lsp 1.0.0 → 1.0.1

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 (450) hide show
  1. package/README.md +5 -9
  2. package/package.json +2 -2
  3. package/server/out/cascadeAndInline.test.js +67 -0
  4. package/server/out/cascadeAndInline.test.js.map +1 -0
  5. package/server/out/cssVariableManager.js +390 -0
  6. package/server/out/cssVariableManager.js.map +1 -0
  7. package/server/out/domTree.js +115 -0
  8. package/server/out/domTree.js.map +1 -0
  9. package/server/out/domTree.test.js +77 -0
  10. package/server/out/domTree.test.js.map +1 -0
  11. package/server/out/fileLifecycle.test.js +163 -0
  12. package/server/out/fileLifecycle.test.js.map +1 -0
  13. package/server/out/fileTypesAndUpdates.test.js +78 -0
  14. package/server/out/fileTypesAndUpdates.test.js.map +1 -0
  15. package/server/out/htmlComments.test.js +180 -0
  16. package/server/out/htmlComments.test.js.map +1 -0
  17. package/server/out/server.js +457 -0
  18. package/server/out/server.js.map +1 -0
  19. package/server/out/specificity.js +138 -0
  20. package/server/out/specificity.js.map +1 -0
  21. package/server/out/specificity.test.js +66 -0
  22. package/server/out/specificity.test.js.map +1 -0
  23. package/server/out/test.js +112 -0
  24. package/server/out/test.js.map +1 -0
  25. package/server/tsconfig.tsbuildinfo +1 -0
  26. package/client/node_modules/.package-lock.json +0 -110
  27. package/client/node_modules/@types/node/LICENSE +0 -21
  28. package/client/node_modules/@types/node/README.md +0 -15
  29. package/client/node_modules/@types/node/assert/strict.d.ts +0 -8
  30. package/client/node_modules/@types/node/assert.d.ts +0 -1005
  31. package/client/node_modules/@types/node/async_hooks.d.ts +0 -586
  32. package/client/node_modules/@types/node/buffer.buffer.d.ts +0 -457
  33. package/client/node_modules/@types/node/buffer.d.ts +0 -1901
  34. package/client/node_modules/@types/node/child_process.d.ts +0 -1453
  35. package/client/node_modules/@types/node/cluster.d.ts +0 -578
  36. package/client/node_modules/@types/node/compatibility/disposable.d.ts +0 -14
  37. package/client/node_modules/@types/node/compatibility/index.d.ts +0 -9
  38. package/client/node_modules/@types/node/compatibility/indexable.d.ts +0 -20
  39. package/client/node_modules/@types/node/compatibility/iterators.d.ts +0 -20
  40. package/client/node_modules/@types/node/console.d.ts +0 -452
  41. package/client/node_modules/@types/node/constants.d.ts +0 -21
  42. package/client/node_modules/@types/node/crypto.d.ts +0 -4504
  43. package/client/node_modules/@types/node/dgram.d.ts +0 -596
  44. package/client/node_modules/@types/node/diagnostics_channel.d.ts +0 -551
  45. package/client/node_modules/@types/node/dns/promises.d.ts +0 -477
  46. package/client/node_modules/@types/node/dns.d.ts +0 -860
  47. package/client/node_modules/@types/node/domain.d.ts +0 -170
  48. package/client/node_modules/@types/node/events.d.ts +0 -863
  49. package/client/node_modules/@types/node/fs/promises.d.ts +0 -1208
  50. package/client/node_modules/@types/node/fs.d.ts +0 -4332
  51. package/client/node_modules/@types/node/globals.d.ts +0 -170
  52. package/client/node_modules/@types/node/globals.typedarray.d.ts +0 -21
  53. package/client/node_modules/@types/node/http.d.ts +0 -1919
  54. package/client/node_modules/@types/node/http2.d.ts +0 -2580
  55. package/client/node_modules/@types/node/https.d.ts +0 -549
  56. package/client/node_modules/@types/node/index.d.ts +0 -92
  57. package/client/node_modules/@types/node/inspector.generated.d.ts +0 -2775
  58. package/client/node_modules/@types/node/module.d.ts +0 -503
  59. package/client/node_modules/@types/node/net.d.ts +0 -924
  60. package/client/node_modules/@types/node/os.d.ts +0 -480
  61. package/client/node_modules/@types/node/package.json +0 -145
  62. package/client/node_modules/@types/node/path.d.ts +0 -191
  63. package/client/node_modules/@types/node/perf_hooks.d.ts +0 -860
  64. package/client/node_modules/@types/node/process.d.ts +0 -1632
  65. package/client/node_modules/@types/node/punycode.d.ts +0 -117
  66. package/client/node_modules/@types/node/querystring.d.ts +0 -140
  67. package/client/node_modules/@types/node/readline/promises.d.ts +0 -154
  68. package/client/node_modules/@types/node/readline.d.ts +0 -715
  69. package/client/node_modules/@types/node/repl.d.ts +0 -430
  70. package/client/node_modules/@types/node/stream/consumers.d.ts +0 -38
  71. package/client/node_modules/@types/node/stream/promises.d.ts +0 -90
  72. package/client/node_modules/@types/node/stream/web.d.ts +0 -527
  73. package/client/node_modules/@types/node/stream.d.ts +0 -1680
  74. package/client/node_modules/@types/node/string_decoder.d.ts +0 -67
  75. package/client/node_modules/@types/node/test.d.ts +0 -1208
  76. package/client/node_modules/@types/node/timers/promises.d.ts +0 -108
  77. package/client/node_modules/@types/node/timers.d.ts +0 -286
  78. package/client/node_modules/@types/node/tls.d.ts +0 -1204
  79. package/client/node_modules/@types/node/trace_events.d.ts +0 -171
  80. package/client/node_modules/@types/node/ts5.6/buffer.buffer.d.ts +0 -455
  81. package/client/node_modules/@types/node/ts5.6/globals.typedarray.d.ts +0 -19
  82. package/client/node_modules/@types/node/ts5.6/index.d.ts +0 -92
  83. package/client/node_modules/@types/node/tty.d.ts +0 -206
  84. package/client/node_modules/@types/node/url.d.ts +0 -957
  85. package/client/node_modules/@types/node/util.d.ts +0 -2083
  86. package/client/node_modules/@types/node/v8.d.ts +0 -753
  87. package/client/node_modules/@types/node/vm.d.ts +0 -704
  88. package/client/node_modules/@types/node/wasi.d.ts +0 -160
  89. package/client/node_modules/@types/node/web-globals/abortcontroller.d.ts +0 -34
  90. package/client/node_modules/@types/node/web-globals/domexception.d.ts +0 -68
  91. package/client/node_modules/@types/node/web-globals/events.d.ts +0 -81
  92. package/client/node_modules/@types/node/web-globals/fetch.d.ts +0 -38
  93. package/client/node_modules/@types/node/worker_threads.d.ts +0 -698
  94. package/client/node_modules/@types/node/zlib.d.ts +0 -517
  95. package/client/node_modules/@types/vscode/LICENSE +0 -21
  96. package/client/node_modules/@types/vscode/README.md +0 -15
  97. package/client/node_modules/@types/vscode/index.d.ts +0 -21145
  98. package/client/node_modules/@types/vscode/package.json +0 -26
  99. package/client/node_modules/balanced-match/.github/FUNDING.yml +0 -2
  100. package/client/node_modules/balanced-match/LICENSE.md +0 -21
  101. package/client/node_modules/balanced-match/README.md +0 -97
  102. package/client/node_modules/balanced-match/index.js +0 -62
  103. package/client/node_modules/balanced-match/package.json +0 -48
  104. package/client/node_modules/brace-expansion/.github/FUNDING.yml +0 -2
  105. package/client/node_modules/brace-expansion/LICENSE +0 -21
  106. package/client/node_modules/brace-expansion/README.md +0 -135
  107. package/client/node_modules/brace-expansion/index.js +0 -203
  108. package/client/node_modules/brace-expansion/package.json +0 -49
  109. package/client/node_modules/minimatch/LICENSE +0 -15
  110. package/client/node_modules/minimatch/README.md +0 -259
  111. package/client/node_modules/minimatch/lib/path.js +0 -4
  112. package/client/node_modules/minimatch/minimatch.js +0 -944
  113. package/client/node_modules/minimatch/package.json +0 -35
  114. package/client/node_modules/semver/LICENSE +0 -15
  115. package/client/node_modules/semver/README.md +0 -664
  116. package/client/node_modules/semver/bin/semver.js +0 -191
  117. package/client/node_modules/semver/classes/comparator.js +0 -143
  118. package/client/node_modules/semver/classes/index.js +0 -7
  119. package/client/node_modules/semver/classes/range.js +0 -557
  120. package/client/node_modules/semver/classes/semver.js +0 -333
  121. package/client/node_modules/semver/functions/clean.js +0 -8
  122. package/client/node_modules/semver/functions/cmp.js +0 -54
  123. package/client/node_modules/semver/functions/coerce.js +0 -62
  124. package/client/node_modules/semver/functions/compare-build.js +0 -9
  125. package/client/node_modules/semver/functions/compare-loose.js +0 -5
  126. package/client/node_modules/semver/functions/compare.js +0 -7
  127. package/client/node_modules/semver/functions/diff.js +0 -60
  128. package/client/node_modules/semver/functions/eq.js +0 -5
  129. package/client/node_modules/semver/functions/gt.js +0 -5
  130. package/client/node_modules/semver/functions/gte.js +0 -5
  131. package/client/node_modules/semver/functions/inc.js +0 -21
  132. package/client/node_modules/semver/functions/lt.js +0 -5
  133. package/client/node_modules/semver/functions/lte.js +0 -5
  134. package/client/node_modules/semver/functions/major.js +0 -5
  135. package/client/node_modules/semver/functions/minor.js +0 -5
  136. package/client/node_modules/semver/functions/neq.js +0 -5
  137. package/client/node_modules/semver/functions/parse.js +0 -18
  138. package/client/node_modules/semver/functions/patch.js +0 -5
  139. package/client/node_modules/semver/functions/prerelease.js +0 -8
  140. package/client/node_modules/semver/functions/rcompare.js +0 -5
  141. package/client/node_modules/semver/functions/rsort.js +0 -5
  142. package/client/node_modules/semver/functions/satisfies.js +0 -12
  143. package/client/node_modules/semver/functions/sort.js +0 -5
  144. package/client/node_modules/semver/functions/valid.js +0 -8
  145. package/client/node_modules/semver/index.js +0 -91
  146. package/client/node_modules/semver/internal/constants.js +0 -37
  147. package/client/node_modules/semver/internal/debug.js +0 -11
  148. package/client/node_modules/semver/internal/identifiers.js +0 -29
  149. package/client/node_modules/semver/internal/lrucache.js +0 -42
  150. package/client/node_modules/semver/internal/parse-options.js +0 -17
  151. package/client/node_modules/semver/internal/re.js +0 -223
  152. package/client/node_modules/semver/package.json +0 -78
  153. package/client/node_modules/semver/preload.js +0 -4
  154. package/client/node_modules/semver/range.bnf +0 -16
  155. package/client/node_modules/semver/ranges/gtr.js +0 -6
  156. package/client/node_modules/semver/ranges/intersects.js +0 -9
  157. package/client/node_modules/semver/ranges/ltr.js +0 -6
  158. package/client/node_modules/semver/ranges/max-satisfying.js +0 -27
  159. package/client/node_modules/semver/ranges/min-satisfying.js +0 -26
  160. package/client/node_modules/semver/ranges/min-version.js +0 -63
  161. package/client/node_modules/semver/ranges/outside.js +0 -82
  162. package/client/node_modules/semver/ranges/simplify.js +0 -49
  163. package/client/node_modules/semver/ranges/subset.js +0 -249
  164. package/client/node_modules/semver/ranges/to-comparators.js +0 -10
  165. package/client/node_modules/semver/ranges/valid.js +0 -13
  166. package/client/node_modules/undici-types/README.md +0 -6
  167. package/client/node_modules/undici-types/agent.d.ts +0 -31
  168. package/client/node_modules/undici-types/api.d.ts +0 -43
  169. package/client/node_modules/undici-types/balanced-pool.d.ts +0 -18
  170. package/client/node_modules/undici-types/cache.d.ts +0 -36
  171. package/client/node_modules/undici-types/client.d.ts +0 -97
  172. package/client/node_modules/undici-types/connector.d.ts +0 -34
  173. package/client/node_modules/undici-types/content-type.d.ts +0 -21
  174. package/client/node_modules/undici-types/cookies.d.ts +0 -28
  175. package/client/node_modules/undici-types/diagnostics-channel.d.ts +0 -67
  176. package/client/node_modules/undici-types/dispatcher.d.ts +0 -241
  177. package/client/node_modules/undici-types/errors.d.ts +0 -128
  178. package/client/node_modules/undici-types/fetch.d.ts +0 -209
  179. package/client/node_modules/undici-types/file.d.ts +0 -39
  180. package/client/node_modules/undici-types/filereader.d.ts +0 -54
  181. package/client/node_modules/undici-types/formdata.d.ts +0 -108
  182. package/client/node_modules/undici-types/global-dispatcher.d.ts +0 -9
  183. package/client/node_modules/undici-types/global-origin.d.ts +0 -7
  184. package/client/node_modules/undici-types/handlers.d.ts +0 -9
  185. package/client/node_modules/undici-types/header.d.ts +0 -4
  186. package/client/node_modules/undici-types/index.d.ts +0 -63
  187. package/client/node_modules/undici-types/interceptors.d.ts +0 -5
  188. package/client/node_modules/undici-types/mock-agent.d.ts +0 -50
  189. package/client/node_modules/undici-types/mock-client.d.ts +0 -25
  190. package/client/node_modules/undici-types/mock-errors.d.ts +0 -12
  191. package/client/node_modules/undici-types/mock-interceptor.d.ts +0 -93
  192. package/client/node_modules/undici-types/mock-pool.d.ts +0 -25
  193. package/client/node_modules/undici-types/package.json +0 -55
  194. package/client/node_modules/undici-types/patch.d.ts +0 -71
  195. package/client/node_modules/undici-types/pool-stats.d.ts +0 -19
  196. package/client/node_modules/undici-types/pool.d.ts +0 -28
  197. package/client/node_modules/undici-types/proxy-agent.d.ts +0 -30
  198. package/client/node_modules/undici-types/readable.d.ts +0 -61
  199. package/client/node_modules/undici-types/webidl.d.ts +0 -220
  200. package/client/node_modules/undici-types/websocket.d.ts +0 -131
  201. package/client/node_modules/vscode-jsonrpc/License.txt +0 -11
  202. package/client/node_modules/vscode-jsonrpc/README.md +0 -69
  203. package/client/node_modules/vscode-jsonrpc/browser.d.ts +0 -6
  204. package/client/node_modules/vscode-jsonrpc/browser.js +0 -7
  205. package/client/node_modules/vscode-jsonrpc/lib/browser/main.d.ts +0 -17
  206. package/client/node_modules/vscode-jsonrpc/lib/browser/main.js +0 -76
  207. package/client/node_modules/vscode-jsonrpc/lib/browser/ril.d.ts +0 -12
  208. package/client/node_modules/vscode-jsonrpc/lib/browser/ril.js +0 -156
  209. package/client/node_modules/vscode-jsonrpc/lib/common/api.d.ts +0 -14
  210. package/client/node_modules/vscode-jsonrpc/lib/common/api.js +0 -81
  211. package/client/node_modules/vscode-jsonrpc/lib/common/cancellation.d.ts +0 -32
  212. package/client/node_modules/vscode-jsonrpc/lib/common/cancellation.js +0 -96
  213. package/client/node_modules/vscode-jsonrpc/lib/common/connection.d.ts +0 -358
  214. package/client/node_modules/vscode-jsonrpc/lib/common/connection.js +0 -1212
  215. package/client/node_modules/vscode-jsonrpc/lib/common/disposable.d.ts +0 -9
  216. package/client/node_modules/vscode-jsonrpc/lib/common/disposable.js +0 -16
  217. package/client/node_modules/vscode-jsonrpc/lib/common/encoding.d.ts +0 -52
  218. package/client/node_modules/vscode-jsonrpc/lib/common/encoding.js +0 -70
  219. package/client/node_modules/vscode-jsonrpc/lib/common/events.d.ts +0 -39
  220. package/client/node_modules/vscode-jsonrpc/lib/common/events.js +0 -128
  221. package/client/node_modules/vscode-jsonrpc/lib/common/is.d.ts +0 -7
  222. package/client/node_modules/vscode-jsonrpc/lib/common/is.js +0 -35
  223. package/client/node_modules/vscode-jsonrpc/lib/common/linkedMap.d.ts +0 -53
  224. package/client/node_modules/vscode-jsonrpc/lib/common/linkedMap.js +0 -398
  225. package/client/node_modules/vscode-jsonrpc/lib/common/messageBuffer.d.ts +0 -18
  226. package/client/node_modules/vscode-jsonrpc/lib/common/messageBuffer.js +0 -152
  227. package/client/node_modules/vscode-jsonrpc/lib/common/messageReader.d.ts +0 -77
  228. package/client/node_modules/vscode-jsonrpc/lib/common/messageReader.js +0 -197
  229. package/client/node_modules/vscode-jsonrpc/lib/common/messageWriter.d.ts +0 -60
  230. package/client/node_modules/vscode-jsonrpc/lib/common/messageWriter.js +0 -115
  231. package/client/node_modules/vscode-jsonrpc/lib/common/messages.d.ts +0 -369
  232. package/client/node_modules/vscode-jsonrpc/lib/common/messages.js +0 -306
  233. package/client/node_modules/vscode-jsonrpc/lib/common/ral.d.ts +0 -74
  234. package/client/node_modules/vscode-jsonrpc/lib/common/ral.js +0 -23
  235. package/client/node_modules/vscode-jsonrpc/lib/common/semaphore.d.ts +0 -10
  236. package/client/node_modules/vscode-jsonrpc/lib/common/semaphore.js +0 -68
  237. package/client/node_modules/vscode-jsonrpc/lib/common/sharedArrayCancellation.d.ts +0 -15
  238. package/client/node_modules/vscode-jsonrpc/lib/common/sharedArrayCancellation.js +0 -76
  239. package/client/node_modules/vscode-jsonrpc/lib/node/main.d.ts +0 -63
  240. package/client/node_modules/vscode-jsonrpc/lib/node/main.js +0 -257
  241. package/client/node_modules/vscode-jsonrpc/lib/node/ril.d.ts +0 -13
  242. package/client/node_modules/vscode-jsonrpc/lib/node/ril.js +0 -161
  243. package/client/node_modules/vscode-jsonrpc/node.cmd +0 -5
  244. package/client/node_modules/vscode-jsonrpc/node.d.ts +0 -6
  245. package/client/node_modules/vscode-jsonrpc/node.js +0 -7
  246. package/client/node_modules/vscode-jsonrpc/package.json +0 -45
  247. package/client/node_modules/vscode-jsonrpc/thirdpartynotices.txt +0 -16
  248. package/client/node_modules/vscode-jsonrpc/typings/thenable.d.ts +0 -5
  249. package/client/node_modules/vscode-languageclient/License.txt +0 -11
  250. package/client/node_modules/vscode-languageclient/README.md +0 -17
  251. package/client/node_modules/vscode-languageclient/browser.d.ts +0 -6
  252. package/client/node_modules/vscode-languageclient/browser.js +0 -7
  253. package/client/node_modules/vscode-languageclient/lib/browser/main.d.ts +0 -8
  254. package/client/node_modules/vscode-languageclient/lib/browser/main.js +0 -37
  255. package/client/node_modules/vscode-languageclient/lib/common/api.d.ts +0 -36
  256. package/client/node_modules/vscode-languageclient/lib/common/api.js +0 -27
  257. package/client/node_modules/vscode-languageclient/lib/common/callHierarchy.d.ts +0 -37
  258. package/client/node_modules/vscode-languageclient/lib/common/callHierarchy.js +0 -97
  259. package/client/node_modules/vscode-languageclient/lib/common/client.d.ts +0 -476
  260. package/client/node_modules/vscode-languageclient/lib/common/client.js +0 -1600
  261. package/client/node_modules/vscode-languageclient/lib/common/codeAction.d.ts +0 -19
  262. package/client/node_modules/vscode-languageclient/lib/common/codeAction.js +0 -99
  263. package/client/node_modules/vscode-languageclient/lib/common/codeConverter.d.ts +0 -78
  264. package/client/node_modules/vscode-languageclient/lib/common/codeConverter.js +0 -876
  265. package/client/node_modules/vscode-languageclient/lib/common/codeLens.d.ts +0 -23
  266. package/client/node_modules/vscode-languageclient/lib/common/codeLens.js +0 -78
  267. package/client/node_modules/vscode-languageclient/lib/common/colorProvider.d.ts +0 -25
  268. package/client/node_modules/vscode-languageclient/lib/common/colorProvider.js +0 -74
  269. package/client/node_modules/vscode-languageclient/lib/common/completion.d.ts +0 -20
  270. package/client/node_modules/vscode-languageclient/lib/common/completion.js +0 -126
  271. package/client/node_modules/vscode-languageclient/lib/common/configuration.d.ts +0 -69
  272. package/client/node_modules/vscode-languageclient/lib/common/configuration.js +0 -209
  273. package/client/node_modules/vscode-languageclient/lib/common/declaration.d.ts +0 -16
  274. package/client/node_modules/vscode-languageclient/lib/common/declaration.js +0 -54
  275. package/client/node_modules/vscode-languageclient/lib/common/definition.d.ts +0 -16
  276. package/client/node_modules/vscode-languageclient/lib/common/definition.js +0 -55
  277. package/client/node_modules/vscode-languageclient/lib/common/diagnostic.d.ts +0 -122
  278. package/client/node_modules/vscode-languageclient/lib/common/diagnostic.js +0 -814
  279. package/client/node_modules/vscode-languageclient/lib/common/documentHighlight.d.ts +0 -15
  280. package/client/node_modules/vscode-languageclient/lib/common/documentHighlight.js +0 -50
  281. package/client/node_modules/vscode-languageclient/lib/common/documentLink.d.ts +0 -19
  282. package/client/node_modules/vscode-languageclient/lib/common/documentLink.js +0 -71
  283. package/client/node_modules/vscode-languageclient/lib/common/documentSymbol.d.ts +0 -17
  284. package/client/node_modules/vscode-languageclient/lib/common/documentSymbol.js +0 -104
  285. package/client/node_modules/vscode-languageclient/lib/common/executeCommand.d.ts +0 -21
  286. package/client/node_modules/vscode-languageclient/lib/common/executeCommand.js +0 -72
  287. package/client/node_modules/vscode-languageclient/lib/common/features.d.ts +0 -418
  288. package/client/node_modules/vscode-languageclient/lib/common/features.js +0 -291
  289. package/client/node_modules/vscode-languageclient/lib/common/fileOperations.d.ts +0 -116
  290. package/client/node_modules/vscode-languageclient/lib/common/fileOperations.js +0 -333
  291. package/client/node_modules/vscode-languageclient/lib/common/fileSystemWatcher.d.ts +0 -18
  292. package/client/node_modules/vscode-languageclient/lib/common/fileSystemWatcher.js +0 -95
  293. package/client/node_modules/vscode-languageclient/lib/common/foldingRange.d.ts +0 -19
  294. package/client/node_modules/vscode-languageclient/lib/common/foldingRange.js +0 -65
  295. package/client/node_modules/vscode-languageclient/lib/common/formatting.d.ts +0 -39
  296. package/client/node_modules/vscode-languageclient/lib/common/formatting.js +0 -182
  297. package/client/node_modules/vscode-languageclient/lib/common/hover.d.ts +0 -16
  298. package/client/node_modules/vscode-languageclient/lib/common/hover.js +0 -58
  299. package/client/node_modules/vscode-languageclient/lib/common/implementation.d.ts +0 -16
  300. package/client/node_modules/vscode-languageclient/lib/common/implementation.js +0 -54
  301. package/client/node_modules/vscode-languageclient/lib/common/inlayHint.d.ts +0 -20
  302. package/client/node_modules/vscode-languageclient/lib/common/inlayHint.js +0 -92
  303. package/client/node_modules/vscode-languageclient/lib/common/inlineCompletion.d.ts +0 -18
  304. package/client/node_modules/vscode-languageclient/lib/common/inlineCompletion.js +0 -54
  305. package/client/node_modules/vscode-languageclient/lib/common/inlineValue.d.ts +0 -18
  306. package/client/node_modules/vscode-languageclient/lib/common/inlineValue.js +0 -65
  307. package/client/node_modules/vscode-languageclient/lib/common/linkedEditingRange.d.ts +0 -21
  308. package/client/node_modules/vscode-languageclient/lib/common/linkedEditingRange.js +0 -53
  309. package/client/node_modules/vscode-languageclient/lib/common/notebook.d.ts +0 -96
  310. package/client/node_modules/vscode-languageclient/lib/common/notebook.js +0 -851
  311. package/client/node_modules/vscode-languageclient/lib/common/progress.d.ts +0 -11
  312. package/client/node_modules/vscode-languageclient/lib/common/progress.js +0 -44
  313. package/client/node_modules/vscode-languageclient/lib/common/progressPart.d.ts +0 -24
  314. package/client/node_modules/vscode-languageclient/lib/common/progressPart.js +0 -96
  315. package/client/node_modules/vscode-languageclient/lib/common/protocolCallHierarchyItem.d.ts +0 -6
  316. package/client/node_modules/vscode-languageclient/lib/common/protocolCallHierarchyItem.js +0 -16
  317. package/client/node_modules/vscode-languageclient/lib/common/protocolCodeAction.d.ts +0 -6
  318. package/client/node_modules/vscode-languageclient/lib/common/protocolCodeAction.js +0 -14
  319. package/client/node_modules/vscode-languageclient/lib/common/protocolCodeLens.d.ts +0 -5
  320. package/client/node_modules/vscode-languageclient/lib/common/protocolCodeLens.js +0 -13
  321. package/client/node_modules/vscode-languageclient/lib/common/protocolCompletionItem.d.ts +0 -11
  322. package/client/node_modules/vscode-languageclient/lib/common/protocolCompletionItem.js +0 -13
  323. package/client/node_modules/vscode-languageclient/lib/common/protocolConverter.d.ts +0 -167
  324. package/client/node_modules/vscode-languageclient/lib/common/protocolConverter.js +0 -1134
  325. package/client/node_modules/vscode-languageclient/lib/common/protocolDiagnostic.d.ts +0 -18
  326. package/client/node_modules/vscode-languageclient/lib/common/protocolDiagnostic.js +0 -25
  327. package/client/node_modules/vscode-languageclient/lib/common/protocolDocumentLink.d.ts +0 -5
  328. package/client/node_modules/vscode-languageclient/lib/common/protocolDocumentLink.js +0 -13
  329. package/client/node_modules/vscode-languageclient/lib/common/protocolInlayHint.d.ts +0 -5
  330. package/client/node_modules/vscode-languageclient/lib/common/protocolInlayHint.js +0 -13
  331. package/client/node_modules/vscode-languageclient/lib/common/protocolTypeHierarchyItem.d.ts +0 -6
  332. package/client/node_modules/vscode-languageclient/lib/common/protocolTypeHierarchyItem.js +0 -16
  333. package/client/node_modules/vscode-languageclient/lib/common/protocolWorkspaceSymbol.d.ts +0 -7
  334. package/client/node_modules/vscode-languageclient/lib/common/protocolWorkspaceSymbol.js +0 -18
  335. package/client/node_modules/vscode-languageclient/lib/common/reference.d.ts +0 -20
  336. package/client/node_modules/vscode-languageclient/lib/common/reference.js +0 -53
  337. package/client/node_modules/vscode-languageclient/lib/common/rename.d.ts +0 -27
  338. package/client/node_modules/vscode-languageclient/lib/common/rename.js +0 -113
  339. package/client/node_modules/vscode-languageclient/lib/common/selectionRange.d.ts +0 -16
  340. package/client/node_modules/vscode-languageclient/lib/common/selectionRange.js +0 -57
  341. package/client/node_modules/vscode-languageclient/lib/common/semanticTokens.d.ts +0 -33
  342. package/client/node_modules/vscode-languageclient/lib/common/semanticTokens.js +0 -179
  343. package/client/node_modules/vscode-languageclient/lib/common/signatureHelp.d.ts +0 -16
  344. package/client/node_modules/vscode-languageclient/lib/common/signatureHelp.js +0 -71
  345. package/client/node_modules/vscode-languageclient/lib/common/textSynchronization.d.ts +0 -101
  346. package/client/node_modules/vscode-languageclient/lib/common/textSynchronization.js +0 -402
  347. package/client/node_modules/vscode-languageclient/lib/common/typeDefinition.d.ts +0 -16
  348. package/client/node_modules/vscode-languageclient/lib/common/typeDefinition.js +0 -55
  349. package/client/node_modules/vscode-languageclient/lib/common/typeHierarchy.d.ts +0 -31
  350. package/client/node_modules/vscode-languageclient/lib/common/typeHierarchy.js +0 -96
  351. package/client/node_modules/vscode-languageclient/lib/common/utils/async.d.ts +0 -41
  352. package/client/node_modules/vscode-languageclient/lib/common/utils/async.js +0 -276
  353. package/client/node_modules/vscode-languageclient/lib/common/utils/is.d.ts +0 -12
  354. package/client/node_modules/vscode-languageclient/lib/common/utils/is.js +0 -57
  355. package/client/node_modules/vscode-languageclient/lib/common/utils/uuid.d.ts +0 -22
  356. package/client/node_modules/vscode-languageclient/lib/common/utils/uuid.js +0 -97
  357. package/client/node_modules/vscode-languageclient/lib/common/workspaceFolder.d.ts +0 -30
  358. package/client/node_modules/vscode-languageclient/lib/common/workspaceFolder.js +0 -148
  359. package/client/node_modules/vscode-languageclient/lib/common/workspaceSymbol.d.ts +0 -19
  360. package/client/node_modules/vscode-languageclient/lib/common/workspaceSymbol.js +0 -79
  361. package/client/node_modules/vscode-languageclient/lib/node/main.d.ts +0 -100
  362. package/client/node_modules/vscode-languageclient/lib/node/main.js +0 -570
  363. package/client/node_modules/vscode-languageclient/lib/node/processes.d.ts +0 -6
  364. package/client/node_modules/vscode-languageclient/lib/node/processes.js +0 -47
  365. package/client/node_modules/vscode-languageclient/lib/node/terminateProcess.sh +0 -16
  366. package/client/node_modules/vscode-languageclient/node.cmd +0 -5
  367. package/client/node_modules/vscode-languageclient/node.d.ts +0 -6
  368. package/client/node_modules/vscode-languageclient/node.js +0 -7
  369. package/client/node_modules/vscode-languageclient/package.json +0 -50
  370. package/client/node_modules/vscode-languageserver-protocol/License.txt +0 -11
  371. package/client/node_modules/vscode-languageserver-protocol/README.md +0 -16
  372. package/client/node_modules/vscode-languageserver-protocol/browser.d.ts +0 -6
  373. package/client/node_modules/vscode-languageserver-protocol/browser.js +0 -7
  374. package/client/node_modules/vscode-languageserver-protocol/lib/browser/main.d.ts +0 -4
  375. package/client/node_modules/vscode-languageserver-protocol/lib/browser/main.js +0 -28
  376. package/client/node_modules/vscode-languageserver-protocol/lib/common/api.d.ts +0 -58
  377. package/client/node_modules/vscode-languageserver-protocol/lib/common/api.js +0 -77
  378. package/client/node_modules/vscode-languageserver-protocol/lib/common/connection.d.ts +0 -187
  379. package/client/node_modules/vscode-languageserver-protocol/lib/common/connection.js +0 -15
  380. package/client/node_modules/vscode-languageserver-protocol/lib/common/messages.d.ts +0 -51
  381. package/client/node_modules/vscode-languageserver-protocol/lib/common/messages.js +0 -44
  382. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.$.d.ts +0 -1
  383. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.$.js +0 -43
  384. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.callHierarchy.d.ts +0 -86
  385. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.callHierarchy.js +0 -42
  386. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.colorProvider.d.ts +0 -66
  387. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.colorProvider.js +0 -32
  388. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.configuration.d.ts +0 -35
  389. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.configuration.js +0 -24
  390. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.d.ts +0 -3252
  391. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.declaration.d.ts +0 -37
  392. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.declaration.js +0 -22
  393. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.diagnostic.d.ts +0 -341
  394. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.diagnostic.js +0 -74
  395. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.fileOperations.d.ts +0 -306
  396. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.fileOperations.js +0 -101
  397. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.foldingRange.d.ts +0 -109
  398. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.foldingRange.js +0 -30
  399. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.implementation.d.ts +0 -38
  400. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.implementation.js +0 -21
  401. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.inlayHint.d.ts +0 -110
  402. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.inlayHint.js +0 -43
  403. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.inlineCompletion.d.ts +0 -57
  404. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.inlineCompletion.js +0 -22
  405. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.inlineValue.d.ts +0 -86
  406. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.inlineValue.js +0 -30
  407. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.js +0 -943
  408. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.linkedEditingRange.d.ts +0 -52
  409. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.linkedEditingRange.js +0 -19
  410. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.moniker.d.ts +0 -106
  411. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.moniker.js +0 -68
  412. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.notebook.d.ts +0 -400
  413. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.notebook.js +0 -214
  414. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.progress.d.ts +0 -107
  415. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.progress.js +0 -37
  416. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.selectionRange.d.ts +0 -41
  417. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.selectionRange.js +0 -20
  418. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.semanticTokens.d.ts +0 -223
  419. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.semanticTokens.js +0 -57
  420. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.showDocument.d.ts +0 -72
  421. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.showDocument.js +0 -22
  422. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.typeDefinition.d.ts +0 -38
  423. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.typeDefinition.js +0 -21
  424. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.typeHierarchy.d.ts +0 -83
  425. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.typeHierarchy.js +0 -42
  426. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.workspaceFolder.d.ts +0 -74
  427. package/client/node_modules/vscode-languageserver-protocol/lib/common/protocol.workspaceFolder.js +0 -27
  428. package/client/node_modules/vscode-languageserver-protocol/lib/common/utils/is.d.ts +0 -9
  429. package/client/node_modules/vscode-languageserver-protocol/lib/common/utils/is.js +0 -46
  430. package/client/node_modules/vscode-languageserver-protocol/lib/node/main.d.ts +0 -6
  431. package/client/node_modules/vscode-languageserver-protocol/lib/node/main.js +0 -28
  432. package/client/node_modules/vscode-languageserver-protocol/metaModel.schema.json +0 -783
  433. package/client/node_modules/vscode-languageserver-protocol/node.cmd +0 -5
  434. package/client/node_modules/vscode-languageserver-protocol/node.d.ts +0 -6
  435. package/client/node_modules/vscode-languageserver-protocol/node.js +0 -7
  436. package/client/node_modules/vscode-languageserver-protocol/package.json +0 -45
  437. package/client/node_modules/vscode-languageserver-protocol/thirdpartynotices.txt +0 -31
  438. package/client/node_modules/vscode-languageserver-types/License.txt +0 -11
  439. package/client/node_modules/vscode-languageserver-types/README.md +0 -17
  440. package/client/node_modules/vscode-languageserver-types/lib/esm/main.d.ts +0 -3139
  441. package/client/node_modules/vscode-languageserver-types/lib/esm/main.js +0 -2222
  442. package/client/node_modules/vscode-languageserver-types/lib/esm/package.json +0 -3
  443. package/client/node_modules/vscode-languageserver-types/lib/umd/main.d.ts +0 -3139
  444. package/client/node_modules/vscode-languageserver-types/lib/umd/main.js +0 -2272
  445. package/client/node_modules/vscode-languageserver-types/package.json +0 -38
  446. package/client/node_modules/vscode-languageserver-types/thirdpartynotices.txt +0 -16
  447. package/client/package-lock.json +0 -125
  448. package/client/package.json +0 -42
  449. package/client/src/extension.ts +0 -56
  450. package/client/tsconfig.json +0 -12
@@ -1,1919 +0,0 @@
1
- /**
2
- * To use the HTTP server and client one must import the `node:http` module.
3
- *
4
- * The HTTP interfaces in Node.js are designed to support many features
5
- * of the protocol which have been traditionally difficult to use.
6
- * In particular, large, possibly chunk-encoded, messages. The interface is
7
- * careful to never buffer entire requests or responses, so the
8
- * user is able to stream data.
9
- *
10
- * HTTP message headers are represented by an object like this:
11
- *
12
- * ```js
13
- * { 'content-length': '123',
14
- * 'content-type': 'text/plain',
15
- * 'connection': 'keep-alive',
16
- * 'host': 'example.com',
17
- * 'accept': '*' }
18
- * ```
19
- *
20
- * Keys are lowercased. Values are not modified.
21
- *
22
- * In order to support the full spectrum of possible HTTP applications, the Node.js
23
- * HTTP API is very low-level. It deals with stream handling and message
24
- * parsing only. It parses a message into headers and body but it does not
25
- * parse the actual headers or the body.
26
- *
27
- * See `message.headers` for details on how duplicate headers are handled.
28
- *
29
- * The raw headers as they were received are retained in the `rawHeaders`property, which is an array of `[key, value, key2, value2, ...]`. For
30
- * example, the previous message header object might have a `rawHeaders`list like the following:
31
- *
32
- * ```js
33
- * [ 'ConTent-Length', '123456',
34
- * 'content-LENGTH', '123',
35
- * 'content-type', 'text/plain',
36
- * 'CONNECTION', 'keep-alive',
37
- * 'Host', 'example.com',
38
- * 'accepT', '*' ]
39
- * ```
40
- * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/http.js)
41
- */
42
- declare module "http" {
43
- import * as stream from "node:stream";
44
- import { URL } from "node:url";
45
- import { EventEmitter } from "node:events";
46
- import { LookupOptions } from "node:dns";
47
- import { LookupFunction, Server as NetServer, Socket, TcpSocketConnectOpts } from "node:net";
48
- // incoming headers will never contain number
49
- interface IncomingHttpHeaders extends NodeJS.Dict<string | string[]> {
50
- accept?: string | undefined;
51
- "accept-encoding"?: string | undefined;
52
- "accept-language"?: string | undefined;
53
- "accept-patch"?: string | undefined;
54
- "accept-ranges"?: string | undefined;
55
- "access-control-allow-credentials"?: string | undefined;
56
- "access-control-allow-headers"?: string | undefined;
57
- "access-control-allow-methods"?: string | undefined;
58
- "access-control-allow-origin"?: string | undefined;
59
- "access-control-expose-headers"?: string | undefined;
60
- "access-control-max-age"?: string | undefined;
61
- "access-control-request-headers"?: string | undefined;
62
- "access-control-request-method"?: string | undefined;
63
- age?: string | undefined;
64
- allow?: string | undefined;
65
- "alt-svc"?: string | undefined;
66
- authorization?: string | undefined;
67
- "cache-control"?: string | undefined;
68
- connection?: string | undefined;
69
- "content-disposition"?: string | undefined;
70
- "content-encoding"?: string | undefined;
71
- "content-language"?: string | undefined;
72
- "content-length"?: string | undefined;
73
- "content-location"?: string | undefined;
74
- "content-range"?: string | undefined;
75
- "content-type"?: string | undefined;
76
- cookie?: string | undefined;
77
- date?: string | undefined;
78
- etag?: string | undefined;
79
- expect?: string | undefined;
80
- expires?: string | undefined;
81
- forwarded?: string | undefined;
82
- from?: string | undefined;
83
- host?: string | undefined;
84
- "if-match"?: string | undefined;
85
- "if-modified-since"?: string | undefined;
86
- "if-none-match"?: string | undefined;
87
- "if-unmodified-since"?: string | undefined;
88
- "last-modified"?: string | undefined;
89
- location?: string | undefined;
90
- origin?: string | undefined;
91
- pragma?: string | undefined;
92
- "proxy-authenticate"?: string | undefined;
93
- "proxy-authorization"?: string | undefined;
94
- "public-key-pins"?: string | undefined;
95
- range?: string | undefined;
96
- referer?: string | undefined;
97
- "retry-after"?: string | undefined;
98
- "sec-fetch-site"?: string | undefined;
99
- "sec-fetch-mode"?: string | undefined;
100
- "sec-fetch-user"?: string | undefined;
101
- "sec-fetch-dest"?: string | undefined;
102
- "sec-websocket-accept"?: string | undefined;
103
- "sec-websocket-extensions"?: string | undefined;
104
- "sec-websocket-key"?: string | undefined;
105
- "sec-websocket-protocol"?: string | undefined;
106
- "sec-websocket-version"?: string | undefined;
107
- "set-cookie"?: string[] | undefined;
108
- "strict-transport-security"?: string | undefined;
109
- tk?: string | undefined;
110
- trailer?: string | undefined;
111
- "transfer-encoding"?: string | undefined;
112
- upgrade?: string | undefined;
113
- "user-agent"?: string | undefined;
114
- vary?: string | undefined;
115
- via?: string | undefined;
116
- warning?: string | undefined;
117
- "www-authenticate"?: string | undefined;
118
- }
119
- // outgoing headers allows numbers (as they are converted internally to strings)
120
- type OutgoingHttpHeader = number | string | string[];
121
- interface OutgoingHttpHeaders extends NodeJS.Dict<OutgoingHttpHeader> {
122
- accept?: string | string[] | undefined;
123
- "accept-charset"?: string | string[] | undefined;
124
- "accept-encoding"?: string | string[] | undefined;
125
- "accept-language"?: string | string[] | undefined;
126
- "accept-ranges"?: string | undefined;
127
- "access-control-allow-credentials"?: string | undefined;
128
- "access-control-allow-headers"?: string | undefined;
129
- "access-control-allow-methods"?: string | undefined;
130
- "access-control-allow-origin"?: string | undefined;
131
- "access-control-expose-headers"?: string | undefined;
132
- "access-control-max-age"?: string | undefined;
133
- "access-control-request-headers"?: string | undefined;
134
- "access-control-request-method"?: string | undefined;
135
- age?: string | undefined;
136
- allow?: string | undefined;
137
- authorization?: string | undefined;
138
- "cache-control"?: string | undefined;
139
- "cdn-cache-control"?: string | undefined;
140
- connection?: string | string[] | undefined;
141
- "content-disposition"?: string | undefined;
142
- "content-encoding"?: string | undefined;
143
- "content-language"?: string | undefined;
144
- "content-length"?: string | number | undefined;
145
- "content-location"?: string | undefined;
146
- "content-range"?: string | undefined;
147
- "content-security-policy"?: string | undefined;
148
- "content-security-policy-report-only"?: string | undefined;
149
- cookie?: string | string[] | undefined;
150
- dav?: string | string[] | undefined;
151
- dnt?: string | undefined;
152
- date?: string | undefined;
153
- etag?: string | undefined;
154
- expect?: string | undefined;
155
- expires?: string | undefined;
156
- forwarded?: string | undefined;
157
- from?: string | undefined;
158
- host?: string | undefined;
159
- "if-match"?: string | undefined;
160
- "if-modified-since"?: string | undefined;
161
- "if-none-match"?: string | undefined;
162
- "if-range"?: string | undefined;
163
- "if-unmodified-since"?: string | undefined;
164
- "last-modified"?: string | undefined;
165
- link?: string | string[] | undefined;
166
- location?: string | undefined;
167
- "max-forwards"?: string | undefined;
168
- origin?: string | undefined;
169
- pragma?: string | string[] | undefined;
170
- "proxy-authenticate"?: string | string[] | undefined;
171
- "proxy-authorization"?: string | undefined;
172
- "public-key-pins"?: string | undefined;
173
- "public-key-pins-report-only"?: string | undefined;
174
- range?: string | undefined;
175
- referer?: string | undefined;
176
- "referrer-policy"?: string | undefined;
177
- refresh?: string | undefined;
178
- "retry-after"?: string | undefined;
179
- "sec-websocket-accept"?: string | undefined;
180
- "sec-websocket-extensions"?: string | string[] | undefined;
181
- "sec-websocket-key"?: string | undefined;
182
- "sec-websocket-protocol"?: string | string[] | undefined;
183
- "sec-websocket-version"?: string | undefined;
184
- server?: string | undefined;
185
- "set-cookie"?: string | string[] | undefined;
186
- "strict-transport-security"?: string | undefined;
187
- te?: string | undefined;
188
- trailer?: string | undefined;
189
- "transfer-encoding"?: string | undefined;
190
- "user-agent"?: string | undefined;
191
- upgrade?: string | undefined;
192
- "upgrade-insecure-requests"?: string | undefined;
193
- vary?: string | undefined;
194
- via?: string | string[] | undefined;
195
- warning?: string | undefined;
196
- "www-authenticate"?: string | string[] | undefined;
197
- "x-content-type-options"?: string | undefined;
198
- "x-dns-prefetch-control"?: string | undefined;
199
- "x-frame-options"?: string | undefined;
200
- "x-xss-protection"?: string | undefined;
201
- }
202
- interface ClientRequestArgs {
203
- _defaultAgent?: Agent | undefined;
204
- agent?: Agent | boolean | undefined;
205
- auth?: string | null | undefined;
206
- createConnection?:
207
- | ((
208
- options: ClientRequestArgs,
209
- oncreate: (err: Error | null, socket: stream.Duplex) => void,
210
- ) => stream.Duplex | null | undefined)
211
- | undefined;
212
- defaultPort?: number | string | undefined;
213
- family?: number | undefined;
214
- headers?: OutgoingHttpHeaders | readonly string[] | undefined;
215
- hints?: LookupOptions["hints"];
216
- host?: string | null | undefined;
217
- hostname?: string | null | undefined;
218
- insecureHTTPParser?: boolean | undefined;
219
- localAddress?: string | undefined;
220
- localPort?: number | undefined;
221
- lookup?: LookupFunction | undefined;
222
- /**
223
- * @default 16384
224
- */
225
- maxHeaderSize?: number | undefined;
226
- method?: string | undefined;
227
- path?: string | null | undefined;
228
- port?: number | string | null | undefined;
229
- protocol?: string | null | undefined;
230
- setHost?: boolean | undefined;
231
- signal?: AbortSignal | undefined;
232
- socketPath?: string | undefined;
233
- timeout?: number | undefined;
234
- uniqueHeaders?: Array<string | string[]> | undefined;
235
- joinDuplicateHeaders?: boolean;
236
- }
237
- interface ServerOptions<
238
- Request extends typeof IncomingMessage = typeof IncomingMessage,
239
- Response extends typeof ServerResponse<InstanceType<Request>> = typeof ServerResponse,
240
- > {
241
- /**
242
- * Specifies the `IncomingMessage` class to be used. Useful for extending the original `IncomingMessage`.
243
- */
244
- IncomingMessage?: Request | undefined;
245
- /**
246
- * Specifies the `ServerResponse` class to be used. Useful for extending the original `ServerResponse`.
247
- */
248
- ServerResponse?: Response | undefined;
249
- /**
250
- * Sets the timeout value in milliseconds for receiving the entire request from the client.
251
- * @see Server.requestTimeout for more information.
252
- * @default 300000
253
- * @since v18.0.0
254
- */
255
- requestTimeout?: number | undefined;
256
- /**
257
- * It joins the field line values of multiple headers in a request with `, ` instead of discarding the duplicates.
258
- * @default false
259
- * @since v18.14.0
260
- */
261
- joinDuplicateHeaders?: boolean;
262
- /**
263
- * The number of milliseconds of inactivity a server needs to wait for additional incoming data,
264
- * after it has finished writing the last response, before a socket will be destroyed.
265
- * @see Server.keepAliveTimeout for more information.
266
- * @default 5000
267
- * @since v18.0.0
268
- */
269
- keepAliveTimeout?: number | undefined;
270
- /**
271
- * Sets the interval value in milliseconds to check for request and headers timeout in incomplete requests.
272
- * @default 30000
273
- */
274
- connectionsCheckingInterval?: number | undefined;
275
- /**
276
- * Sets the timeout value in milliseconds for receiving the complete HTTP headers from the client.
277
- * See {@link Server.headersTimeout} for more information.
278
- * @default 60000
279
- * @since 18.0.0
280
- */
281
- headersTimeout?: number | undefined;
282
- /**
283
- * Optionally overrides all `socket`s' `readableHighWaterMark` and `writableHighWaterMark`.
284
- * This affects `highWaterMark` property of both `IncomingMessage` and `ServerResponse`.
285
- * Default: @see stream.getDefaultHighWaterMark().
286
- * @since v18.17.0
287
- */
288
- highWaterMark?: number | undefined;
289
- /**
290
- * Use an insecure HTTP parser that accepts invalid HTTP headers when `true`.
291
- * Using the insecure parser should be avoided.
292
- * See --insecure-http-parser for more information.
293
- * @default false
294
- */
295
- insecureHTTPParser?: boolean | undefined;
296
- /**
297
- * Optionally overrides the value of
298
- * `--max-http-header-size` for requests received by this server, i.e.
299
- * the maximum length of request headers in bytes.
300
- * @default 16384
301
- * @since v13.3.0
302
- */
303
- maxHeaderSize?: number | undefined;
304
- /**
305
- * If set to `true`, it disables the use of Nagle's algorithm immediately after a new incoming connection is received.
306
- * @default true
307
- * @since v16.5.0
308
- */
309
- noDelay?: boolean | undefined;
310
- /**
311
- * If set to `true`, it enables keep-alive functionality on the socket immediately after a new incoming connection is received,
312
- * similarly on what is done in `socket.setKeepAlive([enable][, initialDelay])`.
313
- * @default false
314
- * @since v16.5.0
315
- */
316
- keepAlive?: boolean | undefined;
317
- /**
318
- * If set to a positive number, it sets the initial delay before the first keepalive probe is sent on an idle socket.
319
- * @default 0
320
- * @since v16.5.0
321
- */
322
- keepAliveInitialDelay?: number | undefined;
323
- /**
324
- * A list of response headers that should be sent only once.
325
- * If the header's value is an array, the items will be joined using `; `.
326
- */
327
- uniqueHeaders?: Array<string | string[]> | undefined;
328
- /**
329
- * If set to `true`, an error is thrown when writing to an HTTP response which does not have a body.
330
- * @default false
331
- * @since v18.17.0, v20.2.0
332
- */
333
- rejectNonStandardBodyWrites?: boolean | undefined;
334
- }
335
- type RequestListener<
336
- Request extends typeof IncomingMessage = typeof IncomingMessage,
337
- Response extends typeof ServerResponse<InstanceType<Request>> = typeof ServerResponse,
338
- > = (req: InstanceType<Request>, res: InstanceType<Response> & { req: InstanceType<Request> }) => void;
339
- /**
340
- * @since v0.1.17
341
- */
342
- class Server<
343
- Request extends typeof IncomingMessage = typeof IncomingMessage,
344
- Response extends typeof ServerResponse<InstanceType<Request>> = typeof ServerResponse,
345
- > extends NetServer {
346
- constructor(requestListener?: RequestListener<Request, Response>);
347
- constructor(options: ServerOptions<Request, Response>, requestListener?: RequestListener<Request, Response>);
348
- /**
349
- * Sets the timeout value for sockets, and emits a `'timeout'` event on
350
- * the Server object, passing the socket as an argument, if a timeout
351
- * occurs.
352
- *
353
- * If there is a `'timeout'` event listener on the Server object, then it
354
- * will be called with the timed-out socket as an argument.
355
- *
356
- * By default, the Server does not timeout sockets. However, if a callback
357
- * is assigned to the Server's `'timeout'` event, timeouts must be handled
358
- * explicitly.
359
- * @since v0.9.12
360
- * @param [msecs=0 (no timeout)]
361
- */
362
- setTimeout(msecs?: number, callback?: (socket: Socket) => void): this;
363
- setTimeout(callback: (socket: Socket) => void): this;
364
- /**
365
- * Limits maximum incoming headers count. If set to 0, no limit will be applied.
366
- * @since v0.7.0
367
- */
368
- maxHeadersCount: number | null;
369
- /**
370
- * The maximum number of requests socket can handle
371
- * before closing keep alive connection.
372
- *
373
- * A value of `0` will disable the limit.
374
- *
375
- * When the limit is reached it will set the `Connection` header value to `close`,
376
- * but will not actually close the connection, subsequent requests sent
377
- * after the limit is reached will get `503 Service Unavailable` as a response.
378
- * @since v16.10.0
379
- */
380
- maxRequestsPerSocket: number | null;
381
- /**
382
- * The number of milliseconds of inactivity before a socket is presumed
383
- * to have timed out.
384
- *
385
- * A value of `0` will disable the timeout behavior on incoming connections.
386
- *
387
- * The socket timeout logic is set up on connection, so changing this
388
- * value only affects new connections to the server, not any existing connections.
389
- * @since v0.9.12
390
- */
391
- timeout: number;
392
- /**
393
- * Limit the amount of time the parser will wait to receive the complete HTTP
394
- * headers.
395
- *
396
- * If the timeout expires, the server responds with status 408 without
397
- * forwarding the request to the request listener and then closes the connection.
398
- *
399
- * It must be set to a non-zero value (e.g. 120 seconds) to protect against
400
- * potential Denial-of-Service attacks in case the server is deployed without a
401
- * reverse proxy in front.
402
- * @since v11.3.0, v10.14.0
403
- */
404
- headersTimeout: number;
405
- /**
406
- * The number of milliseconds of inactivity a server needs to wait for additional
407
- * incoming data, after it has finished writing the last response, before a socket
408
- * will be destroyed. If the server receives new data before the keep-alive
409
- * timeout has fired, it will reset the regular inactivity timeout, i.e.,`server.timeout`.
410
- *
411
- * A value of `0` will disable the keep-alive timeout behavior on incoming
412
- * connections.
413
- * A value of `0` makes the http server behave similarly to Node.js versions prior
414
- * to 8.0.0, which did not have a keep-alive timeout.
415
- *
416
- * The socket timeout logic is set up on connection, so changing this value only
417
- * affects new connections to the server, not any existing connections.
418
- * @since v8.0.0
419
- */
420
- keepAliveTimeout: number;
421
- /**
422
- * Sets the timeout value in milliseconds for receiving the entire request from
423
- * the client.
424
- *
425
- * If the timeout expires, the server responds with status 408 without
426
- * forwarding the request to the request listener and then closes the connection.
427
- *
428
- * It must be set to a non-zero value (e.g. 120 seconds) to protect against
429
- * potential Denial-of-Service attacks in case the server is deployed without a
430
- * reverse proxy in front.
431
- * @since v14.11.0
432
- */
433
- requestTimeout: number;
434
- /**
435
- * Closes all connections connected to this server.
436
- * @since v18.2.0
437
- */
438
- closeAllConnections(): void;
439
- /**
440
- * Closes all connections connected to this server which are not sending a request or waiting for a response.
441
- * @since v18.2.0
442
- */
443
- closeIdleConnections(): void;
444
- addListener(event: string, listener: (...args: any[]) => void): this;
445
- addListener(event: "close", listener: () => void): this;
446
- addListener(event: "connection", listener: (socket: Socket) => void): this;
447
- addListener(event: "error", listener: (err: Error) => void): this;
448
- addListener(event: "listening", listener: () => void): this;
449
- addListener(event: "checkContinue", listener: RequestListener<Request, Response>): this;
450
- addListener(event: "checkExpectation", listener: RequestListener<Request, Response>): this;
451
- addListener(event: "clientError", listener: (err: Error, socket: stream.Duplex) => void): this;
452
- addListener(
453
- event: "connect",
454
- listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void,
455
- ): this;
456
- addListener(event: "dropRequest", listener: (req: InstanceType<Request>, socket: stream.Duplex) => void): this;
457
- addListener(event: "request", listener: RequestListener<Request, Response>): this;
458
- addListener(
459
- event: "upgrade",
460
- listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void,
461
- ): this;
462
- emit(event: string, ...args: any[]): boolean;
463
- emit(event: "close"): boolean;
464
- emit(event: "connection", socket: Socket): boolean;
465
- emit(event: "error", err: Error): boolean;
466
- emit(event: "listening"): boolean;
467
- emit(
468
- event: "checkContinue",
469
- req: InstanceType<Request>,
470
- res: InstanceType<Response> & { req: InstanceType<Request> },
471
- ): boolean;
472
- emit(
473
- event: "checkExpectation",
474
- req: InstanceType<Request>,
475
- res: InstanceType<Response> & { req: InstanceType<Request> },
476
- ): boolean;
477
- emit(event: "clientError", err: Error, socket: stream.Duplex): boolean;
478
- emit(event: "connect", req: InstanceType<Request>, socket: stream.Duplex, head: Buffer): boolean;
479
- emit(event: "dropRequest", req: InstanceType<Request>, socket: stream.Duplex): boolean;
480
- emit(
481
- event: "request",
482
- req: InstanceType<Request>,
483
- res: InstanceType<Response> & { req: InstanceType<Request> },
484
- ): boolean;
485
- emit(event: "upgrade", req: InstanceType<Request>, socket: stream.Duplex, head: Buffer): boolean;
486
- on(event: string, listener: (...args: any[]) => void): this;
487
- on(event: "close", listener: () => void): this;
488
- on(event: "connection", listener: (socket: Socket) => void): this;
489
- on(event: "error", listener: (err: Error) => void): this;
490
- on(event: "listening", listener: () => void): this;
491
- on(event: "checkContinue", listener: RequestListener<Request, Response>): this;
492
- on(event: "checkExpectation", listener: RequestListener<Request, Response>): this;
493
- on(event: "clientError", listener: (err: Error, socket: stream.Duplex) => void): this;
494
- on(event: "connect", listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void): this;
495
- on(event: "dropRequest", listener: (req: InstanceType<Request>, socket: stream.Duplex) => void): this;
496
- on(event: "request", listener: RequestListener<Request, Response>): this;
497
- on(event: "upgrade", listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void): this;
498
- once(event: string, listener: (...args: any[]) => void): this;
499
- once(event: "close", listener: () => void): this;
500
- once(event: "connection", listener: (socket: Socket) => void): this;
501
- once(event: "error", listener: (err: Error) => void): this;
502
- once(event: "listening", listener: () => void): this;
503
- once(event: "checkContinue", listener: RequestListener<Request, Response>): this;
504
- once(event: "checkExpectation", listener: RequestListener<Request, Response>): this;
505
- once(event: "clientError", listener: (err: Error, socket: stream.Duplex) => void): this;
506
- once(
507
- event: "connect",
508
- listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void,
509
- ): this;
510
- once(event: "dropRequest", listener: (req: InstanceType<Request>, socket: stream.Duplex) => void): this;
511
- once(event: "request", listener: RequestListener<Request, Response>): this;
512
- once(
513
- event: "upgrade",
514
- listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void,
515
- ): this;
516
- prependListener(event: string, listener: (...args: any[]) => void): this;
517
- prependListener(event: "close", listener: () => void): this;
518
- prependListener(event: "connection", listener: (socket: Socket) => void): this;
519
- prependListener(event: "error", listener: (err: Error) => void): this;
520
- prependListener(event: "listening", listener: () => void): this;
521
- prependListener(event: "checkContinue", listener: RequestListener<Request, Response>): this;
522
- prependListener(event: "checkExpectation", listener: RequestListener<Request, Response>): this;
523
- prependListener(event: "clientError", listener: (err: Error, socket: stream.Duplex) => void): this;
524
- prependListener(
525
- event: "connect",
526
- listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void,
527
- ): this;
528
- prependListener(
529
- event: "dropRequest",
530
- listener: (req: InstanceType<Request>, socket: stream.Duplex) => void,
531
- ): this;
532
- prependListener(event: "request", listener: RequestListener<Request, Response>): this;
533
- prependListener(
534
- event: "upgrade",
535
- listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void,
536
- ): this;
537
- prependOnceListener(event: string, listener: (...args: any[]) => void): this;
538
- prependOnceListener(event: "close", listener: () => void): this;
539
- prependOnceListener(event: "connection", listener: (socket: Socket) => void): this;
540
- prependOnceListener(event: "error", listener: (err: Error) => void): this;
541
- prependOnceListener(event: "listening", listener: () => void): this;
542
- prependOnceListener(event: "checkContinue", listener: RequestListener<Request, Response>): this;
543
- prependOnceListener(event: "checkExpectation", listener: RequestListener<Request, Response>): this;
544
- prependOnceListener(event: "clientError", listener: (err: Error, socket: stream.Duplex) => void): this;
545
- prependOnceListener(
546
- event: "connect",
547
- listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void,
548
- ): this;
549
- prependOnceListener(
550
- event: "dropRequest",
551
- listener: (req: InstanceType<Request>, socket: stream.Duplex) => void,
552
- ): this;
553
- prependOnceListener(event: "request", listener: RequestListener<Request, Response>): this;
554
- prependOnceListener(
555
- event: "upgrade",
556
- listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void,
557
- ): this;
558
- }
559
- /**
560
- * This class serves as the parent class of {@link ClientRequest} and {@link ServerResponse}. It is an abstract of outgoing message from
561
- * the perspective of the participants of HTTP transaction.
562
- * @since v0.1.17
563
- */
564
- class OutgoingMessage<Request extends IncomingMessage = IncomingMessage> extends stream.Writable {
565
- readonly req: Request;
566
- chunkedEncoding: boolean;
567
- shouldKeepAlive: boolean;
568
- useChunkedEncodingByDefault: boolean;
569
- sendDate: boolean;
570
- /**
571
- * @deprecated Use `writableEnded` instead.
572
- */
573
- finished: boolean;
574
- /**
575
- * Read-only. `true` if the headers were sent, otherwise `false`.
576
- * @since v0.9.3
577
- */
578
- readonly headersSent: boolean;
579
- /**
580
- * Aliases of `outgoingMessage.socket`
581
- * @since v0.3.0
582
- * @deprecated Since v15.12.0,v14.17.1 - Use `socket` instead.
583
- */
584
- readonly connection: Socket | null;
585
- /**
586
- * Reference to the underlying socket. Usually, users will not want to access
587
- * this property.
588
- *
589
- * After calling `outgoingMessage.end()`, this property will be nulled.
590
- * @since v0.3.0
591
- */
592
- readonly socket: Socket | null;
593
- constructor();
594
- /**
595
- * Once a socket is associated with the message and is connected,`socket.setTimeout()` will be called with `msecs` as the first parameter.
596
- * @since v0.9.12
597
- * @param callback Optional function to be called when a timeout occurs. Same as binding to the `timeout` event.
598
- */
599
- setTimeout(msecs: number, callback?: () => void): this;
600
- /**
601
- * Sets a single header value for the header object.
602
- * If the header already exists in the to-be-sent headers, its value will be replaced. Use an array of strings to send multiple headers with the same name.
603
- * @since v0.4.0
604
- * @param name Header name
605
- * @param value Header value
606
- */
607
- setHeader(name: string, value: number | string | readonly string[]): this;
608
- /**
609
- * Sets multiple header values for implicit headers. headers must be an instance of
610
- * `Headers` or `Map`, if a header already exists in the to-be-sent headers, its
611
- * value will be replaced.
612
- *
613
- * ```js
614
- * const headers = new Headers({ foo: 'bar' });
615
- * outgoingMessage.setHeaders(headers);
616
- * ```
617
- *
618
- * or
619
- *
620
- * ```js
621
- * const headers = new Map([['foo', 'bar']]);
622
- * outgoingMessage.setHeaders(headers);
623
- * ```
624
- *
625
- * When headers have been set with `outgoingMessage.setHeaders()`, they will be
626
- * merged with any headers passed to `response.writeHead()`, with the headers passed
627
- * to `response.writeHead()` given precedence.
628
- *
629
- * ```js
630
- * // Returns content-type = text/plain
631
- * const server = http.createServer((req, res) => {
632
- * const headers = new Headers({ 'Content-Type': 'text/html' });
633
- * res.setHeaders(headers);
634
- * res.writeHead(200, { 'Content-Type': 'text/plain' });
635
- * res.end('ok');
636
- * });
637
- * ```
638
- *
639
- * @since v19.6.0, v18.15.0
640
- * @param name Header name
641
- * @param value Header value
642
- */
643
- setHeaders(headers: Headers | Map<string, number | string | readonly string[]>): this;
644
- /**
645
- * Append a single header value for the header object.
646
- *
647
- * If the value is an array, this is equivalent of calling this method multiple times.
648
- *
649
- * If there were no previous value for the header, this is equivalent of calling `outgoingMessage.setHeader(name, value)`.
650
- *
651
- * Depending of the value of `options.uniqueHeaders` when the client request or the server were created,
652
- * this will end up in the header being sent multiple times or a single time with values joined using `; `.
653
- * @since v18.3.0, v16.17.0
654
- * @param name Header name
655
- * @param value Header value
656
- */
657
- appendHeader(name: string, value: string | readonly string[]): this;
658
- /**
659
- * Gets the value of HTTP header with the given name. If such a name doesn't
660
- * exist in message, it will be `undefined`.
661
- * @since v0.4.0
662
- * @param name Name of header
663
- */
664
- getHeader(name: string): number | string | string[] | undefined;
665
- /**
666
- * Returns a shallow copy of the current outgoing headers. Since a shallow
667
- * copy is used, array values may be mutated without additional calls to
668
- * various header-related HTTP module methods. The keys of the returned
669
- * object are the header names and the values are the respective header
670
- * values. All header names are lowercase.
671
- *
672
- * The object returned by the `outgoingMessage.getHeaders()` method does
673
- * not prototypically inherit from the JavaScript Object. This means that
674
- * typical Object methods such as `obj.toString()`, `obj.hasOwnProperty()`,
675
- * and others are not defined and will not work.
676
- *
677
- * ```js
678
- * outgoingMessage.setHeader('Foo', 'bar');
679
- * outgoingMessage.setHeader('Set-Cookie', ['foo=bar', 'bar=baz']);
680
- *
681
- * const headers = outgoingMessage.getHeaders();
682
- * // headers === { foo: 'bar', 'set-cookie': ['foo=bar', 'bar=baz'] }
683
- * ```
684
- * @since v7.7.0
685
- */
686
- getHeaders(): OutgoingHttpHeaders;
687
- /**
688
- * Returns an array of names of headers of the outgoing outgoingMessage. All
689
- * names are lowercase.
690
- * @since v7.7.0
691
- */
692
- getHeaderNames(): string[];
693
- /**
694
- * Returns `true` if the header identified by `name` is currently set in the
695
- * outgoing headers. The header name is case-insensitive.
696
- *
697
- * ```js
698
- * const hasContentType = outgoingMessage.hasHeader('content-type');
699
- * ```
700
- * @since v7.7.0
701
- */
702
- hasHeader(name: string): boolean;
703
- /**
704
- * Removes a header that is queued for implicit sending.
705
- *
706
- * ```js
707
- * outgoingMessage.removeHeader('Content-Encoding');
708
- * ```
709
- * @since v0.4.0
710
- * @param name Header name
711
- */
712
- removeHeader(name: string): void;
713
- /**
714
- * Adds HTTP trailers (headers but at the end of the message) to the message.
715
- *
716
- * Trailers are **only** be emitted if the message is chunked encoded. If not,
717
- * the trailer will be silently discarded.
718
- *
719
- * HTTP requires the `Trailer` header to be sent to emit trailers,
720
- * with a list of header fields in its value, e.g.
721
- *
722
- * ```js
723
- * message.writeHead(200, { 'Content-Type': 'text/plain',
724
- * 'Trailer': 'Content-MD5' });
725
- * message.write(fileData);
726
- * message.addTrailers({ 'Content-MD5': '7895bf4b8828b55ceaf47747b4bca667' });
727
- * message.end();
728
- * ```
729
- *
730
- * Attempting to set a header field name or value that contains invalid characters
731
- * will result in a `TypeError` being thrown.
732
- * @since v0.3.0
733
- */
734
- addTrailers(headers: OutgoingHttpHeaders | ReadonlyArray<[string, string]>): void;
735
- /**
736
- * Compulsorily flushes the message headers
737
- *
738
- * For efficiency reason, Node.js normally buffers the message headers
739
- * until `outgoingMessage.end()` is called or the first chunk of message data
740
- * is written. It then tries to pack the headers and data into a single TCP
741
- * packet.
742
- *
743
- * It is usually desired (it saves a TCP round-trip), but not when the first
744
- * data is not sent until possibly much later. `outgoingMessage.flushHeaders()`bypasses the optimization and kickstarts the request.
745
- * @since v1.6.0
746
- */
747
- flushHeaders(): void;
748
- }
749
- /**
750
- * This object is created internally by an HTTP server, not by the user. It is
751
- * passed as the second parameter to the `'request'` event.
752
- * @since v0.1.17
753
- */
754
- class ServerResponse<Request extends IncomingMessage = IncomingMessage> extends OutgoingMessage<Request> {
755
- /**
756
- * When using implicit headers (not calling `response.writeHead()` explicitly),
757
- * this property controls the status code that will be sent to the client when
758
- * the headers get flushed.
759
- *
760
- * ```js
761
- * response.statusCode = 404;
762
- * ```
763
- *
764
- * After response header was sent to the client, this property indicates the
765
- * status code which was sent out.
766
- * @since v0.4.0
767
- */
768
- statusCode: number;
769
- /**
770
- * When using implicit headers (not calling `response.writeHead()` explicitly),
771
- * this property controls the status message that will be sent to the client when
772
- * the headers get flushed. If this is left as `undefined` then the standard
773
- * message for the status code will be used.
774
- *
775
- * ```js
776
- * response.statusMessage = 'Not found';
777
- * ```
778
- *
779
- * After response header was sent to the client, this property indicates the
780
- * status message which was sent out.
781
- * @since v0.11.8
782
- */
783
- statusMessage: string;
784
- /**
785
- * If set to `true`, Node.js will check whether the `Content-Length` header value
786
- * and the size of the body, in bytes, are equal. Mismatching the
787
- * `Content-Length` header value will result in an `Error` being thrown,
788
- * identified by `code: 'ERR_HTTP_CONTENT_LENGTH_MISMATCH'`.
789
- * @since v18.10.0, v16.18.0
790
- */
791
- strictContentLength: boolean;
792
- constructor(req: Request);
793
- assignSocket(socket: Socket): void;
794
- detachSocket(socket: Socket): void;
795
- /**
796
- * Sends an HTTP/1.1 100 Continue message to the client, indicating that
797
- * the request body should be sent. See the `'checkContinue'` event on`Server`.
798
- * @since v0.3.0
799
- */
800
- writeContinue(callback?: () => void): void;
801
- /**
802
- * Sends an HTTP/1.1 103 Early Hints message to the client with a Link header,
803
- * indicating that the user agent can preload/preconnect the linked resources.
804
- * The `hints` is an object containing the values of headers to be sent with
805
- * early hints message. The optional `callback` argument will be called when
806
- * the response message has been written.
807
- *
808
- * Example:
809
- *
810
- * ```js
811
- * const earlyHintsLink = '</styles.css>; rel=preload; as=style';
812
- * response.writeEarlyHints({
813
- * 'link': earlyHintsLink,
814
- * });
815
- *
816
- * const earlyHintsLinks = [
817
- * '</styles.css>; rel=preload; as=style',
818
- * '</scripts.js>; rel=preload; as=script',
819
- * ];
820
- * response.writeEarlyHints({
821
- * 'link': earlyHintsLinks,
822
- * 'x-trace-id': 'id for diagnostics'
823
- * });
824
- *
825
- * const earlyHintsCallback = () => console.log('early hints message sent');
826
- * response.writeEarlyHints({
827
- * 'link': earlyHintsLinks
828
- * }, earlyHintsCallback);
829
- * ```
830
- *
831
- * @since v18.11.0
832
- * @param hints An object containing the values of headers
833
- * @param callback Will be called when the response message has been written
834
- */
835
- writeEarlyHints(hints: Record<string, string | string[]>, callback?: () => void): void;
836
- /**
837
- * Sends a response header to the request. The status code is a 3-digit HTTP
838
- * status code, like `404`. The last argument, `headers`, are the response headers.
839
- * Optionally one can give a human-readable `statusMessage` as the second
840
- * argument.
841
- *
842
- * `headers` may be an `Array` where the keys and values are in the same list.
843
- * It is _not_ a list of tuples. So, the even-numbered offsets are key values,
844
- * and the odd-numbered offsets are the associated values. The array is in the same
845
- * format as `request.rawHeaders`.
846
- *
847
- * Returns a reference to the `ServerResponse`, so that calls can be chained.
848
- *
849
- * ```js
850
- * const body = 'hello world';
851
- * response
852
- * .writeHead(200, {
853
- * 'Content-Length': Buffer.byteLength(body),
854
- * 'Content-Type': 'text/plain'
855
- * })
856
- * .end(body);
857
- * ```
858
- *
859
- * This method must only be called once on a message and it must
860
- * be called before `response.end()` is called.
861
- *
862
- * If `response.write()` or `response.end()` are called before calling
863
- * this, the implicit/mutable headers will be calculated and call this function.
864
- *
865
- * When headers have been set with `response.setHeader()`, they will be merged
866
- * with any headers passed to `response.writeHead()`, with the headers passed
867
- * to `response.writeHead()` given precedence.
868
- *
869
- * If this method is called and `response.setHeader()` has not been called,
870
- * it will directly write the supplied header values onto the network channel
871
- * without caching internally, and the `response.getHeader()` on the header
872
- * will not yield the expected result. If progressive population of headers is
873
- * desired with potential future retrieval and modification, use `response.setHeader()` instead.
874
- *
875
- * ```js
876
- * // Returns content-type = text/plain
877
- * const server = http.createServer((req, res) => {
878
- * res.setHeader('Content-Type', 'text/html');
879
- * res.setHeader('X-Foo', 'bar');
880
- * res.writeHead(200, { 'Content-Type': 'text/plain' });
881
- * res.end('ok');
882
- * });
883
- * ```
884
- *
885
- * `Content-Length` is given in bytes, not characters. Use `Buffer.byteLength()` to determine the length of the body in bytes. Node.js
886
- * does not check whether `Content-Length` and the length of the body which has
887
- * been transmitted are equal or not.
888
- *
889
- * Attempting to set a header field name or value that contains invalid characters
890
- * will result in a `TypeError` being thrown.
891
- * @since v0.1.30
892
- */
893
- writeHead(
894
- statusCode: number,
895
- statusMessage?: string,
896
- headers?: OutgoingHttpHeaders | OutgoingHttpHeader[],
897
- ): this;
898
- writeHead(statusCode: number, headers?: OutgoingHttpHeaders | OutgoingHttpHeader[]): this;
899
- /**
900
- * Sends an HTTP/1.1 102 Processing message to the client, indicating that
901
- * the request body should be sent.
902
- * @since v10.0.0
903
- */
904
- writeProcessing(callback?: () => void): void;
905
- }
906
- interface InformationEvent {
907
- statusCode: number;
908
- statusMessage: string;
909
- httpVersion: string;
910
- httpVersionMajor: number;
911
- httpVersionMinor: number;
912
- headers: IncomingHttpHeaders;
913
- rawHeaders: string[];
914
- }
915
- /**
916
- * This object is created internally and returned from {@link request}. It
917
- * represents an _in-progress_ request whose header has already been queued. The
918
- * header is still mutable using the `setHeader(name, value)`, `getHeader(name)`, `removeHeader(name)` API. The actual header will
919
- * be sent along with the first data chunk or when calling `request.end()`.
920
- *
921
- * To get the response, add a listener for `'response'` to the request object.`'response'` will be emitted from the request object when the response
922
- * headers have been received. The `'response'` event is executed with one
923
- * argument which is an instance of {@link IncomingMessage}.
924
- *
925
- * During the `'response'` event, one can add listeners to the
926
- * response object; particularly to listen for the `'data'` event.
927
- *
928
- * If no `'response'` handler is added, then the response will be
929
- * entirely discarded. However, if a `'response'` event handler is added,
930
- * then the data from the response object **must** be consumed, either by
931
- * calling `response.read()` whenever there is a `'readable'` event, or
932
- * by adding a `'data'` handler, or by calling the `.resume()` method.
933
- * Until the data is consumed, the `'end'` event will not fire. Also, until
934
- * the data is read it will consume memory that can eventually lead to a
935
- * 'process out of memory' error.
936
- *
937
- * For backward compatibility, `res` will only emit `'error'` if there is an`'error'` listener registered.
938
- *
939
- * Node.js does not check whether Content-Length and the length of the
940
- * body which has been transmitted are equal or not.
941
- * @since v0.1.17
942
- */
943
- class ClientRequest extends OutgoingMessage {
944
- /**
945
- * The `request.aborted` property will be `true` if the request has
946
- * been aborted.
947
- * @since v0.11.14
948
- * @deprecated Since v17.0.0,v16.12.0 - Check `destroyed` instead.
949
- */
950
- aborted: boolean;
951
- /**
952
- * The request host.
953
- * @since v14.5.0, v12.19.0
954
- */
955
- host: string;
956
- /**
957
- * The request protocol.
958
- * @since v14.5.0, v12.19.0
959
- */
960
- protocol: string;
961
- /**
962
- * When sending request through a keep-alive enabled agent, the underlying socket
963
- * might be reused. But if server closes connection at unfortunate time, client
964
- * may run into a 'ECONNRESET' error.
965
- *
966
- * ```js
967
- * import http from 'node:http';
968
- *
969
- * // Server has a 5 seconds keep-alive timeout by default
970
- * http
971
- * .createServer((req, res) => {
972
- * res.write('hello\n');
973
- * res.end();
974
- * })
975
- * .listen(3000);
976
- *
977
- * setInterval(() => {
978
- * // Adapting a keep-alive agent
979
- * http.get('http://localhost:3000', { agent }, (res) => {
980
- * res.on('data', (data) => {
981
- * // Do nothing
982
- * });
983
- * });
984
- * }, 5000); // Sending request on 5s interval so it's easy to hit idle timeout
985
- * ```
986
- *
987
- * By marking a request whether it reused socket or not, we can do
988
- * automatic error retry base on it.
989
- *
990
- * ```js
991
- * import http from 'node:http';
992
- * const agent = new http.Agent({ keepAlive: true });
993
- *
994
- * function retriableRequest() {
995
- * const req = http
996
- * .get('http://localhost:3000', { agent }, (res) => {
997
- * // ...
998
- * })
999
- * .on('error', (err) => {
1000
- * // Check if retry is needed
1001
- * if (req.reusedSocket &#x26;&#x26; err.code === 'ECONNRESET') {
1002
- * retriableRequest();
1003
- * }
1004
- * });
1005
- * }
1006
- *
1007
- * retriableRequest();
1008
- * ```
1009
- * @since v13.0.0, v12.16.0
1010
- */
1011
- reusedSocket: boolean;
1012
- /**
1013
- * Limits maximum response headers count. If set to 0, no limit will be applied.
1014
- */
1015
- maxHeadersCount: number;
1016
- constructor(url: string | URL | ClientRequestArgs, cb?: (res: IncomingMessage) => void);
1017
- /**
1018
- * The request method.
1019
- * @since v0.1.97
1020
- */
1021
- method: string;
1022
- /**
1023
- * The request path.
1024
- * @since v0.4.0
1025
- */
1026
- path: string;
1027
- /**
1028
- * Marks the request as aborting. Calling this will cause remaining data
1029
- * in the response to be dropped and the socket to be destroyed.
1030
- * @since v0.3.8
1031
- * @deprecated Since v14.1.0,v13.14.0 - Use `destroy` instead.
1032
- */
1033
- abort(): void;
1034
- onSocket(socket: Socket): void;
1035
- /**
1036
- * Once a socket is assigned to this request and is connected `socket.setTimeout()` will be called.
1037
- * @since v0.5.9
1038
- * @param timeout Milliseconds before a request times out.
1039
- * @param callback Optional function to be called when a timeout occurs. Same as binding to the `'timeout'` event.
1040
- */
1041
- setTimeout(timeout: number, callback?: () => void): this;
1042
- /**
1043
- * Once a socket is assigned to this request and is connected `socket.setNoDelay()` will be called.
1044
- * @since v0.5.9
1045
- */
1046
- setNoDelay(noDelay?: boolean): void;
1047
- /**
1048
- * Once a socket is assigned to this request and is connected `socket.setKeepAlive()` will be called.
1049
- * @since v0.5.9
1050
- */
1051
- setSocketKeepAlive(enable?: boolean, initialDelay?: number): void;
1052
- /**
1053
- * Returns an array containing the unique names of the current outgoing raw
1054
- * headers. Header names are returned with their exact casing being set.
1055
- *
1056
- * ```js
1057
- * request.setHeader('Foo', 'bar');
1058
- * request.setHeader('Set-Cookie', ['foo=bar', 'bar=baz']);
1059
- *
1060
- * const headerNames = request.getRawHeaderNames();
1061
- * // headerNames === ['Foo', 'Set-Cookie']
1062
- * ```
1063
- * @since v15.13.0, v14.17.0
1064
- */
1065
- getRawHeaderNames(): string[];
1066
- /**
1067
- * @deprecated
1068
- */
1069
- addListener(event: "abort", listener: () => void): this;
1070
- addListener(
1071
- event: "connect",
1072
- listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void,
1073
- ): this;
1074
- addListener(event: "continue", listener: () => void): this;
1075
- addListener(event: "information", listener: (info: InformationEvent) => void): this;
1076
- addListener(event: "response", listener: (response: IncomingMessage) => void): this;
1077
- addListener(event: "socket", listener: (socket: Socket) => void): this;
1078
- addListener(event: "timeout", listener: () => void): this;
1079
- addListener(
1080
- event: "upgrade",
1081
- listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void,
1082
- ): this;
1083
- addListener(event: "close", listener: () => void): this;
1084
- addListener(event: "drain", listener: () => void): this;
1085
- addListener(event: "error", listener: (err: Error) => void): this;
1086
- addListener(event: "finish", listener: () => void): this;
1087
- addListener(event: "pipe", listener: (src: stream.Readable) => void): this;
1088
- addListener(event: "unpipe", listener: (src: stream.Readable) => void): this;
1089
- addListener(event: string | symbol, listener: (...args: any[]) => void): this;
1090
- /**
1091
- * @deprecated
1092
- */
1093
- on(event: "abort", listener: () => void): this;
1094
- on(event: "connect", listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this;
1095
- on(event: "continue", listener: () => void): this;
1096
- on(event: "information", listener: (info: InformationEvent) => void): this;
1097
- on(event: "response", listener: (response: IncomingMessage) => void): this;
1098
- on(event: "socket", listener: (socket: Socket) => void): this;
1099
- on(event: "timeout", listener: () => void): this;
1100
- on(event: "upgrade", listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this;
1101
- on(event: "close", listener: () => void): this;
1102
- on(event: "drain", listener: () => void): this;
1103
- on(event: "error", listener: (err: Error) => void): this;
1104
- on(event: "finish", listener: () => void): this;
1105
- on(event: "pipe", listener: (src: stream.Readable) => void): this;
1106
- on(event: "unpipe", listener: (src: stream.Readable) => void): this;
1107
- on(event: string | symbol, listener: (...args: any[]) => void): this;
1108
- /**
1109
- * @deprecated
1110
- */
1111
- once(event: "abort", listener: () => void): this;
1112
- once(event: "connect", listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this;
1113
- once(event: "continue", listener: () => void): this;
1114
- once(event: "information", listener: (info: InformationEvent) => void): this;
1115
- once(event: "response", listener: (response: IncomingMessage) => void): this;
1116
- once(event: "socket", listener: (socket: Socket) => void): this;
1117
- once(event: "timeout", listener: () => void): this;
1118
- once(event: "upgrade", listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this;
1119
- once(event: "close", listener: () => void): this;
1120
- once(event: "drain", listener: () => void): this;
1121
- once(event: "error", listener: (err: Error) => void): this;
1122
- once(event: "finish", listener: () => void): this;
1123
- once(event: "pipe", listener: (src: stream.Readable) => void): this;
1124
- once(event: "unpipe", listener: (src: stream.Readable) => void): this;
1125
- once(event: string | symbol, listener: (...args: any[]) => void): this;
1126
- /**
1127
- * @deprecated
1128
- */
1129
- prependListener(event: "abort", listener: () => void): this;
1130
- prependListener(
1131
- event: "connect",
1132
- listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void,
1133
- ): this;
1134
- prependListener(event: "continue", listener: () => void): this;
1135
- prependListener(event: "information", listener: (info: InformationEvent) => void): this;
1136
- prependListener(event: "response", listener: (response: IncomingMessage) => void): this;
1137
- prependListener(event: "socket", listener: (socket: Socket) => void): this;
1138
- prependListener(event: "timeout", listener: () => void): this;
1139
- prependListener(
1140
- event: "upgrade",
1141
- listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void,
1142
- ): this;
1143
- prependListener(event: "close", listener: () => void): this;
1144
- prependListener(event: "drain", listener: () => void): this;
1145
- prependListener(event: "error", listener: (err: Error) => void): this;
1146
- prependListener(event: "finish", listener: () => void): this;
1147
- prependListener(event: "pipe", listener: (src: stream.Readable) => void): this;
1148
- prependListener(event: "unpipe", listener: (src: stream.Readable) => void): this;
1149
- prependListener(event: string | symbol, listener: (...args: any[]) => void): this;
1150
- /**
1151
- * @deprecated
1152
- */
1153
- prependOnceListener(event: "abort", listener: () => void): this;
1154
- prependOnceListener(
1155
- event: "connect",
1156
- listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void,
1157
- ): this;
1158
- prependOnceListener(event: "continue", listener: () => void): this;
1159
- prependOnceListener(event: "information", listener: (info: InformationEvent) => void): this;
1160
- prependOnceListener(event: "response", listener: (response: IncomingMessage) => void): this;
1161
- prependOnceListener(event: "socket", listener: (socket: Socket) => void): this;
1162
- prependOnceListener(event: "timeout", listener: () => void): this;
1163
- prependOnceListener(
1164
- event: "upgrade",
1165
- listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void,
1166
- ): this;
1167
- prependOnceListener(event: "close", listener: () => void): this;
1168
- prependOnceListener(event: "drain", listener: () => void): this;
1169
- prependOnceListener(event: "error", listener: (err: Error) => void): this;
1170
- prependOnceListener(event: "finish", listener: () => void): this;
1171
- prependOnceListener(event: "pipe", listener: (src: stream.Readable) => void): this;
1172
- prependOnceListener(event: "unpipe", listener: (src: stream.Readable) => void): this;
1173
- prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this;
1174
- }
1175
- /**
1176
- * An `IncomingMessage` object is created by {@link Server} or {@link ClientRequest} and passed as the first argument to the `'request'` and `'response'` event respectively. It may be used to
1177
- * access response
1178
- * status, headers and data.
1179
- *
1180
- * Different from its `socket` value which is a subclass of `stream.Duplex`, the`IncomingMessage` itself extends `stream.Readable` and is created separately to
1181
- * parse and emit the incoming HTTP headers and payload, as the underlying socket
1182
- * may be reused multiple times in case of keep-alive.
1183
- * @since v0.1.17
1184
- */
1185
- class IncomingMessage extends stream.Readable {
1186
- constructor(socket: Socket);
1187
- /**
1188
- * The `message.aborted` property will be `true` if the request has
1189
- * been aborted.
1190
- * @since v10.1.0
1191
- * @deprecated Since v17.0.0,v16.12.0 - Check `message.destroyed` from <a href="stream.html#class-streamreadable" class="type">stream.Readable</a>.
1192
- */
1193
- aborted: boolean;
1194
- /**
1195
- * In case of server request, the HTTP version sent by the client. In the case of
1196
- * client response, the HTTP version of the connected-to server.
1197
- * Probably either `'1.1'` or `'1.0'`.
1198
- *
1199
- * Also `message.httpVersionMajor` is the first integer and`message.httpVersionMinor` is the second.
1200
- * @since v0.1.1
1201
- */
1202
- httpVersion: string;
1203
- httpVersionMajor: number;
1204
- httpVersionMinor: number;
1205
- /**
1206
- * The `message.complete` property will be `true` if a complete HTTP message has
1207
- * been received and successfully parsed.
1208
- *
1209
- * This property is particularly useful as a means of determining if a client or
1210
- * server fully transmitted a message before a connection was terminated:
1211
- *
1212
- * ```js
1213
- * const req = http.request({
1214
- * host: '127.0.0.1',
1215
- * port: 8080,
1216
- * method: 'POST'
1217
- * }, (res) => {
1218
- * res.resume();
1219
- * res.on('end', () => {
1220
- * if (!res.complete)
1221
- * console.error(
1222
- * 'The connection was terminated while the message was still being sent');
1223
- * });
1224
- * });
1225
- * ```
1226
- * @since v0.3.0
1227
- */
1228
- complete: boolean;
1229
- /**
1230
- * Alias for `message.socket`.
1231
- * @since v0.1.90
1232
- * @deprecated Since v16.0.0 - Use `socket`.
1233
- */
1234
- connection: Socket;
1235
- /**
1236
- * The `net.Socket` object associated with the connection.
1237
- *
1238
- * With HTTPS support, use `request.socket.getPeerCertificate()` to obtain the
1239
- * client's authentication details.
1240
- *
1241
- * This property is guaranteed to be an instance of the `net.Socket` class,
1242
- * a subclass of `stream.Duplex`, unless the user specified a socket
1243
- * type other than `net.Socket` or internally nulled.
1244
- * @since v0.3.0
1245
- */
1246
- socket: Socket;
1247
- /**
1248
- * The request/response headers object.
1249
- *
1250
- * Key-value pairs of header names and values. Header names are lower-cased.
1251
- *
1252
- * ```js
1253
- * // Prints something like:
1254
- * //
1255
- * // { 'user-agent': 'curl/7.22.0',
1256
- * // host: '127.0.0.1:8000',
1257
- * // accept: '*' }
1258
- * console.log(request.getHeaders());
1259
- * ```
1260
- *
1261
- * Duplicates in raw headers are handled in the following ways, depending on the
1262
- * header name:
1263
- *
1264
- * * Duplicates of `age`, `authorization`, `content-length`, `content-type`, `etag`, `expires`, `from`, `host`, `if-modified-since`, `if-unmodified-since`, `last-modified`, `location`,
1265
- * `max-forwards`, `proxy-authorization`, `referer`, `retry-after`, `server`, or `user-agent` are discarded.
1266
- * * `set-cookie` is always an array. Duplicates are added to the array.
1267
- * * For duplicate `cookie` headers, the values are joined together with '; '.
1268
- * * For all other headers, the values are joined together with ', '.
1269
- * @since v0.1.5
1270
- */
1271
- headers: IncomingHttpHeaders;
1272
- /**
1273
- * Similar to `message.headers`, but there is no join logic and the values are always arrays of strings, even for headers received just once.
1274
- *
1275
- * ```js
1276
- * // Prints something like:
1277
- * //
1278
- * // { 'user-agent': ['curl/7.22.0'],
1279
- * // host: ['127.0.0.1:8000'],
1280
- * // accept: ['*'] }
1281
- * console.log(request.headersDistinct);
1282
- * ```
1283
- * @since v18.3.0, v16.17.0
1284
- */
1285
- headersDistinct: NodeJS.Dict<string[]>;
1286
- /**
1287
- * The raw request/response headers list exactly as they were received.
1288
- *
1289
- * The keys and values are in the same list. It is _not_ a
1290
- * list of tuples. So, the even-numbered offsets are key values, and the
1291
- * odd-numbered offsets are the associated values.
1292
- *
1293
- * Header names are not lowercased, and duplicates are not merged.
1294
- *
1295
- * ```js
1296
- * // Prints something like:
1297
- * //
1298
- * // [ 'user-agent',
1299
- * // 'this is invalid because there can be only one',
1300
- * // 'User-Agent',
1301
- * // 'curl/7.22.0',
1302
- * // 'Host',
1303
- * // '127.0.0.1:8000',
1304
- * // 'ACCEPT',
1305
- * // '*' ]
1306
- * console.log(request.rawHeaders);
1307
- * ```
1308
- * @since v0.11.6
1309
- */
1310
- rawHeaders: string[];
1311
- /**
1312
- * The request/response trailers object. Only populated at the `'end'` event.
1313
- * @since v0.3.0
1314
- */
1315
- trailers: NodeJS.Dict<string>;
1316
- /**
1317
- * Similar to `message.trailers`, but there is no join logic and the values are always arrays of strings, even for headers received just once.
1318
- * Only populated at the `'end'` event.
1319
- * @since v18.3.0, v16.17.0
1320
- */
1321
- trailersDistinct: NodeJS.Dict<string[]>;
1322
- /**
1323
- * The raw request/response trailer keys and values exactly as they were
1324
- * received. Only populated at the `'end'` event.
1325
- * @since v0.11.6
1326
- */
1327
- rawTrailers: string[];
1328
- /**
1329
- * Calls `message.socket.setTimeout(msecs, callback)`.
1330
- * @since v0.5.9
1331
- */
1332
- setTimeout(msecs: number, callback?: () => void): this;
1333
- /**
1334
- * **Only valid for request obtained from {@link Server}.**
1335
- *
1336
- * The request method as a string. Read only. Examples: `'GET'`, `'DELETE'`.
1337
- * @since v0.1.1
1338
- */
1339
- method?: string | undefined;
1340
- /**
1341
- * **Only valid for request obtained from {@link Server}.**
1342
- *
1343
- * Request URL string. This contains only the URL that is present in the actual
1344
- * HTTP request. Take the following request:
1345
- *
1346
- * ```http
1347
- * GET /status?name=ryan HTTP/1.1
1348
- * Accept: text/plain
1349
- * ```
1350
- *
1351
- * To parse the URL into its parts:
1352
- *
1353
- * ```js
1354
- * new URL(request.url, `http://${request.getHeaders().host}`);
1355
- * ```
1356
- *
1357
- * When `request.url` is `'/status?name=ryan'` and `request.getHeaders().host` is `'localhost:3000'`:
1358
- *
1359
- * ```console
1360
- * $ node
1361
- * > new URL(request.url, `http://${request.getHeaders().host}`)
1362
- * URL {
1363
- * href: 'http://localhost:3000/status?name=ryan',
1364
- * origin: 'http://localhost:3000',
1365
- * protocol: 'http:',
1366
- * username: '',
1367
- * password: '',
1368
- * host: 'localhost:3000',
1369
- * hostname: 'localhost',
1370
- * port: '3000',
1371
- * pathname: '/status',
1372
- * search: '?name=ryan',
1373
- * searchParams: URLSearchParams { 'name' => 'ryan' },
1374
- * hash: ''
1375
- * }
1376
- * ```
1377
- * @since v0.1.90
1378
- */
1379
- url?: string | undefined;
1380
- /**
1381
- * **Only valid for response obtained from {@link ClientRequest}.**
1382
- *
1383
- * The 3-digit HTTP response status code. E.G. `404`.
1384
- * @since v0.1.1
1385
- */
1386
- statusCode?: number | undefined;
1387
- /**
1388
- * **Only valid for response obtained from {@link ClientRequest}.**
1389
- *
1390
- * The HTTP response status message (reason phrase). E.G. `OK` or `Internal Server Error`.
1391
- * @since v0.11.10
1392
- */
1393
- statusMessage?: string | undefined;
1394
- /**
1395
- * Calls `destroy()` on the socket that received the `IncomingMessage`. If `error`is provided, an `'error'` event is emitted on the socket and `error` is passed
1396
- * as an argument to any listeners on the event.
1397
- * @since v0.3.0
1398
- */
1399
- destroy(error?: Error): this;
1400
- }
1401
- interface AgentOptions extends NodeJS.PartialOptions<TcpSocketConnectOpts> {
1402
- /**
1403
- * Keep sockets around in a pool to be used by other requests in the future. Default = false
1404
- */
1405
- keepAlive?: boolean | undefined;
1406
- /**
1407
- * When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000.
1408
- * Only relevant if keepAlive is set to true.
1409
- */
1410
- keepAliveMsecs?: number | undefined;
1411
- /**
1412
- * Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity
1413
- */
1414
- maxSockets?: number | undefined;
1415
- /**
1416
- * Maximum number of sockets allowed for all hosts in total. Each request will use a new socket until the maximum is reached. Default: Infinity.
1417
- */
1418
- maxTotalSockets?: number | undefined;
1419
- /**
1420
- * Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256.
1421
- */
1422
- maxFreeSockets?: number | undefined;
1423
- /**
1424
- * Socket timeout in milliseconds. This will set the timeout after the socket is connected.
1425
- */
1426
- timeout?: number | undefined;
1427
- /**
1428
- * Scheduling strategy to apply when picking the next free socket to use.
1429
- * @default `lifo`
1430
- */
1431
- scheduling?: "fifo" | "lifo" | undefined;
1432
- }
1433
- /**
1434
- * An `Agent` is responsible for managing connection persistence
1435
- * and reuse for HTTP clients. It maintains a queue of pending requests
1436
- * for a given host and port, reusing a single socket connection for each
1437
- * until the queue is empty, at which time the socket is either destroyed
1438
- * or put into a pool where it is kept to be used again for requests to the
1439
- * same host and port. Whether it is destroyed or pooled depends on the`keepAlive` `option`.
1440
- *
1441
- * Pooled connections have TCP Keep-Alive enabled for them, but servers may
1442
- * still close idle connections, in which case they will be removed from the
1443
- * pool and a new connection will be made when a new HTTP request is made for
1444
- * that host and port. Servers may also refuse to allow multiple requests
1445
- * over the same connection, in which case the connection will have to be
1446
- * remade for every request and cannot be pooled. The `Agent` will still make
1447
- * the requests to that server, but each one will occur over a new connection.
1448
- *
1449
- * When a connection is closed by the client or the server, it is removed
1450
- * from the pool. Any unused sockets in the pool will be unrefed so as not
1451
- * to keep the Node.js process running when there are no outstanding requests.
1452
- * (see `socket.unref()`).
1453
- *
1454
- * It is good practice, to `destroy()` an `Agent` instance when it is no
1455
- * longer in use, because unused sockets consume OS resources.
1456
- *
1457
- * Sockets are removed from an agent when the socket emits either
1458
- * a `'close'` event or an `'agentRemove'` event. When intending to keep one
1459
- * HTTP request open for a long time without keeping it in the agent, something
1460
- * like the following may be done:
1461
- *
1462
- * ```js
1463
- * http.get(options, (res) => {
1464
- * // Do stuff
1465
- * }).on('socket', (socket) => {
1466
- * socket.emit('agentRemove');
1467
- * });
1468
- * ```
1469
- *
1470
- * An agent may also be used for an individual request. By providing`{agent: false}` as an option to the `http.get()` or `http.request()` functions, a one-time use `Agent` with default options
1471
- * will be used
1472
- * for the client connection.
1473
- *
1474
- * `agent:false`:
1475
- *
1476
- * ```js
1477
- * http.get({
1478
- * hostname: 'localhost',
1479
- * port: 80,
1480
- * path: '/',
1481
- * agent: false // Create a new agent just for this one request
1482
- * }, (res) => {
1483
- * // Do stuff with response
1484
- * });
1485
- * ```
1486
- * @since v0.3.4
1487
- */
1488
- class Agent extends EventEmitter {
1489
- /**
1490
- * By default set to 256. For agents with `keepAlive` enabled, this
1491
- * sets the maximum number of sockets that will be left open in the free
1492
- * state.
1493
- * @since v0.11.7
1494
- */
1495
- maxFreeSockets: number;
1496
- /**
1497
- * By default set to `Infinity`. Determines how many concurrent sockets the agent
1498
- * can have open per origin. Origin is the returned value of `agent.getName()`.
1499
- * @since v0.3.6
1500
- */
1501
- maxSockets: number;
1502
- /**
1503
- * By default set to `Infinity`. Determines how many concurrent sockets the agent
1504
- * can have open. Unlike `maxSockets`, this parameter applies across all origins.
1505
- * @since v14.5.0, v12.19.0
1506
- */
1507
- maxTotalSockets: number;
1508
- /**
1509
- * An object which contains arrays of sockets currently awaiting use by
1510
- * the agent when `keepAlive` is enabled. Do not modify.
1511
- *
1512
- * Sockets in the `freeSockets` list will be automatically destroyed and
1513
- * removed from the array on `'timeout'`.
1514
- * @since v0.11.4
1515
- */
1516
- readonly freeSockets: NodeJS.ReadOnlyDict<Socket[]>;
1517
- /**
1518
- * An object which contains arrays of sockets currently in use by the
1519
- * agent. Do not modify.
1520
- * @since v0.3.6
1521
- */
1522
- readonly sockets: NodeJS.ReadOnlyDict<Socket[]>;
1523
- /**
1524
- * An object which contains queues of requests that have not yet been assigned to
1525
- * sockets. Do not modify.
1526
- * @since v0.5.9
1527
- */
1528
- readonly requests: NodeJS.ReadOnlyDict<IncomingMessage[]>;
1529
- constructor(opts?: AgentOptions);
1530
- /**
1531
- * Destroy any sockets that are currently in use by the agent.
1532
- *
1533
- * It is usually not necessary to do this. However, if using an
1534
- * agent with `keepAlive` enabled, then it is best to explicitly shut down
1535
- * the agent when it is no longer needed. Otherwise,
1536
- * sockets might stay open for quite a long time before the server
1537
- * terminates them.
1538
- * @since v0.11.4
1539
- */
1540
- destroy(): void;
1541
- /**
1542
- * Produces a socket/stream to be used for HTTP requests.
1543
- *
1544
- * By default, this function is the same as `net.createConnection()`. However,
1545
- * custom agents may override this method in case greater flexibility is desired.
1546
- *
1547
- * A socket/stream can be supplied in one of two ways: by returning the
1548
- * socket/stream from this function, or by passing the socket/stream to `callback`.
1549
- *
1550
- * This method is guaranteed to return an instance of the `net.Socket` class,
1551
- * a subclass of `stream.Duplex`, unless the user specifies a socket
1552
- * type other than `net.Socket`.
1553
- *
1554
- * `callback` has a signature of `(err, stream)`.
1555
- * @since v0.11.4
1556
- * @param options Options containing connection details. Check `createConnection` for the format of the options
1557
- * @param callback Callback function that receives the created socket
1558
- */
1559
- createConnection(
1560
- options: ClientRequestArgs,
1561
- callback?: (err: Error | null, stream: stream.Duplex) => void,
1562
- ): stream.Duplex | null | undefined;
1563
- /**
1564
- * Called when `socket` is detached from a request and could be persisted by the`Agent`. Default behavior is to:
1565
- *
1566
- * ```js
1567
- * socket.setKeepAlive(true, this.keepAliveMsecs);
1568
- * socket.unref();
1569
- * return true;
1570
- * ```
1571
- *
1572
- * This method can be overridden by a particular `Agent` subclass. If this
1573
- * method returns a falsy value, the socket will be destroyed instead of persisting
1574
- * it for use with the next request.
1575
- *
1576
- * The `socket` argument can be an instance of `net.Socket`, a subclass of `stream.Duplex`.
1577
- * @since v8.1.0
1578
- */
1579
- keepSocketAlive(socket: stream.Duplex): void;
1580
- /**
1581
- * Called when `socket` is attached to `request` after being persisted because of
1582
- * the keep-alive options. Default behavior is to:
1583
- *
1584
- * ```js
1585
- * socket.ref();
1586
- * ```
1587
- *
1588
- * This method can be overridden by a particular `Agent` subclass.
1589
- *
1590
- * The `socket` argument can be an instance of `net.Socket`, a subclass of `stream.Duplex`.
1591
- * @since v8.1.0
1592
- */
1593
- reuseSocket(socket: stream.Duplex, request: ClientRequest): void;
1594
- /**
1595
- * Get a unique name for a set of request options, to determine whether a
1596
- * connection can be reused. For an HTTP agent, this returns`host:port:localAddress` or `host:port:localAddress:family`. For an HTTPS agent,
1597
- * the name includes the CA, cert, ciphers, and other HTTPS/TLS-specific options
1598
- * that determine socket reusability.
1599
- * @since v0.11.4
1600
- * @param options A set of options providing information for name generation
1601
- */
1602
- getName(options?: ClientRequestArgs): string;
1603
- }
1604
- const METHODS: string[];
1605
- const STATUS_CODES: {
1606
- [errorCode: number]: string | undefined;
1607
- [errorCode: string]: string | undefined;
1608
- };
1609
- /**
1610
- * Returns a new instance of {@link Server}.
1611
- *
1612
- * The `requestListener` is a function which is automatically
1613
- * added to the `'request'` event.
1614
- * @since v0.1.13
1615
- */
1616
- function createServer<
1617
- Request extends typeof IncomingMessage = typeof IncomingMessage,
1618
- Response extends typeof ServerResponse<InstanceType<Request>> = typeof ServerResponse,
1619
- >(requestListener?: RequestListener<Request, Response>): Server<Request, Response>;
1620
- function createServer<
1621
- Request extends typeof IncomingMessage = typeof IncomingMessage,
1622
- Response extends typeof ServerResponse<InstanceType<Request>> = typeof ServerResponse,
1623
- >(
1624
- options: ServerOptions<Request, Response>,
1625
- requestListener?: RequestListener<Request, Response>,
1626
- ): Server<Request, Response>;
1627
- // although RequestOptions are passed as ClientRequestArgs to ClientRequest directly,
1628
- // create interface RequestOptions would make the naming more clear to developers
1629
- interface RequestOptions extends ClientRequestArgs {}
1630
- /**
1631
- * `options` in `socket.connect()` are also supported.
1632
- *
1633
- * Node.js maintains several connections per server to make HTTP requests.
1634
- * This function allows one to transparently issue requests.
1635
- *
1636
- * `url` can be a string or a `URL` object. If `url` is a
1637
- * string, it is automatically parsed with `new URL()`. If it is a `URL` object, it will be automatically converted to an ordinary `options` object.
1638
- *
1639
- * If both `url` and `options` are specified, the objects are merged, with the`options` properties taking precedence.
1640
- *
1641
- * The optional `callback` parameter will be added as a one-time listener for
1642
- * the `'response'` event.
1643
- *
1644
- * `http.request()` returns an instance of the {@link ClientRequest} class. The `ClientRequest` instance is a writable stream. If one needs to
1645
- * upload a file with a POST request, then write to the `ClientRequest` object.
1646
- *
1647
- * ```js
1648
- * import http from 'node:http';
1649
- *
1650
- * const postData = JSON.stringify({
1651
- * 'msg': 'Hello World!'
1652
- * });
1653
- *
1654
- * const options = {
1655
- * hostname: 'www.google.com',
1656
- * port: 80,
1657
- * path: '/upload',
1658
- * method: 'POST',
1659
- * headers: {
1660
- * 'Content-Type': 'application/json',
1661
- * 'Content-Length': Buffer.byteLength(postData)
1662
- * }
1663
- * };
1664
- *
1665
- * const req = http.request(options, (res) => {
1666
- * console.log(`STATUS: ${res.statusCode}`);
1667
- * console.log(`HEADERS: ${JSON.stringify(res.headers)}`);
1668
- * res.setEncoding('utf8');
1669
- * res.on('data', (chunk) => {
1670
- * console.log(`BODY: ${chunk}`);
1671
- * });
1672
- * res.on('end', () => {
1673
- * console.log('No more data in response.');
1674
- * });
1675
- * });
1676
- *
1677
- * req.on('error', (e) => {
1678
- * console.error(`problem with request: ${e.message}`);
1679
- * });
1680
- *
1681
- * // Write data to request body
1682
- * req.write(postData);
1683
- * req.end();
1684
- * ```
1685
- *
1686
- * In the example `req.end()` was called. With `http.request()` one
1687
- * must always call `req.end()` to signify the end of the request -
1688
- * even if there is no data being written to the request body.
1689
- *
1690
- * If any error is encountered during the request (be that with DNS resolution,
1691
- * TCP level errors, or actual HTTP parse errors) an `'error'` event is emitted
1692
- * on the returned request object. As with all `'error'` events, if no listeners
1693
- * are registered the error will be thrown.
1694
- *
1695
- * There are a few special headers that should be noted.
1696
- *
1697
- * * Sending a 'Connection: keep-alive' will notify Node.js that the connection to
1698
- * the server should be persisted until the next request.
1699
- * * Sending a 'Content-Length' header will disable the default chunked encoding.
1700
- * * Sending an 'Expect' header will immediately send the request headers.
1701
- * Usually, when sending 'Expect: 100-continue', both a timeout and a listener
1702
- * for the `'continue'` event should be set. See RFC 2616 Section 8.2.3 for more
1703
- * information.
1704
- * * Sending an Authorization header will override using the `auth` option
1705
- * to compute basic authentication.
1706
- *
1707
- * Example using a `URL` as `options`:
1708
- *
1709
- * ```js
1710
- * const options = new URL('http://abc:xyz@example.com');
1711
- *
1712
- * const req = http.request(options, (res) => {
1713
- * // ...
1714
- * });
1715
- * ```
1716
- *
1717
- * In a successful request, the following events will be emitted in the following
1718
- * order:
1719
- *
1720
- * * `'socket'`
1721
- * * `'response'`
1722
- * * `'data'` any number of times, on the `res` object
1723
- * (`'data'` will not be emitted at all if the response body is empty, for
1724
- * instance, in most redirects)
1725
- * * `'end'` on the `res` object
1726
- * * `'close'`
1727
- *
1728
- * In the case of a connection error, the following events will be emitted:
1729
- *
1730
- * * `'socket'`
1731
- * * `'error'`
1732
- * * `'close'`
1733
- *
1734
- * In the case of a premature connection close before the response is received,
1735
- * the following events will be emitted in the following order:
1736
- *
1737
- * * `'socket'`
1738
- * * `'error'` with an error with message `'Error: socket hang up'` and code`'ECONNRESET'`
1739
- * * `'close'`
1740
- *
1741
- * In the case of a premature connection close after the response is received,
1742
- * the following events will be emitted in the following order:
1743
- *
1744
- * * `'socket'`
1745
- * * `'response'`
1746
- * * `'data'` any number of times, on the `res` object
1747
- * * (connection closed here)
1748
- * * `'aborted'` on the `res` object
1749
- * * `'error'` on the `res` object with an error with message`'Error: aborted'` and code `'ECONNRESET'`.
1750
- * * `'close'`
1751
- * * `'close'` on the `res` object
1752
- *
1753
- * If `req.destroy()` is called before a socket is assigned, the following
1754
- * events will be emitted in the following order:
1755
- *
1756
- * * (`req.destroy()` called here)
1757
- * * `'error'` with an error with message `'Error: socket hang up'` and code`'ECONNRESET'`
1758
- * * `'close'`
1759
- *
1760
- * If `req.destroy()` is called before the connection succeeds, the following
1761
- * events will be emitted in the following order:
1762
- *
1763
- * * `'socket'`
1764
- * * (`req.destroy()` called here)
1765
- * * `'error'` with an error with message `'Error: socket hang up'` and code`'ECONNRESET'`
1766
- * * `'close'`
1767
- *
1768
- * If `req.destroy()` is called after the response is received, the following
1769
- * events will be emitted in the following order:
1770
- *
1771
- * * `'socket'`
1772
- * * `'response'`
1773
- * * `'data'` any number of times, on the `res` object
1774
- * * (`req.destroy()` called here)
1775
- * * `'aborted'` on the `res` object
1776
- * * `'error'` on the `res` object with an error with message`'Error: aborted'` and code `'ECONNRESET'`.
1777
- * * `'close'`
1778
- * * `'close'` on the `res` object
1779
- *
1780
- * If `req.abort()` is called before a socket is assigned, the following
1781
- * events will be emitted in the following order:
1782
- *
1783
- * * (`req.abort()` called here)
1784
- * * `'abort'`
1785
- * * `'close'`
1786
- *
1787
- * If `req.abort()` is called before the connection succeeds, the following
1788
- * events will be emitted in the following order:
1789
- *
1790
- * * `'socket'`
1791
- * * (`req.abort()` called here)
1792
- * * `'abort'`
1793
- * * `'error'` with an error with message `'Error: socket hang up'` and code`'ECONNRESET'`
1794
- * * `'close'`
1795
- *
1796
- * If `req.abort()` is called after the response is received, the following
1797
- * events will be emitted in the following order:
1798
- *
1799
- * * `'socket'`
1800
- * * `'response'`
1801
- * * `'data'` any number of times, on the `res` object
1802
- * * (`req.abort()` called here)
1803
- * * `'abort'`
1804
- * * `'aborted'` on the `res` object
1805
- * * `'error'` on the `res` object with an error with message`'Error: aborted'` and code `'ECONNRESET'`.
1806
- * * `'close'`
1807
- * * `'close'` on the `res` object
1808
- *
1809
- * Setting the `timeout` option or using the `setTimeout()` function will
1810
- * not abort the request or do anything besides add a `'timeout'` event.
1811
- *
1812
- * Passing an `AbortSignal` and then calling `abort` on the corresponding`AbortController` will behave the same way as calling `.destroy()` on the
1813
- * request itself.
1814
- * @since v0.3.6
1815
- */
1816
- function request(options: RequestOptions | string | URL, callback?: (res: IncomingMessage) => void): ClientRequest;
1817
- function request(
1818
- url: string | URL,
1819
- options: RequestOptions,
1820
- callback?: (res: IncomingMessage) => void,
1821
- ): ClientRequest;
1822
- /**
1823
- * Since most requests are GET requests without bodies, Node.js provides this
1824
- * convenience method. The only difference between this method and {@link request} is that it sets the method to GET and calls `req.end()`automatically. The callback must take care to consume the
1825
- * response
1826
- * data for reasons stated in {@link ClientRequest} section.
1827
- *
1828
- * The `callback` is invoked with a single argument that is an instance of {@link IncomingMessage}.
1829
- *
1830
- * JSON fetching example:
1831
- *
1832
- * ```js
1833
- * http.get('http://localhost:8000/', (res) => {
1834
- * const { statusCode } = res;
1835
- * const contentType = res.headers['content-type'];
1836
- *
1837
- * let error;
1838
- * // Any 2xx status code signals a successful response but
1839
- * // here we're only checking for 200.
1840
- * if (statusCode !== 200) {
1841
- * error = new Error('Request Failed.\n' +
1842
- * `Status Code: ${statusCode}`);
1843
- * } else if (!/^application\/json/.test(contentType)) {
1844
- * error = new Error('Invalid content-type.\n' +
1845
- * `Expected application/json but received ${contentType}`);
1846
- * }
1847
- * if (error) {
1848
- * console.error(error.message);
1849
- * // Consume response data to free up memory
1850
- * res.resume();
1851
- * return;
1852
- * }
1853
- *
1854
- * res.setEncoding('utf8');
1855
- * let rawData = '';
1856
- * res.on('data', (chunk) => { rawData += chunk; });
1857
- * res.on('end', () => {
1858
- * try {
1859
- * const parsedData = JSON.parse(rawData);
1860
- * console.log(parsedData);
1861
- * } catch (e) {
1862
- * console.error(e.message);
1863
- * }
1864
- * });
1865
- * }).on('error', (e) => {
1866
- * console.error(`Got error: ${e.message}`);
1867
- * });
1868
- *
1869
- * // Create a local server to receive data from
1870
- * const server = http.createServer((req, res) => {
1871
- * res.writeHead(200, { 'Content-Type': 'application/json' });
1872
- * res.end(JSON.stringify({
1873
- * data: 'Hello World!'
1874
- * }));
1875
- * });
1876
- *
1877
- * server.listen(8000);
1878
- * ```
1879
- * @since v0.3.6
1880
- * @param options Accepts the same `options` as {@link request}, with the `method` always set to `GET`. Properties that are inherited from the prototype are ignored.
1881
- */
1882
- function get(options: RequestOptions | string | URL, callback?: (res: IncomingMessage) => void): ClientRequest;
1883
- function get(url: string | URL, options: RequestOptions, callback?: (res: IncomingMessage) => void): ClientRequest;
1884
-
1885
- /**
1886
- * Performs the low-level validations on the provided name that are done when `res.setHeader(name, value)` is called.
1887
- * Passing illegal value as name will result in a TypeError being thrown, identified by `code: 'ERR_INVALID_HTTP_TOKEN'`.
1888
- * @param name Header name
1889
- * @since v14.3.0
1890
- */
1891
- function validateHeaderName(name: string): void;
1892
- /**
1893
- * Performs the low-level validations on the provided value that are done when `res.setHeader(name, value)` is called.
1894
- * Passing illegal value as value will result in a TypeError being thrown.
1895
- * - Undefined value error is identified by `code: 'ERR_HTTP_INVALID_HEADER_VALUE'`.
1896
- * - Invalid value character error is identified by `code: 'ERR_INVALID_CHAR'`.
1897
- * @param name Header name
1898
- * @param value Header value
1899
- * @since v14.3.0
1900
- */
1901
- function validateHeaderValue(name: string, value: string): void;
1902
-
1903
- /**
1904
- * Set the maximum number of idle HTTP parsers. Default: 1000.
1905
- * @param count
1906
- * @since v18.8.0, v16.18.0
1907
- */
1908
- function setMaxIdleHTTPParsers(count: number): void;
1909
-
1910
- let globalAgent: Agent;
1911
- /**
1912
- * Read-only property specifying the maximum allowed size of HTTP headers in bytes.
1913
- * Defaults to 16KB. Configurable using the `--max-http-header-size` CLI option.
1914
- */
1915
- const maxHeaderSize: number;
1916
- }
1917
- declare module "node:http" {
1918
- export * from "http";
1919
- }