@wbce/projen-d9 0.0.27 → 0.1.0

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 (422) hide show
  1. package/.jsii +185 -46
  2. package/API.md +153 -37
  3. package/CHANGELOG.md +20 -0
  4. package/README.md +10 -3
  5. package/docs/D9-plumbing.md +189 -0
  6. package/lib/cli/atlas.d.ts +10 -0
  7. package/lib/cli/atlas.js +65 -0
  8. package/lib/cli/commands/cedar/cedar-format.d.ts +7 -0
  9. package/lib/cli/commands/cedar/cedar-format.js +75 -0
  10. package/lib/cli/commands/cedar/cedar-to-d9-translations.d.ts +12 -0
  11. package/lib/cli/commands/cedar/cedar-to-d9-translations.js +130 -0
  12. package/lib/cli/commands/cedar/cedar-to-d9.d.ts +57 -0
  13. package/lib/cli/commands/cedar/cedar-to-d9.js +221 -0
  14. package/lib/cli/commands/cedar/cedar-translations.d.ts +9 -0
  15. package/lib/cli/commands/cedar/cedar-translations.js +213 -0
  16. package/lib/cli/commands/cedar/d9-permission.d.ts +27 -0
  17. package/lib/cli/commands/cedar/d9-permission.js +45 -0
  18. package/lib/cli/commands/cedar/d9-to-cedar.d.ts +33 -0
  19. package/lib/cli/commands/cedar/d9-to-cedar.js +157 -0
  20. package/lib/cli/commands/cedar/roles-table.d.ts +14 -0
  21. package/lib/cli/commands/cedar/roles-table.js +29 -0
  22. package/lib/cli/commands/save/apply-snapshot.js +39 -30
  23. package/lib/cli/commands/save/check-unsaved.d.ts +9 -0
  24. package/lib/cli/commands/save/check-unsaved.js +81 -0
  25. package/lib/cli/commands/save/env.d.ts +33 -0
  26. package/lib/cli/commands/save/env.js +109 -0
  27. package/lib/cli/commands/save/save-snapshot.d.ts +9 -0
  28. package/lib/cli/commands/save/save-snapshot.js +232 -0
  29. package/lib/cli/commands/save/sync-files.d.ts +5 -0
  30. package/lib/cli/commands/save/sync-files.js +46 -0
  31. package/lib/cli/commands/save/transfer.d.ts +18 -0
  32. package/lib/cli/commands/save/transfer.js +96 -0
  33. package/lib/cli/commands/save/utils.d.ts +5 -0
  34. package/lib/cli/commands/save/utils.js +33 -3
  35. package/lib/cli/commands/sync.js +4 -3
  36. package/lib/cli/index.js +65 -25
  37. package/lib/cli/logger.d.ts +2 -0
  38. package/lib/cli/logger.js +10 -0
  39. package/lib/cli/plumbing-config.d.ts +11 -0
  40. package/lib/cli/plumbing-config.js +13 -0
  41. package/lib/index.d.ts +44 -5
  42. package/lib/index.js +54 -41
  43. package/node_modules/@cedar-policy/cedar-wasm/README.md +181 -0
  44. package/node_modules/@cedar-policy/cedar-wasm/esm/README.md +181 -0
  45. package/node_modules/@cedar-policy/cedar-wasm/esm/cedar_wasm.d.ts +427 -0
  46. package/node_modules/@cedar-policy/cedar-wasm/esm/cedar_wasm.js +9 -0
  47. package/node_modules/@cedar-policy/cedar-wasm/esm/cedar_wasm_bg.js +434 -0
  48. package/node_modules/@cedar-policy/cedar-wasm/esm/cedar_wasm_bg.wasm +0 -0
  49. package/node_modules/@cedar-policy/cedar-wasm/esm/cedar_wasm_bg.wasm.d.ts +34 -0
  50. package/node_modules/@cedar-policy/cedar-wasm/esm/package.json +23 -0
  51. package/node_modules/@cedar-policy/cedar-wasm/nodejs/README.md +181 -0
  52. package/node_modules/@cedar-policy/cedar-wasm/nodejs/cedar_wasm.d.ts +427 -0
  53. package/node_modules/@cedar-policy/cedar-wasm/nodejs/cedar_wasm.js +463 -0
  54. package/node_modules/@cedar-policy/cedar-wasm/nodejs/cedar_wasm_bg.wasm +0 -0
  55. package/node_modules/@cedar-policy/cedar-wasm/nodejs/cedar_wasm_bg.wasm.d.ts +34 -0
  56. package/node_modules/@cedar-policy/cedar-wasm/nodejs/package.json +18 -0
  57. package/node_modules/@cedar-policy/cedar-wasm/package.json +53 -0
  58. package/node_modules/@cedar-policy/cedar-wasm/web/README.md +181 -0
  59. package/node_modules/@cedar-policy/cedar-wasm/web/cedar_wasm.d.ts +486 -0
  60. package/node_modules/@cedar-policy/cedar-wasm/web/cedar_wasm.js +534 -0
  61. package/node_modules/@cedar-policy/cedar-wasm/web/cedar_wasm_bg.wasm +0 -0
  62. package/node_modules/@cedar-policy/cedar-wasm/web/cedar_wasm_bg.wasm.d.ts +34 -0
  63. package/node_modules/@cedar-policy/cedar-wasm/web/package.json +21 -0
  64. package/node_modules/@types/node/README.md +5 -6
  65. package/node_modules/@types/node/assert/strict.d.ts +111 -0
  66. package/node_modules/@types/node/assert.d.ts +1040 -79
  67. package/node_modules/@types/node/async_hooks.d.ts +476 -119
  68. package/node_modules/@types/node/buffer.buffer.d.ts +472 -0
  69. package/node_modules/@types/node/buffer.d.ts +1925 -13
  70. package/node_modules/@types/node/child_process.d.ts +1204 -235
  71. package/node_modules/@types/node/cluster.d.ts +455 -137
  72. package/node_modules/@types/node/compatibility/disposable.d.ts +14 -0
  73. package/node_modules/@types/node/compatibility/index.d.ts +9 -0
  74. package/node_modules/@types/node/compatibility/indexable.d.ts +20 -0
  75. package/node_modules/@types/node/compatibility/iterators.d.ts +20 -0
  76. package/node_modules/@types/node/console.d.ts +450 -1
  77. package/node_modules/@types/node/constants.d.ts +20 -447
  78. package/node_modules/@types/node/crypto.d.ts +3962 -600
  79. package/node_modules/@types/node/dgram.d.ts +515 -33
  80. package/node_modules/@types/node/diagnostics_channel.d.ts +578 -0
  81. package/node_modules/@types/node/dns/promises.d.ts +503 -0
  82. package/node_modules/@types/node/dns.d.ts +798 -247
  83. package/node_modules/@types/node/domain.d.ts +164 -10
  84. package/node_modules/@types/node/events.d.ts +954 -25
  85. package/node_modules/@types/node/fs/promises.d.ts +1295 -0
  86. package/node_modules/@types/node/fs.d.ts +3463 -1569
  87. package/node_modules/@types/node/globals.d.ts +98 -1277
  88. package/node_modules/@types/node/globals.typedarray.d.ts +38 -0
  89. package/node_modules/@types/node/http.d.ts +1933 -300
  90. package/node_modules/@types/node/http2.d.ts +1946 -254
  91. package/node_modules/@types/node/https.d.ts +557 -134
  92. package/node_modules/@types/node/index.d.ts +54 -48
  93. package/node_modules/@types/node/inspector.d.ts +227 -3014
  94. package/node_modules/@types/node/inspector.generated.d.ts +4052 -0
  95. package/node_modules/@types/node/module.d.ts +890 -2
  96. package/node_modules/@types/node/net.d.ts +872 -105
  97. package/node_modules/@types/node/os.d.ts +452 -209
  98. package/node_modules/@types/node/package.json +78 -128
  99. package/node_modules/@types/node/path.d.ts +196 -155
  100. package/node_modules/@types/node/perf_hooks.d.ts +829 -120
  101. package/node_modules/@types/node/process.d.ts +2072 -3
  102. package/node_modules/@types/node/punycode.d.ts +69 -27
  103. package/node_modules/@types/node/querystring.d.ts +132 -9
  104. package/node_modules/@types/node/readline/promises.d.ts +161 -0
  105. package/node_modules/@types/node/readline.d.ts +485 -49
  106. package/node_modules/@types/node/repl.d.ts +121 -83
  107. package/node_modules/@types/node/sea.d.ts +153 -0
  108. package/node_modules/@types/node/sqlite.d.ts +721 -0
  109. package/node_modules/@types/node/stream/consumers.d.ts +38 -0
  110. package/node_modules/@types/node/stream/promises.d.ts +90 -0
  111. package/node_modules/@types/node/stream/web.d.ts +622 -0
  112. package/node_modules/@types/node/stream.d.ts +1470 -140
  113. package/node_modules/@types/node/string_decoder.d.ts +64 -4
  114. package/node_modules/@types/node/test.d.ts +2163 -0
  115. package/node_modules/@types/node/timers/promises.d.ts +108 -0
  116. package/node_modules/@types/node/timers.d.ts +284 -13
  117. package/node_modules/@types/node/tls.d.ts +850 -244
  118. package/node_modules/@types/node/trace_events.d.ts +147 -11
  119. package/node_modules/@types/node/ts5.6/buffer.buffer.d.ts +468 -0
  120. package/node_modules/@types/node/ts5.6/globals.typedarray.d.ts +34 -0
  121. package/node_modules/@types/node/ts5.6/index.d.ts +97 -0
  122. package/node_modules/@types/node/tty.d.ts +160 -18
  123. package/node_modules/@types/node/url.d.ts +890 -53
  124. package/node_modules/@types/node/util.d.ts +2566 -160
  125. package/node_modules/@types/node/v8.d.ts +806 -83
  126. package/node_modules/@types/node/vm.d.ts +932 -44
  127. package/node_modules/@types/node/wasi.d.ts +148 -22
  128. package/node_modules/@types/node/web-globals/abortcontroller.d.ts +34 -0
  129. package/node_modules/@types/node/web-globals/domexception.d.ts +68 -0
  130. package/node_modules/@types/node/web-globals/events.d.ts +97 -0
  131. package/node_modules/@types/node/web-globals/fetch.d.ts +55 -0
  132. package/node_modules/@types/node/web-globals/navigator.d.ts +22 -0
  133. package/node_modules/@types/node/web-globals/storage.d.ts +24 -0
  134. package/node_modules/@types/node/worker_threads.d.ts +657 -80
  135. package/node_modules/@types/node/zlib.d.ts +510 -119
  136. package/node_modules/pino/.prettierignore +1 -0
  137. package/node_modules/pino/CNAME +1 -0
  138. package/node_modules/pino/CONTRIBUTING.md +34 -0
  139. package/node_modules/pino/LICENSE +21 -0
  140. package/node_modules/pino/README.md +177 -0
  141. package/node_modules/pino/SECURITY.md +103 -0
  142. package/node_modules/pino/benchmarks/basic.bench.js +95 -0
  143. package/node_modules/pino/benchmarks/child-child.bench.js +52 -0
  144. package/node_modules/pino/benchmarks/child-creation.bench.js +73 -0
  145. package/node_modules/pino/benchmarks/child.bench.js +62 -0
  146. package/node_modules/pino/benchmarks/deep-object.bench.js +88 -0
  147. package/node_modules/pino/benchmarks/formatters.bench.js +50 -0
  148. package/node_modules/pino/benchmarks/internal/custom-levels.js +67 -0
  149. package/node_modules/pino/benchmarks/internal/just-pino-heavy.bench.js +76 -0
  150. package/node_modules/pino/benchmarks/internal/just-pino.bench.js +182 -0
  151. package/node_modules/pino/benchmarks/internal/parent-vs-child.bench.js +75 -0
  152. package/node_modules/pino/benchmarks/internal/redact.bench.js +86 -0
  153. package/node_modules/pino/benchmarks/long-string.bench.js +81 -0
  154. package/node_modules/pino/benchmarks/multi-arg.bench.js +193 -0
  155. package/node_modules/pino/benchmarks/multistream.js +98 -0
  156. package/node_modules/pino/benchmarks/object.bench.js +82 -0
  157. package/node_modules/pino/benchmarks/utils/generate-benchmark-doc.js +36 -0
  158. package/node_modules/pino/benchmarks/utils/runbench.js +138 -0
  159. package/node_modules/pino/benchmarks/utils/wrap-log-level.js +55 -0
  160. package/node_modules/pino/bin.js +6 -0
  161. package/node_modules/pino/browser.js +607 -0
  162. package/node_modules/pino/build/sync-version.js +25 -0
  163. package/node_modules/pino/docs/api.md +1664 -0
  164. package/node_modules/pino/docs/asynchronous.md +55 -0
  165. package/node_modules/pino/docs/benchmarks.md +55 -0
  166. package/node_modules/pino/docs/browser.md +341 -0
  167. package/node_modules/pino/docs/bundling.md +40 -0
  168. package/node_modules/pino/docs/child-loggers.md +116 -0
  169. package/node_modules/pino/docs/diagnostics.md +16 -0
  170. package/node_modules/pino/docs/ecosystem.md +87 -0
  171. package/node_modules/pino/docs/help.md +353 -0
  172. package/node_modules/pino/docs/lts.md +93 -0
  173. package/node_modules/pino/docs/pretty.md +38 -0
  174. package/node_modules/pino/docs/redaction.md +130 -0
  175. package/node_modules/pino/docs/transports.md +1447 -0
  176. package/node_modules/pino/docs/web.md +306 -0
  177. package/node_modules/pino/eslint.config.js +36 -0
  178. package/node_modules/pino/examples/basic.js +43 -0
  179. package/node_modules/pino/examples/transport.js +68 -0
  180. package/node_modules/pino/favicon.ico +0 -0
  181. package/node_modules/pino/file.js +12 -0
  182. package/node_modules/pino/inc-version.sh +42 -0
  183. package/node_modules/pino/index.html +55 -0
  184. package/node_modules/pino/lib/caller.js +40 -0
  185. package/node_modules/pino/lib/constants.js +28 -0
  186. package/node_modules/pino/lib/deprecations.js +8 -0
  187. package/node_modules/pino/lib/levels.js +241 -0
  188. package/node_modules/pino/lib/meta.js +3 -0
  189. package/node_modules/pino/lib/multistream.js +211 -0
  190. package/node_modules/pino/lib/proto.js +256 -0
  191. package/node_modules/pino/lib/redaction.js +119 -0
  192. package/node_modules/pino/lib/symbols.js +76 -0
  193. package/node_modules/pino/lib/time.js +39 -0
  194. package/node_modules/pino/lib/tools.js +427 -0
  195. package/node_modules/pino/lib/transport-stream.js +56 -0
  196. package/node_modules/pino/lib/transport.js +302 -0
  197. package/node_modules/pino/lib/worker.js +197 -0
  198. package/node_modules/pino/package.json +112 -0
  199. package/node_modules/pino/pino.d.ts +881 -0
  200. package/node_modules/pino/pino.js +259 -0
  201. package/node_modules/pino/test/basic.test.js +952 -0
  202. package/node_modules/pino/test/broken-pipe.test.js +59 -0
  203. package/node_modules/pino/test/browser-bindings.test.js +114 -0
  204. package/node_modules/pino/test/browser-child.test.js +132 -0
  205. package/node_modules/pino/test/browser-disabled.test.js +87 -0
  206. package/node_modules/pino/test/browser-early-console-freeze.test.js +12 -0
  207. package/node_modules/pino/test/browser-is-level-enabled.test.js +101 -0
  208. package/node_modules/pino/test/browser-levels.test.js +241 -0
  209. package/node_modules/pino/test/browser-redaction.test.js +264 -0
  210. package/node_modules/pino/test/browser-serializers.test.js +352 -0
  211. package/node_modules/pino/test/browser-set-bindings.test.js +99 -0
  212. package/node_modules/pino/test/browser-timestamp.test.js +88 -0
  213. package/node_modules/pino/test/browser-transmit.test.js +417 -0
  214. package/node_modules/pino/test/browser.test.js +698 -0
  215. package/node_modules/pino/test/caller.test.js +20 -0
  216. package/node_modules/pino/test/complex-objects.test.js +36 -0
  217. package/node_modules/pino/test/crlf.test.js +34 -0
  218. package/node_modules/pino/test/custom-levels.test.js +267 -0
  219. package/node_modules/pino/test/diagnostics.test.js +107 -0
  220. package/node_modules/pino/test/error-key.test.js +37 -0
  221. package/node_modules/pino/test/error.test.js +403 -0
  222. package/node_modules/pino/test/escaping.test.js +110 -0
  223. package/node_modules/pino/test/esm/esm.mjs +14 -0
  224. package/node_modules/pino/test/esm/index.test.js +21 -0
  225. package/node_modules/pino/test/esm/named-exports.mjs +29 -0
  226. package/node_modules/pino/test/exit.test.js +79 -0
  227. package/node_modules/pino/test/fixtures/broken-pipe/basic.js +9 -0
  228. package/node_modules/pino/test/fixtures/broken-pipe/destination.js +10 -0
  229. package/node_modules/pino/test/fixtures/broken-pipe/syncfalse.js +12 -0
  230. package/node_modules/pino/test/fixtures/caller-loop.js +6 -0
  231. package/node_modules/pino/test/fixtures/console-transport.js +13 -0
  232. package/node_modules/pino/test/fixtures/crashing-transport.js +13 -0
  233. package/node_modules/pino/test/fixtures/default-exit.js +8 -0
  234. package/node_modules/pino/test/fixtures/destination-exit.js +8 -0
  235. package/node_modules/pino/test/fixtures/eval/index.js +13 -0
  236. package/node_modules/pino/test/fixtures/eval/node_modules/14-files.js +3 -0
  237. package/node_modules/pino/test/fixtures/eval/node_modules/2-files.js +3 -0
  238. package/node_modules/pino/test/fixtures/eval/node_modules/file1.js +5 -0
  239. package/node_modules/pino/test/fixtures/eval/node_modules/file10.js +5 -0
  240. package/node_modules/pino/test/fixtures/eval/node_modules/file11.js +5 -0
  241. package/node_modules/pino/test/fixtures/eval/node_modules/file12.js +5 -0
  242. package/node_modules/pino/test/fixtures/eval/node_modules/file13.js +5 -0
  243. package/node_modules/pino/test/fixtures/eval/node_modules/file14.js +11 -0
  244. package/node_modules/pino/test/fixtures/eval/node_modules/file2.js +5 -0
  245. package/node_modules/pino/test/fixtures/eval/node_modules/file3.js +5 -0
  246. package/node_modules/pino/test/fixtures/eval/node_modules/file4.js +5 -0
  247. package/node_modules/pino/test/fixtures/eval/node_modules/file5.js +5 -0
  248. package/node_modules/pino/test/fixtures/eval/node_modules/file6.js +5 -0
  249. package/node_modules/pino/test/fixtures/eval/node_modules/file7.js +5 -0
  250. package/node_modules/pino/test/fixtures/eval/node_modules/file8.js +5 -0
  251. package/node_modules/pino/test/fixtures/eval/node_modules/file9.js +5 -0
  252. package/node_modules/pino/test/fixtures/noop-transport.js +10 -0
  253. package/node_modules/pino/test/fixtures/pretty/null-prototype.js +8 -0
  254. package/node_modules/pino/test/fixtures/stdout-hack-protection.js +11 -0
  255. package/node_modules/pino/test/fixtures/syncfalse-child.js +6 -0
  256. package/node_modules/pino/test/fixtures/syncfalse-exit.js +9 -0
  257. package/node_modules/pino/test/fixtures/syncfalse-flush-exit.js +10 -0
  258. package/node_modules/pino/test/fixtures/syncfalse.js +6 -0
  259. package/node_modules/pino/test/fixtures/syntax-error-esm.mjs +2 -0
  260. package/node_modules/pino/test/fixtures/to-file-transport-with-transform.js +20 -0
  261. package/node_modules/pino/test/fixtures/to-file-transport.js +13 -0
  262. package/node_modules/pino/test/fixtures/to-file-transport.mjs +8 -0
  263. package/node_modules/pino/test/fixtures/transport/index.js +12 -0
  264. package/node_modules/pino/test/fixtures/transport/package.json +5 -0
  265. package/node_modules/pino/test/fixtures/transport-exit-immediately-with-async-dest.js +16 -0
  266. package/node_modules/pino/test/fixtures/transport-exit-immediately.js +11 -0
  267. package/node_modules/pino/test/fixtures/transport-exit-on-ready.js +12 -0
  268. package/node_modules/pino/test/fixtures/transport-invalid-node-options.js +26 -0
  269. package/node_modules/pino/test/fixtures/transport-main.js +9 -0
  270. package/node_modules/pino/test/fixtures/transport-many-lines.js +29 -0
  271. package/node_modules/pino/test/fixtures/transport-preload-main.mjs +13 -0
  272. package/node_modules/pino/test/fixtures/transport-preload.mjs +13 -0
  273. package/node_modules/pino/test/fixtures/transport-string-stdout.js +9 -0
  274. package/node_modules/pino/test/fixtures/transport-transform.js +21 -0
  275. package/node_modules/pino/test/fixtures/transport-uses-pino-config.js +33 -0
  276. package/node_modules/pino/test/fixtures/transport-with-on-exit.js +12 -0
  277. package/node_modules/pino/test/fixtures/transport-worker-data.js +19 -0
  278. package/node_modules/pino/test/fixtures/transport-worker-name.js +24 -0
  279. package/node_modules/pino/test/fixtures/transport-worker.js +15 -0
  280. package/node_modules/pino/test/fixtures/transport-wrong-export-type.js +3 -0
  281. package/node_modules/pino/test/fixtures/ts/to-file-transport-native.mts +15 -0
  282. package/node_modules/pino/test/fixtures/ts/to-file-transport-with-transform.ts +18 -0
  283. package/node_modules/pino/test/fixtures/ts/to-file-transport.ts +11 -0
  284. package/node_modules/pino/test/fixtures/ts/transpile.cjs +36 -0
  285. package/node_modules/pino/test/fixtures/ts/transport-exit-immediately-with-async-dest.ts +15 -0
  286. package/node_modules/pino/test/fixtures/ts/transport-exit-immediately.ts +10 -0
  287. package/node_modules/pino/test/fixtures/ts/transport-exit-on-ready.ts +11 -0
  288. package/node_modules/pino/test/fixtures/ts/transport-main.ts +8 -0
  289. package/node_modules/pino/test/fixtures/ts/transport-string-stdout.ts +8 -0
  290. package/node_modules/pino/test/fixtures/ts/transport-worker.ts +14 -0
  291. package/node_modules/pino/test/formatters.test.js +364 -0
  292. package/node_modules/pino/test/helper.d.ts +4 -0
  293. package/node_modules/pino/test/helper.js +159 -0
  294. package/node_modules/pino/test/hooks.test.js +114 -0
  295. package/node_modules/pino/test/http.test.js +214 -0
  296. package/node_modules/pino/test/internals/version.test.js +17 -0
  297. package/node_modules/pino/test/is-level-enabled.test.js +179 -0
  298. package/node_modules/pino/test/jest/basic.spec.js +10 -0
  299. package/node_modules/pino/test/levels.test.js +810 -0
  300. package/node_modules/pino/test/metadata.test.js +120 -0
  301. package/node_modules/pino/test/mixin-merge-strategy.test.js +57 -0
  302. package/node_modules/pino/test/mixin.test.js +241 -0
  303. package/node_modules/pino/test/multistream.test.js +793 -0
  304. package/node_modules/pino/test/redact.test.js +923 -0
  305. package/node_modules/pino/test/serializers.test.js +257 -0
  306. package/node_modules/pino/test/smoke.js +59 -0
  307. package/node_modules/pino/test/stdout-protection.test.js +41 -0
  308. package/node_modules/pino/test/syncfalse.test.js +186 -0
  309. package/node_modules/pino/test/timestamp-nano.test.js +37 -0
  310. package/node_modules/pino/test/timestamp.test.js +124 -0
  311. package/node_modules/pino/test/transport/big.test.js +42 -0
  312. package/node_modules/pino/test/transport/bundlers-support.test.js +99 -0
  313. package/node_modules/pino/test/transport/caller.test.js +24 -0
  314. package/node_modules/pino/test/transport/core.test.js +818 -0
  315. package/node_modules/pino/test/transport/core.transpiled.test.ts +114 -0
  316. package/node_modules/pino/test/transport/crash.test.js +36 -0
  317. package/node_modules/pino/test/transport/module-link.test.js +241 -0
  318. package/node_modules/pino/test/transport/native-type-stripping.test.mjs +151 -0
  319. package/node_modules/pino/test/transport/node-options.test.js +116 -0
  320. package/node_modules/pino/test/transport/pipeline.test.js +137 -0
  321. package/node_modules/pino/test/transport/preload.test.js +54 -0
  322. package/node_modules/pino/test/transport/repl.test.js +15 -0
  323. package/node_modules/pino/test/transport/sync-false.test.js +79 -0
  324. package/node_modules/pino/test/transport/sync-true.test.js +57 -0
  325. package/node_modules/pino/test/transport/targets.test.js +48 -0
  326. package/node_modules/pino/test/transport/uses-pino-config.test.js +166 -0
  327. package/node_modules/pino/test/transport-stream.test.js +40 -0
  328. package/node_modules/pino/test/types/pino-import.tst.cts +30 -0
  329. package/node_modules/pino/test/types/pino-import.tst.js +73 -0
  330. package/node_modules/pino/test/types/pino-multistream.tst.ts +49 -0
  331. package/node_modules/pino/test/types/pino-top-export.tst.ts +32 -0
  332. package/node_modules/pino/test/types/pino-transport.tst.ts +171 -0
  333. package/node_modules/pino/test/types/pino-type-only.tst.ts +77 -0
  334. package/node_modules/pino/test/types/pino.ts +98 -0
  335. package/node_modules/pino/test/types/pino.tst.ts +681 -0
  336. package/node_modules/pino/test/types/tsconfig.json +10 -0
  337. package/node_modules/pino/tsconfig.json +14 -0
  338. package/node_modules/pino-pretty/.borp.yaml +6 -0
  339. package/node_modules/pino-pretty/.editorconfig +13 -0
  340. package/node_modules/pino-pretty/.github/dependabot.yml +13 -0
  341. package/node_modules/pino-pretty/.github/workflows/ci.yml +83 -0
  342. package/node_modules/pino-pretty/LICENSE +21 -0
  343. package/node_modules/pino-pretty/Readme.md +425 -0
  344. package/node_modules/pino-pretty/SECURITY.md +146 -0
  345. package/node_modules/pino-pretty/benchmark.js +105 -0
  346. package/node_modules/pino-pretty/bin.js +113 -0
  347. package/node_modules/pino-pretty/demo.png +0 -0
  348. package/node_modules/pino-pretty/docs/help.md +24 -0
  349. package/node_modules/pino-pretty/eslint.config.js +5 -0
  350. package/node_modules/pino-pretty/help/help.txt +68 -0
  351. package/node_modules/pino-pretty/index.d.ts +227 -0
  352. package/node_modules/pino-pretty/index.js +234 -0
  353. package/node_modules/pino-pretty/lib/colors.js +134 -0
  354. package/node_modules/pino-pretty/lib/colors.test.js +132 -0
  355. package/node_modules/pino-pretty/lib/constants.js +55 -0
  356. package/node_modules/pino-pretty/lib/pretty.js +171 -0
  357. package/node_modules/pino-pretty/lib/utils/build-safe-sonic-boom.js +69 -0
  358. package/node_modules/pino-pretty/lib/utils/build-safe-sonic-boom.test.js +84 -0
  359. package/node_modules/pino-pretty/lib/utils/create-date.js +26 -0
  360. package/node_modules/pino-pretty/lib/utils/create-date.test.js +20 -0
  361. package/node_modules/pino-pretty/lib/utils/delete-log-property.js +28 -0
  362. package/node_modules/pino-pretty/lib/utils/delete-log-property.test.js +31 -0
  363. package/node_modules/pino-pretty/lib/utils/filter-log.js +99 -0
  364. package/node_modules/pino-pretty/lib/utils/filter-log.test.js +265 -0
  365. package/node_modules/pino-pretty/lib/utils/format-time.js +66 -0
  366. package/node_modules/pino-pretty/lib/utils/format-time.test.js +71 -0
  367. package/node_modules/pino-pretty/lib/utils/get-level-label-data.js +29 -0
  368. package/node_modules/pino-pretty/lib/utils/get-property-value.js +30 -0
  369. package/node_modules/pino-pretty/lib/utils/get-property-value.test.js +31 -0
  370. package/node_modules/pino-pretty/lib/utils/handle-custom-levels-names-opts.js +38 -0
  371. package/node_modules/pino-pretty/lib/utils/handle-custom-levels-names-opts.test.js +45 -0
  372. package/node_modules/pino-pretty/lib/utils/handle-custom-levels-opts.js +39 -0
  373. package/node_modules/pino-pretty/lib/utils/handle-custom-levels-opts.test.js +47 -0
  374. package/node_modules/pino-pretty/lib/utils/index.js +108 -0
  375. package/node_modules/pino-pretty/lib/utils/index.test.js +37 -0
  376. package/node_modules/pino-pretty/lib/utils/interpret-conditionals.js +41 -0
  377. package/node_modules/pino-pretty/lib/utils/interpret-conditionals.test.js +84 -0
  378. package/node_modules/pino-pretty/lib/utils/is-object.js +7 -0
  379. package/node_modules/pino-pretty/lib/utils/is-object.test.js +10 -0
  380. package/node_modules/pino-pretty/lib/utils/is-valid-date.js +14 -0
  381. package/node_modules/pino-pretty/lib/utils/is-valid-date.test.js +16 -0
  382. package/node_modules/pino-pretty/lib/utils/join-lines-with-indentation.js +29 -0
  383. package/node_modules/pino-pretty/lib/utils/join-lines-with-indentation.test.js +16 -0
  384. package/node_modules/pino-pretty/lib/utils/noop.js +3 -0
  385. package/node_modules/pino-pretty/lib/utils/noop.test.js +12 -0
  386. package/node_modules/pino-pretty/lib/utils/parse-factory-options.js +171 -0
  387. package/node_modules/pino-pretty/lib/utils/prettify-error-log.js +76 -0
  388. package/node_modules/pino-pretty/lib/utils/prettify-error-log.test.js +143 -0
  389. package/node_modules/pino-pretty/lib/utils/prettify-error.js +54 -0
  390. package/node_modules/pino-pretty/lib/utils/prettify-error.test.js +25 -0
  391. package/node_modules/pino-pretty/lib/utils/prettify-level.js +41 -0
  392. package/node_modules/pino-pretty/lib/utils/prettify-level.test.js +70 -0
  393. package/node_modules/pino-pretty/lib/utils/prettify-message.js +65 -0
  394. package/node_modules/pino-pretty/lib/utils/prettify-message.test.js +287 -0
  395. package/node_modules/pino-pretty/lib/utils/prettify-metadata.js +75 -0
  396. package/node_modules/pino-pretty/lib/utils/prettify-metadata.test.js +170 -0
  397. package/node_modules/pino-pretty/lib/utils/prettify-object.js +115 -0
  398. package/node_modules/pino-pretty/lib/utils/prettify-object.test.js +217 -0
  399. package/node_modules/pino-pretty/lib/utils/prettify-time.js +43 -0
  400. package/node_modules/pino-pretty/lib/utils/prettify-time.test.js +264 -0
  401. package/node_modules/pino-pretty/lib/utils/split-property-key.js +49 -0
  402. package/node_modules/pino-pretty/lib/utils/split-property-key.test.js +29 -0
  403. package/node_modules/pino-pretty/lib/utils/strip-unsafe-control-chars.js +18 -0
  404. package/node_modules/pino-pretty/lib/utils/strip-unsafe-control-chars.test.js +9 -0
  405. package/node_modules/pino-pretty/package.json +64 -0
  406. package/node_modules/pino-pretty/test/basic.test.js +1305 -0
  407. package/node_modules/pino-pretty/test/boolean-options.test.js +228 -0
  408. package/node_modules/pino-pretty/test/cli-rc.test.js +275 -0
  409. package/node_modules/pino-pretty/test/cli.test.js +360 -0
  410. package/node_modules/pino-pretty/test/crlf.test.js +33 -0
  411. package/node_modules/pino-pretty/test/error-objects.test.js +494 -0
  412. package/node_modules/pino-pretty/test/example/example.js +33 -0
  413. package/node_modules/pino-pretty/test/helper.js +19 -0
  414. package/node_modules/pino-pretty/test/types/exports.tst.ts +15 -0
  415. package/node_modules/pino-pretty/test/types/pino-pretty.tst.ts +140 -0
  416. package/node_modules/pino-pretty/test/types/tsconfig.json +9 -0
  417. package/package.json +14 -7
  418. package/lib/cli/commands/init.d.ts +0 -1
  419. package/lib/cli/commands/init.js +0 -8
  420. package/lib/cli/commands/save/draft.js +0 -2
  421. package/node_modules/@types/node/globals.global.d.ts +0 -1
  422. /package/{lib/cli/commands/save/draft.d.ts → node_modules/pino/.nojekyll} +0 -0
@@ -1,47 +1,53 @@
1
- declare module 'net' {
2
- import * as stream from 'stream';
3
- import EventEmitter = require('events');
4
- import * as dns from 'dns';
5
-
1
+ /**
2
+ * > Stability: 2 - Stable
3
+ *
4
+ * The `node:net` module provides an asynchronous network API for creating stream-based
5
+ * TCP or `IPC` servers ({@link createServer}) and clients
6
+ * ({@link createConnection}).
7
+ *
8
+ * It can be accessed using:
9
+ *
10
+ * ```js
11
+ * import net from 'node:net';
12
+ * ```
13
+ * @see [source](https://github.com/nodejs/node/blob/v22.x/lib/net.js)
14
+ */
15
+ declare module "net" {
16
+ import { NonSharedBuffer } from "node:buffer";
17
+ import * as stream from "node:stream";
18
+ import { Abortable, EventEmitter } from "node:events";
19
+ import * as dns from "node:dns";
6
20
  type LookupFunction = (
7
21
  hostname: string,
8
- options: dns.LookupOneOptions,
9
- callback: (err: NodeJS.ErrnoException | null, address: string, family: number) => void,
22
+ options: dns.LookupOptions,
23
+ callback: (err: NodeJS.ErrnoException | null, address: string | dns.LookupAddress[], family?: number) => void,
10
24
  ) => void;
11
-
12
25
  interface AddressInfo {
13
26
  address: string;
14
27
  family: string;
15
28
  port: number;
16
29
  }
17
-
18
30
  interface SocketConstructorOpts {
19
31
  fd?: number | undefined;
20
32
  allowHalfOpen?: boolean | undefined;
33
+ onread?: OnReadOpts | undefined;
21
34
  readable?: boolean | undefined;
22
35
  writable?: boolean | undefined;
36
+ signal?: AbortSignal | undefined;
23
37
  }
24
-
25
38
  interface OnReadOpts {
26
39
  buffer: Uint8Array | (() => Uint8Array);
27
40
  /**
28
41
  * This function is called for every chunk of incoming data.
29
- * Two arguments are passed to it: the number of bytes written to buffer and a reference to buffer.
30
- * Return false from this function to implicitly pause() the socket.
42
+ * Two arguments are passed to it: the number of bytes written to `buffer` and a reference to `buffer`.
43
+ * Return `false` from this function to implicitly `pause()` the socket.
31
44
  */
32
- callback(bytesWritten: number, buf: Uint8Array): boolean;
33
- }
34
-
35
- interface ConnectOpts {
36
- /**
37
- * If specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket.
38
- * Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will
39
- * still be emitted as normal and methods like pause() and resume() will also behave as expected.
40
- */
41
- onread?: OnReadOpts | undefined;
45
+ callback(bytesWritten: number, buffer: Uint8Array): boolean;
42
46
  }
43
-
44
- interface TcpSocketConnectOpts extends ConnectOpts {
47
+ // TODO: remove empty ConnectOpts placeholder at next major @types/node version.
48
+ /** @deprecated */
49
+ interface ConnectOpts {}
50
+ interface TcpSocketConnectOpts {
45
51
  port: number;
46
52
  host?: string | undefined;
47
53
  localAddress?: string | undefined;
@@ -49,161 +55,560 @@ declare module 'net' {
49
55
  hints?: number | undefined;
50
56
  family?: number | undefined;
51
57
  lookup?: LookupFunction | undefined;
58
+ noDelay?: boolean | undefined;
59
+ keepAlive?: boolean | undefined;
60
+ keepAliveInitialDelay?: number | undefined;
61
+ /**
62
+ * @since v18.13.0
63
+ */
64
+ autoSelectFamily?: boolean | undefined;
65
+ /**
66
+ * @since v18.13.0
67
+ */
68
+ autoSelectFamilyAttemptTimeout?: number | undefined;
69
+ blockList?: BlockList | undefined;
52
70
  }
53
-
54
- interface IpcSocketConnectOpts extends ConnectOpts {
71
+ interface IpcSocketConnectOpts {
55
72
  path: string;
56
73
  }
57
-
58
74
  type SocketConnectOpts = TcpSocketConnectOpts | IpcSocketConnectOpts;
59
- type SocketReadyState = 'opening' | 'open' | 'readOnly' | 'writeOnly' | 'closed';
60
-
75
+ type SocketReadyState = "opening" | "open" | "readOnly" | "writeOnly" | "closed";
76
+ /**
77
+ * This class is an abstraction of a TCP socket or a streaming `IPC` endpoint
78
+ * (uses named pipes on Windows, and Unix domain sockets otherwise). It is also
79
+ * an `EventEmitter`.
80
+ *
81
+ * A `net.Socket` can be created by the user and used directly to interact with
82
+ * a server. For example, it is returned by {@link createConnection},
83
+ * so the user can use it to talk to the server.
84
+ *
85
+ * It can also be created by Node.js and passed to the user when a connection
86
+ * is received. For example, it is passed to the listeners of a `'connection'` event emitted on a {@link Server}, so the user can use
87
+ * it to interact with the client.
88
+ * @since v0.3.4
89
+ */
61
90
  class Socket extends stream.Duplex {
62
91
  constructor(options?: SocketConstructorOpts);
63
-
64
- // Extended base methods
65
- write(buffer: Uint8Array | string, cb?: (err?: Error) => void): boolean;
66
- write(str: Uint8Array | string, encoding?: string, cb?: (err?: Error) => void): boolean;
67
-
92
+ /**
93
+ * Destroys the socket after all data is written. If the `finish` event was already emitted the socket is destroyed immediately.
94
+ * If the socket is still writable it implicitly calls `socket.end()`.
95
+ * @since v0.3.4
96
+ */
97
+ destroySoon(): void;
98
+ /**
99
+ * Sends data on the socket. The second parameter specifies the encoding in the
100
+ * case of a string. It defaults to UTF8 encoding.
101
+ *
102
+ * Returns `true` if the entire data was flushed successfully to the kernel
103
+ * buffer. Returns `false` if all or part of the data was queued in user memory.`'drain'` will be emitted when the buffer is again free.
104
+ *
105
+ * The optional `callback` parameter will be executed when the data is finally
106
+ * written out, which may not be immediately.
107
+ *
108
+ * See `Writable` stream `write()` method for more
109
+ * information.
110
+ * @since v0.1.90
111
+ * @param [encoding='utf8'] Only used when data is `string`.
112
+ */
113
+ write(buffer: Uint8Array | string, cb?: (err?: Error | null) => void): boolean;
114
+ write(str: Uint8Array | string, encoding?: BufferEncoding, cb?: (err?: Error | null) => void): boolean;
115
+ /**
116
+ * Initiate a connection on a given socket.
117
+ *
118
+ * Possible signatures:
119
+ *
120
+ * * `socket.connect(options[, connectListener])`
121
+ * * `socket.connect(path[, connectListener])` for `IPC` connections.
122
+ * * `socket.connect(port[, host][, connectListener])` for TCP connections.
123
+ * * Returns: `net.Socket` The socket itself.
124
+ *
125
+ * This function is asynchronous. When the connection is established, the `'connect'` event will be emitted. If there is a problem connecting,
126
+ * instead of a `'connect'` event, an `'error'` event will be emitted with
127
+ * the error passed to the `'error'` listener.
128
+ * The last parameter `connectListener`, if supplied, will be added as a listener
129
+ * for the `'connect'` event **once**.
130
+ *
131
+ * This function should only be used for reconnecting a socket after`'close'` has been emitted or otherwise it may lead to undefined
132
+ * behavior.
133
+ */
68
134
  connect(options: SocketConnectOpts, connectionListener?: () => void): this;
69
135
  connect(port: number, host: string, connectionListener?: () => void): this;
70
136
  connect(port: number, connectionListener?: () => void): this;
71
137
  connect(path: string, connectionListener?: () => void): this;
72
-
73
- setEncoding(encoding?: string): this;
138
+ /**
139
+ * Set the encoding for the socket as a `Readable Stream`. See `readable.setEncoding()` for more information.
140
+ * @since v0.1.90
141
+ * @return The socket itself.
142
+ */
143
+ setEncoding(encoding?: BufferEncoding): this;
144
+ /**
145
+ * Pauses the reading of data. That is, `'data'` events will not be emitted.
146
+ * Useful to throttle back an upload.
147
+ * @return The socket itself.
148
+ */
74
149
  pause(): this;
150
+ /**
151
+ * Close the TCP connection by sending an RST packet and destroy the stream.
152
+ * If this TCP socket is in connecting status, it will send an RST packet and destroy this TCP socket once it is connected.
153
+ * Otherwise, it will call `socket.destroy` with an `ERR_SOCKET_CLOSED` Error.
154
+ * If this is not a TCP socket (for example, a pipe), calling this method will immediately throw an `ERR_INVALID_HANDLE_TYPE` Error.
155
+ * @since v18.3.0, v16.17.0
156
+ */
157
+ resetAndDestroy(): this;
158
+ /**
159
+ * Resumes reading after a call to `socket.pause()`.
160
+ * @return The socket itself.
161
+ */
75
162
  resume(): this;
163
+ /**
164
+ * Sets the socket to timeout after `timeout` milliseconds of inactivity on
165
+ * the socket. By default `net.Socket` do not have a timeout.
166
+ *
167
+ * When an idle timeout is triggered the socket will receive a `'timeout'` event but the connection will not be severed. The user must manually call `socket.end()` or `socket.destroy()` to
168
+ * end the connection.
169
+ *
170
+ * ```js
171
+ * socket.setTimeout(3000);
172
+ * socket.on('timeout', () => {
173
+ * console.log('socket timeout');
174
+ * socket.end();
175
+ * });
176
+ * ```
177
+ *
178
+ * If `timeout` is 0, then the existing idle timeout is disabled.
179
+ *
180
+ * The optional `callback` parameter will be added as a one-time listener for the `'timeout'` event.
181
+ * @since v0.1.90
182
+ * @return The socket itself.
183
+ */
76
184
  setTimeout(timeout: number, callback?: () => void): this;
185
+ /**
186
+ * Enable/disable the use of Nagle's algorithm.
187
+ *
188
+ * When a TCP connection is created, it will have Nagle's algorithm enabled.
189
+ *
190
+ * Nagle's algorithm delays data before it is sent via the network. It attempts
191
+ * to optimize throughput at the expense of latency.
192
+ *
193
+ * Passing `true` for `noDelay` or not passing an argument will disable Nagle's
194
+ * algorithm for the socket. Passing `false` for `noDelay` will enable Nagle's
195
+ * algorithm.
196
+ * @since v0.1.90
197
+ * @param [noDelay=true]
198
+ * @return The socket itself.
199
+ */
77
200
  setNoDelay(noDelay?: boolean): this;
201
+ /**
202
+ * Enable/disable keep-alive functionality, and optionally set the initial
203
+ * delay before the first keepalive probe is sent on an idle socket.
204
+ *
205
+ * Set `initialDelay` (in milliseconds) to set the delay between the last
206
+ * data packet received and the first keepalive probe. Setting `0` for`initialDelay` will leave the value unchanged from the default
207
+ * (or previous) setting.
208
+ *
209
+ * Enabling the keep-alive functionality will set the following socket options:
210
+ *
211
+ * * `SO_KEEPALIVE=1`
212
+ * * `TCP_KEEPIDLE=initialDelay`
213
+ * * `TCP_KEEPCNT=10`
214
+ * * `TCP_KEEPINTVL=1`
215
+ * @since v0.1.92
216
+ * @param [enable=false]
217
+ * @param [initialDelay=0]
218
+ * @return The socket itself.
219
+ */
78
220
  setKeepAlive(enable?: boolean, initialDelay?: number): this;
79
- address(): AddressInfo | string;
80
- unref(): void;
81
- ref(): void;
82
-
221
+ /**
222
+ * Returns the bound `address`, the address `family` name and `port` of the
223
+ * socket as reported by the operating system:`{ port: 12346, family: 'IPv4', address: '127.0.0.1' }`
224
+ * @since v0.1.90
225
+ */
226
+ address(): AddressInfo | {};
227
+ /**
228
+ * Calling `unref()` on a socket will allow the program to exit if this is the only
229
+ * active socket in the event system. If the socket is already `unref`ed calling`unref()` again will have no effect.
230
+ * @since v0.9.1
231
+ * @return The socket itself.
232
+ */
233
+ unref(): this;
234
+ /**
235
+ * Opposite of `unref()`, calling `ref()` on a previously `unref`ed socket will _not_ let the program exit if it's the only socket left (the default behavior).
236
+ * If the socket is `ref`ed calling `ref` again will have no effect.
237
+ * @since v0.9.1
238
+ * @return The socket itself.
239
+ */
240
+ ref(): this;
241
+ /**
242
+ * This property is only present if the family autoselection algorithm is enabled in `socket.connect(options)`
243
+ * and it is an array of the addresses that have been attempted.
244
+ *
245
+ * Each address is a string in the form of `$IP:$PORT`.
246
+ * If the connection was successful, then the last address is the one that the socket is currently connected to.
247
+ * @since v19.4.0
248
+ */
249
+ readonly autoSelectFamilyAttemptedAddresses: string[];
250
+ /**
251
+ * This property shows the number of characters buffered for writing. The buffer
252
+ * may contain strings whose length after encoding is not yet known. So this number
253
+ * is only an approximation of the number of bytes in the buffer.
254
+ *
255
+ * `net.Socket` has the property that `socket.write()` always works. This is to
256
+ * help users get up and running quickly. The computer cannot always keep up
257
+ * with the amount of data that is written to a socket. The network connection
258
+ * simply might be too slow. Node.js will internally queue up the data written to a
259
+ * socket and send it out over the wire when it is possible.
260
+ *
261
+ * The consequence of this internal buffering is that memory may grow.
262
+ * Users who experience large or growing `bufferSize` should attempt to
263
+ * "throttle" the data flows in their program with `socket.pause()` and `socket.resume()`.
264
+ * @since v0.3.8
265
+ * @deprecated Since v14.6.0 - Use `writableLength` instead.
266
+ */
83
267
  readonly bufferSize: number;
268
+ /**
269
+ * The amount of received bytes.
270
+ * @since v0.5.3
271
+ */
84
272
  readonly bytesRead: number;
273
+ /**
274
+ * The amount of bytes sent.
275
+ * @since v0.5.3
276
+ */
85
277
  readonly bytesWritten: number;
278
+ /**
279
+ * If `true`, `socket.connect(options[, connectListener])` was
280
+ * called and has not yet finished. It will stay `true` until the socket becomes
281
+ * connected, then it is set to `false` and the `'connect'` event is emitted. Note
282
+ * that the `socket.connect(options[, connectListener])` callback is a listener for the `'connect'` event.
283
+ * @since v6.1.0
284
+ */
86
285
  readonly connecting: boolean;
286
+ /**
287
+ * This is `true` if the socket is not connected yet, either because `.connect()`has not yet been called or because it is still in the process of connecting
288
+ * (see `socket.connecting`).
289
+ * @since v11.2.0, v10.16.0
290
+ */
291
+ readonly pending: boolean;
292
+ /**
293
+ * See `writable.destroyed` for further details.
294
+ */
87
295
  readonly destroyed: boolean;
88
- readonly localAddress: string;
89
- readonly localPort: number;
296
+ /**
297
+ * The string representation of the local IP address the remote client is
298
+ * connecting on. For example, in a server listening on `'0.0.0.0'`, if a client
299
+ * connects on `'192.168.1.1'`, the value of `socket.localAddress` would be`'192.168.1.1'`.
300
+ * @since v0.9.6
301
+ */
302
+ readonly localAddress?: string;
303
+ /**
304
+ * The numeric representation of the local port. For example, `80` or `21`.
305
+ * @since v0.9.6
306
+ */
307
+ readonly localPort?: number;
308
+ /**
309
+ * The string representation of the local IP family. `'IPv4'` or `'IPv6'`.
310
+ * @since v18.8.0, v16.18.0
311
+ */
312
+ readonly localFamily?: string;
90
313
  /**
91
314
  * This property represents the state of the connection as a string.
92
- * @see {https://nodejs.org/api/net.html#socketreadystate}
315
+ *
316
+ * * If the stream is connecting `socket.readyState` is `opening`.
317
+ * * If the stream is readable and writable, it is `open`.
318
+ * * If the stream is readable and not writable, it is `readOnly`.
319
+ * * If the stream is not readable and writable, it is `writeOnly`.
93
320
  * @since v0.5.0
94
321
  */
95
322
  readonly readyState: SocketReadyState;
96
- readonly remoteAddress?: string | undefined;
97
- readonly remoteFamily?: string | undefined;
98
- readonly remotePort?: number | undefined;
99
323
  /**
100
- * The socket timeout in milliseconds as set by socket.setTimeout(). It is undefined if a timeout has not been set.
324
+ * The string representation of the remote IP address. For example,`'74.125.127.100'` or `'2001:4860:a005::68'`. Value may be `undefined` if
325
+ * the socket is destroyed (for example, if the client disconnected).
326
+ * @since v0.5.10
327
+ */
328
+ readonly remoteAddress: string | undefined;
329
+ /**
330
+ * The string representation of the remote IP family. `'IPv4'` or `'IPv6'`. Value may be `undefined` if
331
+ * the socket is destroyed (for example, if the client disconnected).
332
+ * @since v0.11.14
333
+ */
334
+ readonly remoteFamily: string | undefined;
335
+ /**
336
+ * The numeric representation of the remote port. For example, `80` or `21`. Value may be `undefined` if
337
+ * the socket is destroyed (for example, if the client disconnected).
338
+ * @since v0.5.10
339
+ */
340
+ readonly remotePort: number | undefined;
341
+ /**
342
+ * The socket timeout in milliseconds as set by `socket.setTimeout()`.
343
+ * It is `undefined` if a timeout has not been set.
101
344
  * @since v10.7.0
102
345
  */
103
- readonly timeout?: number | undefined;
104
-
105
- // Extended base methods
106
- end(cb?: () => void): this;
107
- end(buffer: Uint8Array | string, cb?: () => void): this;
108
- end(str: Uint8Array | string, encoding?: string, cb?: () => void): this;
109
-
346
+ readonly timeout?: number;
347
+ /**
348
+ * Half-closes the socket. i.e., it sends a FIN packet. It is possible the
349
+ * server will still send some data.
350
+ *
351
+ * See `writable.end()` for further details.
352
+ * @since v0.1.90
353
+ * @param [encoding='utf8'] Only used when data is `string`.
354
+ * @param callback Optional callback for when the socket is finished.
355
+ * @return The socket itself.
356
+ */
357
+ end(callback?: () => void): this;
358
+ end(buffer: Uint8Array | string, callback?: () => void): this;
359
+ end(str: Uint8Array | string, encoding?: BufferEncoding, callback?: () => void): this;
110
360
  /**
111
361
  * events.EventEmitter
112
362
  * 1. close
113
363
  * 2. connect
114
- * 3. data
115
- * 4. drain
116
- * 5. end
117
- * 6. error
118
- * 7. lookup
119
- * 8. timeout
364
+ * 3. connectionAttempt
365
+ * 4. connectionAttemptFailed
366
+ * 5. connectionAttemptTimeout
367
+ * 6. data
368
+ * 7. drain
369
+ * 8. end
370
+ * 9. error
371
+ * 10. lookup
372
+ * 11. ready
373
+ * 12. timeout
120
374
  */
121
375
  addListener(event: string, listener: (...args: any[]) => void): this;
122
- addListener(event: "close", listener: (had_error: boolean) => void): this;
376
+ addListener(event: "close", listener: (hadError: boolean) => void): this;
123
377
  addListener(event: "connect", listener: () => void): this;
124
- addListener(event: "data", listener: (data: Buffer) => void): this;
378
+ addListener(event: "connectionAttempt", listener: (ip: string, port: number, family: number) => void): this;
379
+ addListener(
380
+ event: "connectionAttemptFailed",
381
+ listener: (ip: string, port: number, family: number, error: Error) => void,
382
+ ): this;
383
+ addListener(
384
+ event: "connectionAttemptTimeout",
385
+ listener: (ip: string, port: number, family: number) => void,
386
+ ): this;
387
+ addListener(event: "data", listener: (data: NonSharedBuffer) => void): this;
125
388
  addListener(event: "drain", listener: () => void): this;
126
389
  addListener(event: "end", listener: () => void): this;
127
390
  addListener(event: "error", listener: (err: Error) => void): this;
128
- addListener(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this;
391
+ addListener(
392
+ event: "lookup",
393
+ listener: (err: Error, address: string, family: string | number, host: string) => void,
394
+ ): this;
129
395
  addListener(event: "ready", listener: () => void): this;
130
396
  addListener(event: "timeout", listener: () => void): this;
131
-
132
397
  emit(event: string | symbol, ...args: any[]): boolean;
133
- emit(event: "close", had_error: boolean): boolean;
398
+ emit(event: "close", hadError: boolean): boolean;
134
399
  emit(event: "connect"): boolean;
135
- emit(event: "data", data: Buffer): boolean;
400
+ emit(event: "connectionAttempt", ip: string, port: number, family: number): boolean;
401
+ emit(event: "connectionAttemptFailed", ip: string, port: number, family: number, error: Error): boolean;
402
+ emit(event: "connectionAttemptTimeout", ip: string, port: number, family: number): boolean;
403
+ emit(event: "data", data: NonSharedBuffer): boolean;
136
404
  emit(event: "drain"): boolean;
137
405
  emit(event: "end"): boolean;
138
406
  emit(event: "error", err: Error): boolean;
139
407
  emit(event: "lookup", err: Error, address: string, family: string | number, host: string): boolean;
140
408
  emit(event: "ready"): boolean;
141
409
  emit(event: "timeout"): boolean;
142
-
143
410
  on(event: string, listener: (...args: any[]) => void): this;
144
- on(event: "close", listener: (had_error: boolean) => void): this;
411
+ on(event: "close", listener: (hadError: boolean) => void): this;
145
412
  on(event: "connect", listener: () => void): this;
146
- on(event: "data", listener: (data: Buffer) => void): this;
413
+ on(event: "connectionAttempt", listener: (ip: string, port: number, family: number) => void): this;
414
+ on(
415
+ event: "connectionAttemptFailed",
416
+ listener: (ip: string, port: number, family: number, error: Error) => void,
417
+ ): this;
418
+ on(event: "connectionAttemptTimeout", listener: (ip: string, port: number, family: number) => void): this;
419
+ on(event: "data", listener: (data: NonSharedBuffer) => void): this;
147
420
  on(event: "drain", listener: () => void): this;
148
421
  on(event: "end", listener: () => void): this;
149
422
  on(event: "error", listener: (err: Error) => void): this;
150
- on(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this;
423
+ on(
424
+ event: "lookup",
425
+ listener: (err: Error, address: string, family: string | number, host: string) => void,
426
+ ): this;
151
427
  on(event: "ready", listener: () => void): this;
152
428
  on(event: "timeout", listener: () => void): this;
153
-
154
429
  once(event: string, listener: (...args: any[]) => void): this;
155
- once(event: "close", listener: (had_error: boolean) => void): this;
430
+ once(event: "close", listener: (hadError: boolean) => void): this;
431
+ once(event: "connectionAttempt", listener: (ip: string, port: number, family: number) => void): this;
432
+ once(
433
+ event: "connectionAttemptFailed",
434
+ listener: (ip: string, port: number, family: number, error: Error) => void,
435
+ ): this;
436
+ once(event: "connectionAttemptTimeout", listener: (ip: string, port: number, family: number) => void): this;
156
437
  once(event: "connect", listener: () => void): this;
157
- once(event: "data", listener: (data: Buffer) => void): this;
438
+ once(event: "data", listener: (data: NonSharedBuffer) => void): this;
158
439
  once(event: "drain", listener: () => void): this;
159
440
  once(event: "end", listener: () => void): this;
160
441
  once(event: "error", listener: (err: Error) => void): this;
161
- once(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this;
442
+ once(
443
+ event: "lookup",
444
+ listener: (err: Error, address: string, family: string | number, host: string) => void,
445
+ ): this;
162
446
  once(event: "ready", listener: () => void): this;
163
447
  once(event: "timeout", listener: () => void): this;
164
-
165
448
  prependListener(event: string, listener: (...args: any[]) => void): this;
166
- prependListener(event: "close", listener: (had_error: boolean) => void): this;
449
+ prependListener(event: "close", listener: (hadError: boolean) => void): this;
167
450
  prependListener(event: "connect", listener: () => void): this;
168
- prependListener(event: "data", listener: (data: Buffer) => void): this;
451
+ prependListener(event: "connectionAttempt", listener: (ip: string, port: number, family: number) => void): this;
452
+ prependListener(
453
+ event: "connectionAttemptFailed",
454
+ listener: (ip: string, port: number, family: number, error: Error) => void,
455
+ ): this;
456
+ prependListener(
457
+ event: "connectionAttemptTimeout",
458
+ listener: (ip: string, port: number, family: number) => void,
459
+ ): this;
460
+ prependListener(event: "data", listener: (data: NonSharedBuffer) => void): this;
169
461
  prependListener(event: "drain", listener: () => void): this;
170
462
  prependListener(event: "end", listener: () => void): this;
171
463
  prependListener(event: "error", listener: (err: Error) => void): this;
172
- prependListener(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this;
464
+ prependListener(
465
+ event: "lookup",
466
+ listener: (err: Error, address: string, family: string | number, host: string) => void,
467
+ ): this;
173
468
  prependListener(event: "ready", listener: () => void): this;
174
469
  prependListener(event: "timeout", listener: () => void): this;
175
-
176
470
  prependOnceListener(event: string, listener: (...args: any[]) => void): this;
177
- prependOnceListener(event: "close", listener: (had_error: boolean) => void): this;
471
+ prependOnceListener(event: "close", listener: (hadError: boolean) => void): this;
178
472
  prependOnceListener(event: "connect", listener: () => void): this;
179
- prependOnceListener(event: "data", listener: (data: Buffer) => void): this;
473
+ prependOnceListener(
474
+ event: "connectionAttempt",
475
+ listener: (ip: string, port: number, family: number) => void,
476
+ ): this;
477
+ prependOnceListener(
478
+ event: "connectionAttemptFailed",
479
+ listener: (ip: string, port: number, family: number, error: Error) => void,
480
+ ): this;
481
+ prependOnceListener(
482
+ event: "connectionAttemptTimeout",
483
+ listener: (ip: string, port: number, family: number) => void,
484
+ ): this;
485
+ prependOnceListener(event: "data", listener: (data: NonSharedBuffer) => void): this;
180
486
  prependOnceListener(event: "drain", listener: () => void): this;
181
487
  prependOnceListener(event: "end", listener: () => void): this;
182
488
  prependOnceListener(event: "error", listener: (err: Error) => void): this;
183
- prependOnceListener(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this;
489
+ prependOnceListener(
490
+ event: "lookup",
491
+ listener: (err: Error, address: string, family: string | number, host: string) => void,
492
+ ): this;
184
493
  prependOnceListener(event: "ready", listener: () => void): this;
185
494
  prependOnceListener(event: "timeout", listener: () => void): this;
186
495
  }
187
-
188
- interface ListenOptions {
189
- port?: number | undefined;
190
- host?: string | undefined;
496
+ interface ListenOptions extends Abortable {
191
497
  backlog?: number | undefined;
192
- path?: string | undefined;
193
498
  exclusive?: boolean | undefined;
499
+ host?: string | undefined;
500
+ /**
501
+ * @default false
502
+ */
503
+ ipv6Only?: boolean | undefined;
504
+ reusePort?: boolean | undefined;
505
+ path?: string | undefined;
506
+ port?: number | undefined;
194
507
  readableAll?: boolean | undefined;
195
508
  writableAll?: boolean | undefined;
509
+ }
510
+ interface ServerOpts {
196
511
  /**
512
+ * Indicates whether half-opened TCP connections are allowed.
197
513
  * @default false
198
514
  */
199
- ipv6Only?: boolean | undefined;
515
+ allowHalfOpen?: boolean | undefined;
516
+ /**
517
+ * Indicates whether the socket should be paused on incoming connections.
518
+ * @default false
519
+ */
520
+ pauseOnConnect?: boolean | undefined;
521
+ /**
522
+ * If set to `true`, it disables the use of Nagle's algorithm immediately after a new incoming connection is received.
523
+ * @default false
524
+ * @since v16.5.0
525
+ */
526
+ noDelay?: boolean | undefined;
527
+ /**
528
+ * If set to `true`, it enables keep-alive functionality on the socket immediately after a new incoming connection is received,
529
+ * similarly on what is done in `socket.setKeepAlive([enable][, initialDelay])`.
530
+ * @default false
531
+ * @since v16.5.0
532
+ */
533
+ keepAlive?: boolean | undefined;
534
+ /**
535
+ * If set to a positive number, it sets the initial delay before the first keepalive probe is sent on an idle socket.
536
+ * @default 0
537
+ * @since v16.5.0
538
+ */
539
+ keepAliveInitialDelay?: number | undefined;
540
+ /**
541
+ * Optionally overrides all `net.Socket`s' `readableHighWaterMark` and `writableHighWaterMark`.
542
+ * @default See [stream.getDefaultHighWaterMark()](https://nodejs.org/docs/latest-v22.x/api/stream.html#streamgetdefaulthighwatermarkobjectmode).
543
+ * @since v18.17.0, v20.1.0
544
+ */
545
+ highWaterMark?: number | undefined;
546
+ /**
547
+ * `blockList` can be used for disabling inbound
548
+ * access to specific IP addresses, IP ranges, or IP subnets. This does not
549
+ * work if the server is behind a reverse proxy, NAT, etc. because the address
550
+ * checked against the block list is the address of the proxy, or the one
551
+ * specified by the NAT.
552
+ * @since v22.13.0
553
+ */
554
+ blockList?: BlockList | undefined;
200
555
  }
201
-
202
- // https://github.com/nodejs/node/blob/master/lib/net.js
556
+ interface DropArgument {
557
+ localAddress?: string;
558
+ localPort?: number;
559
+ localFamily?: string;
560
+ remoteAddress?: string;
561
+ remotePort?: number;
562
+ remoteFamily?: string;
563
+ }
564
+ /**
565
+ * This class is used to create a TCP or `IPC` server.
566
+ * @since v0.1.90
567
+ */
203
568
  class Server extends EventEmitter {
204
569
  constructor(connectionListener?: (socket: Socket) => void);
205
- constructor(options?: { allowHalfOpen?: boolean | undefined, pauseOnConnect?: boolean | undefined }, connectionListener?: (socket: Socket) => void);
206
-
570
+ constructor(options?: ServerOpts, connectionListener?: (socket: Socket) => void);
571
+ /**
572
+ * Start a server listening for connections. A `net.Server` can be a TCP or
573
+ * an `IPC` server depending on what it listens to.
574
+ *
575
+ * Possible signatures:
576
+ *
577
+ * * `server.listen(handle[, backlog][, callback])`
578
+ * * `server.listen(options[, callback])`
579
+ * * `server.listen(path[, backlog][, callback])` for `IPC` servers
580
+ * * `server.listen([port[, host[, backlog]]][, callback])` for TCP servers
581
+ *
582
+ * This function is asynchronous. When the server starts listening, the `'listening'` event will be emitted. The last parameter `callback`will be added as a listener for the `'listening'`
583
+ * event.
584
+ *
585
+ * All `listen()` methods can take a `backlog` parameter to specify the maximum
586
+ * length of the queue of pending connections. The actual length will be determined
587
+ * by the OS through sysctl settings such as `tcp_max_syn_backlog` and `somaxconn` on Linux. The default value of this parameter is 511 (not 512).
588
+ *
589
+ * All {@link Socket} are set to `SO_REUSEADDR` (see [`socket(7)`](https://man7.org/linux/man-pages/man7/socket.7.html) for
590
+ * details).
591
+ *
592
+ * The `server.listen()` method can be called again if and only if there was an
593
+ * error during the first `server.listen()` call or `server.close()` has been
594
+ * called. Otherwise, an `ERR_SERVER_ALREADY_LISTEN` error will be thrown.
595
+ *
596
+ * One of the most common errors raised when listening is `EADDRINUSE`.
597
+ * This happens when another server is already listening on the requested`port`/`path`/`handle`. One way to handle this would be to retry
598
+ * after a certain amount of time:
599
+ *
600
+ * ```js
601
+ * server.on('error', (e) => {
602
+ * if (e.code === 'EADDRINUSE') {
603
+ * console.error('Address in use, retrying...');
604
+ * setTimeout(() => {
605
+ * server.close();
606
+ * server.listen(PORT, HOST);
607
+ * }, 1000);
608
+ * }
609
+ * });
610
+ * ```
611
+ */
207
612
  listen(port?: number, hostname?: string, backlog?: number, listeningListener?: () => void): this;
208
613
  listen(port?: number, hostname?: string, listeningListener?: () => void): this;
209
614
  listen(port?: number, backlog?: number, listeningListener?: () => void): this;
@@ -213,78 +618,440 @@ declare module 'net' {
213
618
  listen(options: ListenOptions, listeningListener?: () => void): this;
214
619
  listen(handle: any, backlog?: number, listeningListener?: () => void): this;
215
620
  listen(handle: any, listeningListener?: () => void): this;
621
+ /**
622
+ * Stops the server from accepting new connections and keeps existing
623
+ * connections. This function is asynchronous, the server is finally closed
624
+ * when all connections are ended and the server emits a `'close'` event.
625
+ * The optional `callback` will be called once the `'close'` event occurs. Unlike
626
+ * that event, it will be called with an `Error` as its only argument if the server
627
+ * was not open when it was closed.
628
+ * @since v0.1.90
629
+ * @param callback Called when the server is closed.
630
+ */
216
631
  close(callback?: (err?: Error) => void): this;
632
+ /**
633
+ * Returns the bound `address`, the address `family` name, and `port` of the server
634
+ * as reported by the operating system if listening on an IP socket
635
+ * (useful to find which port was assigned when getting an OS-assigned address):`{ port: 12346, family: 'IPv4', address: '127.0.0.1' }`.
636
+ *
637
+ * For a server listening on a pipe or Unix domain socket, the name is returned
638
+ * as a string.
639
+ *
640
+ * ```js
641
+ * const server = net.createServer((socket) => {
642
+ * socket.end('goodbye\n');
643
+ * }).on('error', (err) => {
644
+ * // Handle errors here.
645
+ * throw err;
646
+ * });
647
+ *
648
+ * // Grab an arbitrary unused port.
649
+ * server.listen(() => {
650
+ * console.log('opened server on', server.address());
651
+ * });
652
+ * ```
653
+ *
654
+ * `server.address()` returns `null` before the `'listening'` event has been
655
+ * emitted or after calling `server.close()`.
656
+ * @since v0.1.90
657
+ */
217
658
  address(): AddressInfo | string | null;
218
- getConnections(cb: (error: Error | null, count: number) => void): void;
659
+ /**
660
+ * Asynchronously get the number of concurrent connections on the server. Works
661
+ * when sockets were sent to forks.
662
+ *
663
+ * Callback should take two arguments `err` and `count`.
664
+ * @since v0.9.7
665
+ */
666
+ getConnections(cb: (error: Error | null, count: number) => void): this;
667
+ /**
668
+ * Opposite of `unref()`, calling `ref()` on a previously `unref`ed server will _not_ let the program exit if it's the only server left (the default behavior).
669
+ * If the server is `ref`ed calling `ref()` again will have no effect.
670
+ * @since v0.9.1
671
+ */
219
672
  ref(): this;
673
+ /**
674
+ * Calling `unref()` on a server will allow the program to exit if this is the only
675
+ * active server in the event system. If the server is already `unref`ed calling`unref()` again will have no effect.
676
+ * @since v0.9.1
677
+ */
220
678
  unref(): this;
679
+ /**
680
+ * Set this property to reject connections when the server's connection count gets
681
+ * high.
682
+ *
683
+ * It is not recommended to use this option once a socket has been sent to a child
684
+ * with `child_process.fork()`.
685
+ * @since v0.2.0
686
+ */
221
687
  maxConnections: number;
222
688
  connections: number;
223
- listening: boolean;
224
-
689
+ /**
690
+ * Indicates whether or not the server is listening for connections.
691
+ * @since v5.7.0
692
+ */
693
+ readonly listening: boolean;
225
694
  /**
226
695
  * events.EventEmitter
227
696
  * 1. close
228
697
  * 2. connection
229
698
  * 3. error
230
699
  * 4. listening
700
+ * 5. drop
231
701
  */
232
702
  addListener(event: string, listener: (...args: any[]) => void): this;
233
703
  addListener(event: "close", listener: () => void): this;
234
704
  addListener(event: "connection", listener: (socket: Socket) => void): this;
235
705
  addListener(event: "error", listener: (err: Error) => void): this;
236
706
  addListener(event: "listening", listener: () => void): this;
237
-
707
+ addListener(event: "drop", listener: (data?: DropArgument) => void): this;
238
708
  emit(event: string | symbol, ...args: any[]): boolean;
239
709
  emit(event: "close"): boolean;
240
710
  emit(event: "connection", socket: Socket): boolean;
241
711
  emit(event: "error", err: Error): boolean;
242
712
  emit(event: "listening"): boolean;
243
-
713
+ emit(event: "drop", data?: DropArgument): boolean;
244
714
  on(event: string, listener: (...args: any[]) => void): this;
245
715
  on(event: "close", listener: () => void): this;
246
716
  on(event: "connection", listener: (socket: Socket) => void): this;
247
717
  on(event: "error", listener: (err: Error) => void): this;
248
718
  on(event: "listening", listener: () => void): this;
249
-
719
+ on(event: "drop", listener: (data?: DropArgument) => void): this;
250
720
  once(event: string, listener: (...args: any[]) => void): this;
251
721
  once(event: "close", listener: () => void): this;
252
722
  once(event: "connection", listener: (socket: Socket) => void): this;
253
723
  once(event: "error", listener: (err: Error) => void): this;
254
724
  once(event: "listening", listener: () => void): this;
255
-
725
+ once(event: "drop", listener: (data?: DropArgument) => void): this;
256
726
  prependListener(event: string, listener: (...args: any[]) => void): this;
257
727
  prependListener(event: "close", listener: () => void): this;
258
728
  prependListener(event: "connection", listener: (socket: Socket) => void): this;
259
729
  prependListener(event: "error", listener: (err: Error) => void): this;
260
730
  prependListener(event: "listening", listener: () => void): this;
261
-
731
+ prependListener(event: "drop", listener: (data?: DropArgument) => void): this;
262
732
  prependOnceListener(event: string, listener: (...args: any[]) => void): this;
263
733
  prependOnceListener(event: "close", listener: () => void): this;
264
734
  prependOnceListener(event: "connection", listener: (socket: Socket) => void): this;
265
735
  prependOnceListener(event: "error", listener: (err: Error) => void): this;
266
736
  prependOnceListener(event: "listening", listener: () => void): this;
737
+ prependOnceListener(event: "drop", listener: (data?: DropArgument) => void): this;
738
+ /**
739
+ * Calls {@link Server.close()} and returns a promise that fulfills when the server has closed.
740
+ * @since v20.5.0
741
+ */
742
+ [Symbol.asyncDispose](): Promise<void>;
743
+ }
744
+ type IPVersion = "ipv4" | "ipv6";
745
+ /**
746
+ * The `BlockList` object can be used with some network APIs to specify rules for
747
+ * disabling inbound or outbound access to specific IP addresses, IP ranges, or
748
+ * IP subnets.
749
+ * @since v15.0.0, v14.18.0
750
+ */
751
+ class BlockList {
752
+ /**
753
+ * Adds a rule to block the given IP address.
754
+ * @since v15.0.0, v14.18.0
755
+ * @param address An IPv4 or IPv6 address.
756
+ * @param [type='ipv4'] Either `'ipv4'` or `'ipv6'`.
757
+ */
758
+ addAddress(address: string, type?: IPVersion): void;
759
+ addAddress(address: SocketAddress): void;
760
+ /**
761
+ * Adds a rule to block a range of IP addresses from `start` (inclusive) to`end` (inclusive).
762
+ * @since v15.0.0, v14.18.0
763
+ * @param start The starting IPv4 or IPv6 address in the range.
764
+ * @param end The ending IPv4 or IPv6 address in the range.
765
+ * @param [type='ipv4'] Either `'ipv4'` or `'ipv6'`.
766
+ */
767
+ addRange(start: string, end: string, type?: IPVersion): void;
768
+ addRange(start: SocketAddress, end: SocketAddress): void;
769
+ /**
770
+ * Adds a rule to block a range of IP addresses specified as a subnet mask.
771
+ * @since v15.0.0, v14.18.0
772
+ * @param net The network IPv4 or IPv6 address.
773
+ * @param prefix The number of CIDR prefix bits. For IPv4, this must be a value between `0` and `32`. For IPv6, this must be between `0` and `128`.
774
+ * @param [type='ipv4'] Either `'ipv4'` or `'ipv6'`.
775
+ */
776
+ addSubnet(net: SocketAddress, prefix: number): void;
777
+ addSubnet(net: string, prefix: number, type?: IPVersion): void;
778
+ /**
779
+ * Returns `true` if the given IP address matches any of the rules added to the`BlockList`.
780
+ *
781
+ * ```js
782
+ * const blockList = new net.BlockList();
783
+ * blockList.addAddress('123.123.123.123');
784
+ * blockList.addRange('10.0.0.1', '10.0.0.10');
785
+ * blockList.addSubnet('8592:757c:efae:4e45::', 64, 'ipv6');
786
+ *
787
+ * console.log(blockList.check('123.123.123.123')); // Prints: true
788
+ * console.log(blockList.check('10.0.0.3')); // Prints: true
789
+ * console.log(blockList.check('222.111.111.222')); // Prints: false
790
+ *
791
+ * // IPv6 notation for IPv4 addresses works:
792
+ * console.log(blockList.check('::ffff:7b7b:7b7b', 'ipv6')); // Prints: true
793
+ * console.log(blockList.check('::ffff:123.123.123.123', 'ipv6')); // Prints: true
794
+ * ```
795
+ * @since v15.0.0, v14.18.0
796
+ * @param address The IP address to check
797
+ * @param [type='ipv4'] Either `'ipv4'` or `'ipv6'`.
798
+ */
799
+ check(address: SocketAddress): boolean;
800
+ check(address: string, type?: IPVersion): boolean;
801
+ /**
802
+ * The list of rules added to the blocklist.
803
+ * @since v15.0.0, v14.18.0
804
+ */
805
+ rules: readonly string[];
806
+ /**
807
+ * Returns `true` if the `value` is a `net.BlockList`.
808
+ * @since v22.13.0
809
+ * @param value Any JS value
810
+ */
811
+ static isBlockList(value: unknown): value is BlockList;
812
+ /**
813
+ * ```js
814
+ * const blockList = new net.BlockList();
815
+ * const data = [
816
+ * 'Subnet: IPv4 192.168.1.0/24',
817
+ * 'Address: IPv4 10.0.0.5',
818
+ * 'Range: IPv4 192.168.2.1-192.168.2.10',
819
+ * 'Range: IPv4 10.0.0.1-10.0.0.10',
820
+ * ];
821
+ * blockList.fromJSON(data);
822
+ * blockList.fromJSON(JSON.stringify(data));
823
+ * ```
824
+ * @since v22.19.0
825
+ * @experimental
826
+ */
827
+ fromJSON(data: string | readonly string[]): void;
828
+ /**
829
+ * @since v22.19.0
830
+ * @experimental
831
+ */
832
+ toJSON(): readonly string[];
267
833
  }
268
-
269
834
  interface TcpNetConnectOpts extends TcpSocketConnectOpts, SocketConstructorOpts {
270
835
  timeout?: number | undefined;
271
836
  }
272
-
273
837
  interface IpcNetConnectOpts extends IpcSocketConnectOpts, SocketConstructorOpts {
274
838
  timeout?: number | undefined;
275
839
  }
276
-
277
840
  type NetConnectOpts = TcpNetConnectOpts | IpcNetConnectOpts;
278
-
841
+ /**
842
+ * Creates a new TCP or `IPC` server.
843
+ *
844
+ * If `allowHalfOpen` is set to `true`, when the other end of the socket
845
+ * signals the end of transmission, the server will only send back the end of
846
+ * transmission when `socket.end()` is explicitly called. For example, in the
847
+ * context of TCP, when a FIN packed is received, a FIN packed is sent
848
+ * back only when `socket.end()` is explicitly called. Until then the
849
+ * connection is half-closed (non-readable but still writable). See `'end'` event and [RFC 1122](https://tools.ietf.org/html/rfc1122) (section 4.2.2.13) for more information.
850
+ *
851
+ * If `pauseOnConnect` is set to `true`, then the socket associated with each
852
+ * incoming connection will be paused, and no data will be read from its handle.
853
+ * This allows connections to be passed between processes without any data being
854
+ * read by the original process. To begin reading data from a paused socket, call `socket.resume()`.
855
+ *
856
+ * The server can be a TCP server or an `IPC` server, depending on what it `listen()` to.
857
+ *
858
+ * Here is an example of a TCP echo server which listens for connections
859
+ * on port 8124:
860
+ *
861
+ * ```js
862
+ * import net from 'node:net';
863
+ * const server = net.createServer((c) => {
864
+ * // 'connection' listener.
865
+ * console.log('client connected');
866
+ * c.on('end', () => {
867
+ * console.log('client disconnected');
868
+ * });
869
+ * c.write('hello\r\n');
870
+ * c.pipe(c);
871
+ * });
872
+ * server.on('error', (err) => {
873
+ * throw err;
874
+ * });
875
+ * server.listen(8124, () => {
876
+ * console.log('server bound');
877
+ * });
878
+ * ```
879
+ *
880
+ * Test this by using `telnet`:
881
+ *
882
+ * ```bash
883
+ * telnet localhost 8124
884
+ * ```
885
+ *
886
+ * To listen on the socket `/tmp/echo.sock`:
887
+ *
888
+ * ```js
889
+ * server.listen('/tmp/echo.sock', () => {
890
+ * console.log('server bound');
891
+ * });
892
+ * ```
893
+ *
894
+ * Use `nc` to connect to a Unix domain socket server:
895
+ *
896
+ * ```bash
897
+ * nc -U /tmp/echo.sock
898
+ * ```
899
+ * @since v0.5.0
900
+ * @param connectionListener Automatically set as a listener for the {@link 'connection'} event.
901
+ */
279
902
  function createServer(connectionListener?: (socket: Socket) => void): Server;
280
- function createServer(options?: { allowHalfOpen?: boolean | undefined, pauseOnConnect?: boolean | undefined }, connectionListener?: (socket: Socket) => void): Server;
903
+ function createServer(options?: ServerOpts, connectionListener?: (socket: Socket) => void): Server;
904
+ /**
905
+ * Aliases to {@link createConnection}.
906
+ *
907
+ * Possible signatures:
908
+ *
909
+ * * {@link connect}
910
+ * * {@link connect} for `IPC` connections.
911
+ * * {@link connect} for TCP connections.
912
+ */
281
913
  function connect(options: NetConnectOpts, connectionListener?: () => void): Socket;
282
914
  function connect(port: number, host?: string, connectionListener?: () => void): Socket;
283
915
  function connect(path: string, connectionListener?: () => void): Socket;
916
+ /**
917
+ * A factory function, which creates a new {@link Socket},
918
+ * immediately initiates connection with `socket.connect()`,
919
+ * then returns the `net.Socket` that starts the connection.
920
+ *
921
+ * When the connection is established, a `'connect'` event will be emitted
922
+ * on the returned socket. The last parameter `connectListener`, if supplied,
923
+ * will be added as a listener for the `'connect'` event **once**.
924
+ *
925
+ * Possible signatures:
926
+ *
927
+ * * {@link createConnection}
928
+ * * {@link createConnection} for `IPC` connections.
929
+ * * {@link createConnection} for TCP connections.
930
+ *
931
+ * The {@link connect} function is an alias to this function.
932
+ */
284
933
  function createConnection(options: NetConnectOpts, connectionListener?: () => void): Socket;
285
934
  function createConnection(port: number, host?: string, connectionListener?: () => void): Socket;
286
935
  function createConnection(path: string, connectionListener?: () => void): Socket;
936
+ /**
937
+ * Gets the current default value of the `autoSelectFamily` option of `socket.connect(options)`.
938
+ * The initial default value is `true`, unless the command line option`--no-network-family-autoselection` is provided.
939
+ * @since v19.4.0
940
+ */
941
+ function getDefaultAutoSelectFamily(): boolean;
942
+ /**
943
+ * Sets the default value of the `autoSelectFamily` option of `socket.connect(options)`.
944
+ * @param value The new default value.
945
+ * The initial default value is `true`, unless the command line option
946
+ * `--no-network-family-autoselection` is provided.
947
+ * @since v19.4.0
948
+ */
949
+ function setDefaultAutoSelectFamily(value: boolean): void;
950
+ /**
951
+ * Gets the current default value of the `autoSelectFamilyAttemptTimeout` option of `socket.connect(options)`.
952
+ * The initial default value is `250` or the value specified via the command line option `--network-family-autoselection-attempt-timeout`.
953
+ * @returns The current default value of the `autoSelectFamilyAttemptTimeout` option.
954
+ * @since v19.8.0, v18.8.0
955
+ */
956
+ function getDefaultAutoSelectFamilyAttemptTimeout(): number;
957
+ /**
958
+ * Sets the default value of the `autoSelectFamilyAttemptTimeout` option of `socket.connect(options)`.
959
+ * @param value The new default value, which must be a positive number. If the number is less than `10`, the value `10` is used instead. The initial default value is `250` or the value specified via the command line
960
+ * option `--network-family-autoselection-attempt-timeout`.
961
+ * @since v19.8.0, v18.8.0
962
+ */
963
+ function setDefaultAutoSelectFamilyAttemptTimeout(value: number): void;
964
+ /**
965
+ * Returns `6` if `input` is an IPv6 address. Returns `4` if `input` is an IPv4
966
+ * address in [dot-decimal notation](https://en.wikipedia.org/wiki/Dot-decimal_notation) with no leading zeroes. Otherwise, returns`0`.
967
+ *
968
+ * ```js
969
+ * net.isIP('::1'); // returns 6
970
+ * net.isIP('127.0.0.1'); // returns 4
971
+ * net.isIP('127.000.000.001'); // returns 0
972
+ * net.isIP('127.0.0.1/24'); // returns 0
973
+ * net.isIP('fhqwhgads'); // returns 0
974
+ * ```
975
+ * @since v0.3.0
976
+ */
287
977
  function isIP(input: string): number;
978
+ /**
979
+ * Returns `true` if `input` is an IPv4 address in [dot-decimal notation](https://en.wikipedia.org/wiki/Dot-decimal_notation) with no
980
+ * leading zeroes. Otherwise, returns `false`.
981
+ *
982
+ * ```js
983
+ * net.isIPv4('127.0.0.1'); // returns true
984
+ * net.isIPv4('127.000.000.001'); // returns false
985
+ * net.isIPv4('127.0.0.1/24'); // returns false
986
+ * net.isIPv4('fhqwhgads'); // returns false
987
+ * ```
988
+ * @since v0.3.0
989
+ */
288
990
  function isIPv4(input: string): boolean;
991
+ /**
992
+ * Returns `true` if `input` is an IPv6 address. Otherwise, returns `false`.
993
+ *
994
+ * ```js
995
+ * net.isIPv6('::1'); // returns true
996
+ * net.isIPv6('fhqwhgads'); // returns false
997
+ * ```
998
+ * @since v0.3.0
999
+ */
289
1000
  function isIPv6(input: string): boolean;
1001
+ interface SocketAddressInitOptions {
1002
+ /**
1003
+ * The network address as either an IPv4 or IPv6 string.
1004
+ * @default 127.0.0.1
1005
+ */
1006
+ address?: string | undefined;
1007
+ /**
1008
+ * @default `'ipv4'`
1009
+ */
1010
+ family?: IPVersion | undefined;
1011
+ /**
1012
+ * An IPv6 flow-label used only if `family` is `'ipv6'`.
1013
+ * @default 0
1014
+ */
1015
+ flowlabel?: number | undefined;
1016
+ /**
1017
+ * An IP port.
1018
+ * @default 0
1019
+ */
1020
+ port?: number | undefined;
1021
+ }
1022
+ /**
1023
+ * @since v15.14.0, v14.18.0
1024
+ */
1025
+ class SocketAddress {
1026
+ constructor(options: SocketAddressInitOptions);
1027
+ /**
1028
+ * Either \`'ipv4'\` or \`'ipv6'\`.
1029
+ * @since v15.14.0, v14.18.0
1030
+ */
1031
+ readonly address: string;
1032
+ /**
1033
+ * Either \`'ipv4'\` or \`'ipv6'\`.
1034
+ * @since v15.14.0, v14.18.0
1035
+ */
1036
+ readonly family: IPVersion;
1037
+ /**
1038
+ * @since v15.14.0, v14.18.0
1039
+ */
1040
+ readonly port: number;
1041
+ /**
1042
+ * @since v15.14.0, v14.18.0
1043
+ */
1044
+ readonly flowlabel: number;
1045
+ /**
1046
+ * @since v22.13.0
1047
+ * @param input An input string containing an IP address and optional port,
1048
+ * e.g. `123.1.2.3:1234` or `[1::1]:1234`.
1049
+ * @returns Returns a `SocketAddress` if parsing was successful.
1050
+ * Otherwise returns `undefined`.
1051
+ */
1052
+ static parse(input: string): SocketAddress | undefined;
1053
+ }
1054
+ }
1055
+ declare module "node:net" {
1056
+ export * from "net";
290
1057
  }