node-fastify 5.8.3

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 (354) hide show
  1. package/.borp.yaml +3 -0
  2. package/.markdownlint-cli2.yaml +22 -0
  3. package/.prettierignore +1 -0
  4. package/GOVERNANCE.md +4 -0
  5. package/LICENSE +21 -0
  6. package/PROJECT_CHARTER.md +126 -0
  7. package/README.md +423 -0
  8. package/SECURITY.md +220 -0
  9. package/SPONSORS.md +24 -0
  10. package/build/build-error-serializer.js +35 -0
  11. package/build/build-validation.js +169 -0
  12. package/build/sync-version.js +11 -0
  13. package/docs/Guides/Benchmarking.md +60 -0
  14. package/docs/Guides/Database.md +321 -0
  15. package/docs/Guides/Delay-Accepting-Requests.md +608 -0
  16. package/docs/Guides/Detecting-When-Clients-Abort.md +172 -0
  17. package/docs/Guides/Ecosystem.md +726 -0
  18. package/docs/Guides/Fluent-Schema.md +127 -0
  19. package/docs/Guides/Getting-Started.md +620 -0
  20. package/docs/Guides/Index.md +43 -0
  21. package/docs/Guides/Migration-Guide-V3.md +287 -0
  22. package/docs/Guides/Migration-Guide-V4.md +267 -0
  23. package/docs/Guides/Migration-Guide-V5.md +727 -0
  24. package/docs/Guides/Plugins-Guide.md +520 -0
  25. package/docs/Guides/Prototype-Poisoning.md +383 -0
  26. package/docs/Guides/Recommendations.md +378 -0
  27. package/docs/Guides/Serverless.md +604 -0
  28. package/docs/Guides/Style-Guide.md +246 -0
  29. package/docs/Guides/Testing.md +481 -0
  30. package/docs/Guides/Write-Plugin.md +103 -0
  31. package/docs/Guides/Write-Type-Provider.md +34 -0
  32. package/docs/Reference/ContentTypeParser.md +271 -0
  33. package/docs/Reference/Decorators.md +436 -0
  34. package/docs/Reference/Encapsulation.md +194 -0
  35. package/docs/Reference/Errors.md +377 -0
  36. package/docs/Reference/HTTP2.md +94 -0
  37. package/docs/Reference/Hooks.md +958 -0
  38. package/docs/Reference/Index.md +73 -0
  39. package/docs/Reference/LTS.md +86 -0
  40. package/docs/Reference/Lifecycle.md +99 -0
  41. package/docs/Reference/Logging.md +268 -0
  42. package/docs/Reference/Middleware.md +79 -0
  43. package/docs/Reference/Plugins.md +245 -0
  44. package/docs/Reference/Principles.md +73 -0
  45. package/docs/Reference/Reply.md +1001 -0
  46. package/docs/Reference/Request.md +295 -0
  47. package/docs/Reference/Routes.md +802 -0
  48. package/docs/Reference/Server.md +2389 -0
  49. package/docs/Reference/Type-Providers.md +256 -0
  50. package/docs/Reference/TypeScript.md +1729 -0
  51. package/docs/Reference/Validation-and-Serialization.md +1130 -0
  52. package/docs/Reference/Warnings.md +58 -0
  53. package/docs/index.md +24 -0
  54. package/docs/resources/encapsulation_context.drawio +1 -0
  55. package/docs/resources/encapsulation_context.svg +3 -0
  56. package/eslint.config.js +35 -0
  57. package/examples/asyncawait.js +38 -0
  58. package/examples/benchmark/body.json +3 -0
  59. package/examples/benchmark/hooks-benchmark-async-await.js +44 -0
  60. package/examples/benchmark/hooks-benchmark.js +52 -0
  61. package/examples/benchmark/parser.js +47 -0
  62. package/examples/benchmark/simple.js +30 -0
  63. package/examples/benchmark/webstream.js +27 -0
  64. package/examples/hooks.js +91 -0
  65. package/examples/http2.js +39 -0
  66. package/examples/https.js +38 -0
  67. package/examples/parser.js +53 -0
  68. package/examples/plugin.js +12 -0
  69. package/examples/route-prefix.js +38 -0
  70. package/examples/shared-schema.js +38 -0
  71. package/examples/simple-stream.js +20 -0
  72. package/examples/simple.js +32 -0
  73. package/examples/simple.mjs +27 -0
  74. package/examples/typescript-server.ts +79 -0
  75. package/examples/use-plugin.js +29 -0
  76. package/fastify.d.ts +253 -0
  77. package/fastify.js +985 -0
  78. package/integration/server.js +29 -0
  79. package/integration/test.sh +23 -0
  80. package/lib/config-validator.js +1266 -0
  81. package/lib/content-type-parser.js +413 -0
  82. package/lib/content-type.js +160 -0
  83. package/lib/context.js +98 -0
  84. package/lib/decorate.js +152 -0
  85. package/lib/error-handler.js +173 -0
  86. package/lib/error-serializer.js +134 -0
  87. package/lib/error-status.js +14 -0
  88. package/lib/errors.js +516 -0
  89. package/lib/four-oh-four.js +190 -0
  90. package/lib/handle-request.js +195 -0
  91. package/lib/head-route.js +45 -0
  92. package/lib/hooks.js +429 -0
  93. package/lib/initial-config-validation.js +37 -0
  94. package/lib/logger-factory.js +136 -0
  95. package/lib/logger-pino.js +68 -0
  96. package/lib/noop-set.js +10 -0
  97. package/lib/plugin-override.js +90 -0
  98. package/lib/plugin-utils.js +169 -0
  99. package/lib/promise.js +23 -0
  100. package/lib/reply.js +1030 -0
  101. package/lib/req-id-gen-factory.js +52 -0
  102. package/lib/request.js +391 -0
  103. package/lib/route.js +686 -0
  104. package/lib/schema-controller.js +164 -0
  105. package/lib/schemas.js +207 -0
  106. package/lib/server.js +441 -0
  107. package/lib/symbols.js +71 -0
  108. package/lib/validation.js +280 -0
  109. package/lib/warnings.js +57 -0
  110. package/lib/wrap-thenable.js +84 -0
  111. package/package.json +225 -0
  112. package/scripts/validate-ecosystem-links.js +179 -0
  113. package/test/404s.test.js +2035 -0
  114. package/test/500s.test.js +422 -0
  115. package/test/allow-unsafe-regex.test.js +92 -0
  116. package/test/als.test.js +65 -0
  117. package/test/async-await.test.js +705 -0
  118. package/test/async-dispose.test.js +20 -0
  119. package/test/async_hooks.test.js +52 -0
  120. package/test/body-limit.test.js +224 -0
  121. package/test/buffer.test.js +74 -0
  122. package/test/build/error-serializer.test.js +36 -0
  123. package/test/build/version.test.js +14 -0
  124. package/test/build-certificate.js +109 -0
  125. package/test/bundler/README.md +29 -0
  126. package/test/bundler/esbuild/bundler-test.js +32 -0
  127. package/test/bundler/esbuild/package.json +10 -0
  128. package/test/bundler/esbuild/src/fail-plugin-version.js +14 -0
  129. package/test/bundler/esbuild/src/index.js +9 -0
  130. package/test/bundler/webpack/bundler-test.js +32 -0
  131. package/test/bundler/webpack/package.json +11 -0
  132. package/test/bundler/webpack/src/fail-plugin-version.js +14 -0
  133. package/test/bundler/webpack/src/index.js +9 -0
  134. package/test/bundler/webpack/webpack.config.js +15 -0
  135. package/test/case-insensitive.test.js +102 -0
  136. package/test/chainable.test.js +40 -0
  137. package/test/child-logger-factory.test.js +128 -0
  138. package/test/client-timeout.test.js +38 -0
  139. package/test/close-pipelining.test.js +78 -0
  140. package/test/close.test.js +706 -0
  141. package/test/conditional-pino.test.js +47 -0
  142. package/test/connection-timeout.test.js +42 -0
  143. package/test/constrained-routes.test.js +1138 -0
  144. package/test/content-length.test.js +174 -0
  145. package/test/content-parser.test.js +739 -0
  146. package/test/content-type.test.js +181 -0
  147. package/test/context-config.test.js +164 -0
  148. package/test/custom-http-server.test.js +118 -0
  149. package/test/custom-parser-async.test.js +59 -0
  150. package/test/custom-parser.0.test.js +701 -0
  151. package/test/custom-parser.1.test.js +266 -0
  152. package/test/custom-parser.2.test.js +91 -0
  153. package/test/custom-parser.3.test.js +208 -0
  154. package/test/custom-parser.4.test.js +218 -0
  155. package/test/custom-parser.5.test.js +130 -0
  156. package/test/custom-querystring-parser.test.js +129 -0
  157. package/test/decorator.test.js +1330 -0
  158. package/test/delete.test.js +344 -0
  159. package/test/diagnostics-channel/404.test.js +49 -0
  160. package/test/diagnostics-channel/async-delay-request.test.js +65 -0
  161. package/test/diagnostics-channel/async-request.test.js +64 -0
  162. package/test/diagnostics-channel/error-before-handler.test.js +35 -0
  163. package/test/diagnostics-channel/error-request.test.js +53 -0
  164. package/test/diagnostics-channel/error-status.test.js +123 -0
  165. package/test/diagnostics-channel/init.test.js +50 -0
  166. package/test/diagnostics-channel/sync-delay-request.test.js +49 -0
  167. package/test/diagnostics-channel/sync-request-reply.test.js +51 -0
  168. package/test/diagnostics-channel/sync-request.test.js +54 -0
  169. package/test/encapsulated-child-logger-factory.test.js +69 -0
  170. package/test/encapsulated-error-handler.test.js +237 -0
  171. package/test/esm/errorCodes.test.mjs +10 -0
  172. package/test/esm/esm.test.mjs +13 -0
  173. package/test/esm/index.test.js +8 -0
  174. package/test/esm/named-exports.mjs +14 -0
  175. package/test/esm/other.mjs +8 -0
  176. package/test/esm/plugin.mjs +8 -0
  177. package/test/fastify-instance.test.js +300 -0
  178. package/test/find-route.test.js +152 -0
  179. package/test/fluent-schema.test.js +209 -0
  180. package/test/genReqId.test.js +426 -0
  181. package/test/handler-context.test.js +45 -0
  182. package/test/handler-timeout.test.js +367 -0
  183. package/test/has-route.test.js +88 -0
  184. package/test/header-overflow.test.js +55 -0
  185. package/test/helper.js +496 -0
  186. package/test/hooks-async.test.js +1099 -0
  187. package/test/hooks.on-listen.test.js +1162 -0
  188. package/test/hooks.on-ready.test.js +421 -0
  189. package/test/hooks.test.js +3578 -0
  190. package/test/http-methods/copy.test.js +35 -0
  191. package/test/http-methods/custom-http-methods.test.js +114 -0
  192. package/test/http-methods/get.test.js +412 -0
  193. package/test/http-methods/head.test.js +263 -0
  194. package/test/http-methods/lock.test.js +108 -0
  195. package/test/http-methods/mkcalendar.test.js +143 -0
  196. package/test/http-methods/mkcol.test.js +35 -0
  197. package/test/http-methods/move.test.js +42 -0
  198. package/test/http-methods/propfind.test.js +136 -0
  199. package/test/http-methods/proppatch.test.js +105 -0
  200. package/test/http-methods/report.test.js +142 -0
  201. package/test/http-methods/search.test.js +233 -0
  202. package/test/http-methods/trace.test.js +21 -0
  203. package/test/http-methods/unlock.test.js +38 -0
  204. package/test/http2/closing.test.js +270 -0
  205. package/test/http2/constraint.test.js +109 -0
  206. package/test/http2/head.test.js +34 -0
  207. package/test/http2/plain.test.js +68 -0
  208. package/test/http2/secure-with-fallback.test.js +113 -0
  209. package/test/http2/secure.test.js +67 -0
  210. package/test/http2/unknown-http-method.test.js +34 -0
  211. package/test/https/custom-https-server.test.js +58 -0
  212. package/test/https/https.test.js +136 -0
  213. package/test/imports.test.js +17 -0
  214. package/test/inject.test.js +502 -0
  215. package/test/input-validation.js +335 -0
  216. package/test/internals/all.test.js +38 -0
  217. package/test/internals/content-type-parser.test.js +111 -0
  218. package/test/internals/context.test.js +31 -0
  219. package/test/internals/decorator.test.js +156 -0
  220. package/test/internals/errors.test.js +982 -0
  221. package/test/internals/handle-request.test.js +270 -0
  222. package/test/internals/hook-runner.test.js +449 -0
  223. package/test/internals/hooks.test.js +96 -0
  224. package/test/internals/initial-config.test.js +383 -0
  225. package/test/internals/logger.test.js +163 -0
  226. package/test/internals/plugin.test.js +170 -0
  227. package/test/internals/promise.test.js +63 -0
  228. package/test/internals/reply-serialize.test.js +714 -0
  229. package/test/internals/reply.test.js +1920 -0
  230. package/test/internals/req-id-gen-factory.test.js +133 -0
  231. package/test/internals/request-validate.test.js +1402 -0
  232. package/test/internals/request.test.js +506 -0
  233. package/test/internals/schema-controller-perf.test.js +40 -0
  234. package/test/internals/server.test.js +91 -0
  235. package/test/internals/validation.test.js +352 -0
  236. package/test/issue-4959.test.js +118 -0
  237. package/test/keep-alive-timeout.test.js +42 -0
  238. package/test/listen.1.test.js +154 -0
  239. package/test/listen.2.test.js +113 -0
  240. package/test/listen.3.test.js +83 -0
  241. package/test/listen.4.test.js +168 -0
  242. package/test/listen.5.test.js +122 -0
  243. package/test/logger/instantiation.test.js +341 -0
  244. package/test/logger/logger-test-utils.js +47 -0
  245. package/test/logger/logging.test.js +460 -0
  246. package/test/logger/options.test.js +579 -0
  247. package/test/logger/request.test.js +292 -0
  248. package/test/logger/response.test.js +183 -0
  249. package/test/logger/tap-parallel-not-ok +0 -0
  250. package/test/max-requests-per-socket.test.js +113 -0
  251. package/test/middleware.test.js +37 -0
  252. package/test/noop-set.test.js +19 -0
  253. package/test/nullable-validation.test.js +187 -0
  254. package/test/options.error-handler.test.js +5 -0
  255. package/test/options.test.js +5 -0
  256. package/test/output-validation.test.js +140 -0
  257. package/test/patch.error-handler.test.js +5 -0
  258. package/test/patch.test.js +5 -0
  259. package/test/plugin.1.test.js +230 -0
  260. package/test/plugin.2.test.js +314 -0
  261. package/test/plugin.3.test.js +287 -0
  262. package/test/plugin.4.test.js +504 -0
  263. package/test/plugin.helper.js +8 -0
  264. package/test/plugin.name.display.js +10 -0
  265. package/test/post-empty-body.test.js +38 -0
  266. package/test/pretty-print.test.js +366 -0
  267. package/test/promises.test.js +125 -0
  268. package/test/proto-poisoning.test.js +145 -0
  269. package/test/put.error-handler.test.js +5 -0
  270. package/test/put.test.js +5 -0
  271. package/test/register.test.js +184 -0
  272. package/test/reply-code.test.js +148 -0
  273. package/test/reply-early-hints.test.js +100 -0
  274. package/test/reply-error.test.js +815 -0
  275. package/test/reply-trailers.test.js +445 -0
  276. package/test/reply-web-stream-locked.test.js +37 -0
  277. package/test/request-error.test.js +624 -0
  278. package/test/request-header-host.test.js +339 -0
  279. package/test/request-id.test.js +118 -0
  280. package/test/request-timeout.test.js +53 -0
  281. package/test/route-hooks.test.js +635 -0
  282. package/test/route-prefix.test.js +904 -0
  283. package/test/route-shorthand.test.js +48 -0
  284. package/test/route.1.test.js +259 -0
  285. package/test/route.2.test.js +100 -0
  286. package/test/route.3.test.js +213 -0
  287. package/test/route.4.test.js +127 -0
  288. package/test/route.5.test.js +211 -0
  289. package/test/route.6.test.js +306 -0
  290. package/test/route.7.test.js +406 -0
  291. package/test/route.8.test.js +225 -0
  292. package/test/router-options.test.js +1108 -0
  293. package/test/same-shape.test.js +124 -0
  294. package/test/schema-examples.test.js +661 -0
  295. package/test/schema-feature.test.js +2198 -0
  296. package/test/schema-serialization.test.js +1171 -0
  297. package/test/schema-special-usage.test.js +1348 -0
  298. package/test/schema-validation.test.js +1572 -0
  299. package/test/scripts/validate-ecosystem-links.test.js +339 -0
  300. package/test/serialize-response.test.js +186 -0
  301. package/test/server.test.js +347 -0
  302. package/test/set-error-handler.test.js +69 -0
  303. package/test/skip-reply-send.test.js +317 -0
  304. package/test/stream-serializers.test.js +40 -0
  305. package/test/stream.1.test.js +94 -0
  306. package/test/stream.2.test.js +129 -0
  307. package/test/stream.3.test.js +198 -0
  308. package/test/stream.4.test.js +176 -0
  309. package/test/stream.5.test.js +188 -0
  310. package/test/sync-routes.test.js +32 -0
  311. package/test/throw.test.js +359 -0
  312. package/test/toolkit.js +63 -0
  313. package/test/trust-proxy.test.js +162 -0
  314. package/test/type-provider.test.js +22 -0
  315. package/test/types/content-type-parser.test-d.ts +72 -0
  316. package/test/types/decorate-request-reply.test-d.ts +18 -0
  317. package/test/types/dummy-plugin.ts +9 -0
  318. package/test/types/errors.test-d.ts +90 -0
  319. package/test/types/fastify.test-d.ts +352 -0
  320. package/test/types/hooks.test-d.ts +550 -0
  321. package/test/types/import.ts +2 -0
  322. package/test/types/instance.test-d.ts +588 -0
  323. package/test/types/logger.test-d.ts +277 -0
  324. package/test/types/plugin.test-d.ts +97 -0
  325. package/test/types/register.test-d.ts +237 -0
  326. package/test/types/reply.test-d.ts +254 -0
  327. package/test/types/request.test-d.ts +188 -0
  328. package/test/types/route.test-d.ts +553 -0
  329. package/test/types/schema.test-d.ts +135 -0
  330. package/test/types/serverFactory.test-d.ts +37 -0
  331. package/test/types/type-provider.test-d.ts +1213 -0
  332. package/test/types/using.test-d.ts +17 -0
  333. package/test/upgrade.test.js +52 -0
  334. package/test/url-rewriting.test.js +122 -0
  335. package/test/use-semicolon-delimiter.test.js +168 -0
  336. package/test/validation-error-handling.test.js +900 -0
  337. package/test/versioned-routes.test.js +603 -0
  338. package/test/web-api.test.js +616 -0
  339. package/test/wrap-thenable.test.js +30 -0
  340. package/types/content-type-parser.d.ts +75 -0
  341. package/types/context.d.ts +22 -0
  342. package/types/errors.d.ts +92 -0
  343. package/types/hooks.d.ts +875 -0
  344. package/types/instance.d.ts +609 -0
  345. package/types/logger.d.ts +107 -0
  346. package/types/plugin.d.ts +44 -0
  347. package/types/register.d.ts +42 -0
  348. package/types/reply.d.ts +81 -0
  349. package/types/request.d.ts +95 -0
  350. package/types/route.d.ts +199 -0
  351. package/types/schema.d.ts +61 -0
  352. package/types/server-factory.d.ts +19 -0
  353. package/types/type-provider.d.ts +130 -0
  354. package/types/utils.d.ts +98 -0
package/.borp.yaml ADDED
@@ -0,0 +1,3 @@
1
+ files:
2
+ - 'test/**/*.test.js'
3
+ - 'test/**/*.test.mjs'
@@ -0,0 +1,22 @@
1
+ # See https://github.com/DavidAnson/markdownlint-cli2
2
+ config:
3
+ # Disable all rules by default.
4
+ default: false
5
+
6
+ # Enforce line length.
7
+ MD013:
8
+ line_length: 80
9
+ code_block_line_length: 120
10
+ headings: false
11
+ tables: false
12
+ strict: false
13
+ stern: false
14
+
15
+ globs:
16
+ - '**/*.md'
17
+
18
+ ignores:
19
+ - 'node_modules/**'
20
+ - 'test/**/*.md'
21
+
22
+ noProgress: true
@@ -0,0 +1 @@
1
+ *
package/GOVERNANCE.md ADDED
@@ -0,0 +1,4 @@
1
+ # Fastify Project Governance
2
+
3
+ Please see Fastify's [organization-wide governance
4
+ ](https://github.com/fastify/.github/blob/main/GOVERNANCE.md) document.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2016-present The Fastify team <https://github.com/fastify/fastify#team>
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,126 @@
1
+ # Fastify Charter
2
+
3
+ The Fastify project aims to build a fast and low-overhead web framework for
4
+ Node.js.
5
+
6
+
7
+ ## Section 0: Guiding Principles
8
+
9
+ The Fastify project is part of the [OpenJS Foundation][openjs foundation]. It
10
+ operates transparently, openly, collaboratively, and ethically. Project
11
+ proposals, timelines, and status must not merely be open, but also easily
12
+ visible to outsiders.
13
+
14
+
15
+ ## Section 1: Scope
16
+
17
+ Fastify is a web framework highly focused on providing the best developer
18
+ experience with the least overhead and a plugin architecture.
19
+
20
+ ### 1.1: In-scope
21
+
22
+ + Develop a web framework for Node.js with a focus on developer experience,
23
+ performance, and extensibility.
24
+ + Plugin Architecture
25
+ + Support web protocols
26
+ + Official plugins for common user requirements
27
+ + Documentation:
28
+ + Project (policies, processes, and releases)
29
+ + Guides and Tutorials
30
+ + Framework API
31
+ + Website
32
+ + Write easier APIs for developers
33
+ + Tools:
34
+ + CI services
35
+ + Bots to improve overall efficiency
36
+ + Releases
37
+ + Support:
38
+ + Community
39
+ + Users's issues and questions
40
+ + Contributors's pull request review
41
+
42
+ ### 1.2: Out-of-Scope
43
+
44
+ + Support versions of Node.js at EOL (end of life) stage
45
+ + Support serverless architecture
46
+ + Contributions that violate the [Code of Conduct](CODE_OF_CONDUCT.md)
47
+
48
+
49
+ ## Section 2: Relationship with OpenJS Foundation CPC.
50
+
51
+ Technical leadership for the projects within the [OpenJS Foundation][openjs
52
+ foundation] is delegated to the projects through their project charters by the
53
+ [OpenJS Foundation Cross-Project Council](https://openjsf.org/about/governance/)
54
+ (CPC). In the case of the Fastify project, it is delegated to the [Fastify
55
+ Collaborators](README.md#team). The OpenJS Foundation's business leadership is
56
+ the Board of Directors (the "Board").
57
+
58
+ This Fastify Charter reflects a carefully constructed balanced role for the
59
+ Collaborators and the CPC in the governance of the OpenJS Foundation. The
60
+ charter amendment process is for the Fastify Collaborators to propose change
61
+ using a majority of the full Fastify Organization, the proposed changes
62
+ being subject to review and approval by the CPC. The CPC may additionally make
63
+ amendments to the Collaborators charter at any time, though the CPC will not
64
+ interfere with day-to-day discussions, votes, or meetings of the Fastify
65
+ Organization.
66
+
67
+
68
+ ### 2.1 Other Formal Project Relationships
69
+
70
+ Section Intentionally Left Blank
71
+
72
+
73
+ ## Section 3: Fastify Governing Body
74
+
75
+ Fastify is governed by its [maintainers](README.md#team). See [how it is
76
+ structured](GOVERNANCE.md) for more information.
77
+
78
+
79
+ ## Section 4: Roles & Responsibilities
80
+
81
+ The roles and responsibilities of Fastify's maintainers are described in [the
82
+ project organization](GOVERNANCE.md).
83
+
84
+ ### Section 4.1 Project Operations & Management
85
+
86
+ Section Intentionally Left Blank
87
+
88
+ ### Section 4.2: Decision-making, Voting, and/or Elections
89
+
90
+ **Decision-making**
91
+
92
+ Fastify's features can be discussed in GitHub issues and/or projects. Consensus
93
+ on a discussion is reached when there is no objection by any collaborators.
94
+
95
+ When there is no consensus, Lead Maintainers will have the final say on the
96
+ topic.
97
+
98
+ **Voting, and/or Elections**
99
+
100
+ These processes are described in the [GOVERNANCE](GOVERNANCE.md) document.
101
+
102
+ ### Section 4.3: Other Project Roles
103
+
104
+ Section Intentionally Left Blank
105
+
106
+ ## Section 5: Definitions
107
+
108
+ + *Contributors*: contribute code or other artifacts, but do not have the right
109
+ to commit to the code base. Contributors work with the project’s Collaborators
110
+ to have code committed to the code base. Contributors should rarely be
111
+ encumbered by the Fastify Collaborators and never by the CPC or OpenJS
112
+ Foundation Board.
113
+
114
+ + *Collaborators*: contribute code and other artifacts, have the right to commit
115
+ to the code base, and release plugin projects. Collaborators follow the
116
+ [CONTRIBUTING](CONTRIBUTING.md) guidelines to manage the project. A
117
+ Collaborator could be encumbered by other Fastify Collaborators and never by
118
+ the CPC or OpenJS Foundation Board.
119
+
120
+ + *Lead Maintainers*: founders of the project, contribute code and other
121
+ artifacts, have the right to commit to the code base and release the project.
122
+ Lead Maintainers follow the [CONTRIBUTING](CONTRIBUTING.md) guidelines to
123
+ manage the project. A Lead Maintainer will be encumbered by the Fastify
124
+ Collaborators and by the CPC or OpenJS Foundation Board.
125
+
126
+ [openjs foundation]: https://openjsf.org
package/README.md ADDED
@@ -0,0 +1,423 @@
1
+ <div align="center"> <a href="https://fastify.dev/">
2
+ <img
3
+ src="https://github.com/fastify/graphics/raw/HEAD/fastify-landscape-outlined.svg"
4
+ width="650"
5
+ height="auto"
6
+ />
7
+ </a>
8
+ </div>
9
+
10
+ <div align="center">
11
+
12
+ [![CI](https://github.com/fastify/fastify/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/fastify/fastify/actions/workflows/ci.yml)
13
+ [![Package Manager
14
+ CI](https://github.com/fastify/fastify/actions/workflows/package-manager-ci.yml/badge.svg?branch=main)](https://github.com/fastify/fastify/actions/workflows/package-manager-ci.yml)
15
+ [![Web
16
+ site](https://github.com/fastify/fastify/actions/workflows/website.yml/badge.svg?branch=main)](https://github.com/fastify/fastify/actions/workflows/website.yml)
17
+ [![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)
18
+ [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/7585/badge)](https://bestpractices.coreinfrastructure.org/projects/7585)
19
+
20
+ </div>
21
+
22
+ <div align="center">
23
+
24
+ [![NPM
25
+ version](https://img.shields.io/npm/v/fastify.svg?style=flat)](https://www.npmjs.com/package/fastify)
26
+ [![NPM
27
+ downloads](https://img.shields.io/npm/dm/fastify.svg?style=flat)](https://www.npmjs.com/package/fastify)
28
+ [![Security Responsible
29
+ Disclosure](https://img.shields.io/badge/Security-Responsible%20Disclosure-yellow.svg)](https://github.com/fastify/fastify/blob/main/SECURITY.md)
30
+ [![Discord](https://img.shields.io/discord/725613461949906985)](https://discord.gg/fastify)
31
+ [![Contribute with Gitpod](https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod&color=blue)](https://gitpod.io/#https://github.com/fastify/fastify)
32
+ [![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/fastify)](https://github.com/sponsors/fastify#sponsors)
33
+
34
+ </div>
35
+
36
+ <br />
37
+
38
+ An efficient server implies a lower cost of the infrastructure, better
39
+ responsiveness under load, and happy users. How can you efficiently handle the
40
+ resources of your server, knowing that you are serving the highest number of
41
+ requests possible, without sacrificing security validations and handy
42
+ development?
43
+
44
+ Enter Fastify. Fastify is a web framework highly focused on providing the best
45
+ developer experience with the least overhead and a powerful plugin architecture.
46
+ It is inspired by Hapi and Express and as far as we know, it is one of the
47
+ fastest web frameworks in town.
48
+
49
+ The `main` branch refers to the Fastify `v5` release.
50
+ Check out the [`4.x` branch](https://github.com/fastify/fastify/tree/4.x) for `v4`.
51
+
52
+ ### Table of Contents
53
+
54
+ - [Quick start](#quick-start)
55
+ - [Install](#install)
56
+ - [Example](#example)
57
+ - [Core features](#core-features)
58
+ - [Benchmarks](#benchmarks)
59
+ - [Documentation](#documentation)
60
+ - [Ecosystem](#ecosystem)
61
+ - [Support](#support)
62
+ - [Team](#team)
63
+ - [Hosted by](#hosted-by)
64
+ - [License](#license)
65
+
66
+
67
+ ### Quick start
68
+
69
+ Create a folder and make it your current working directory:
70
+
71
+ ```sh
72
+ mkdir my-app
73
+ cd my-app
74
+ ```
75
+
76
+ Generate a fastify project with `npm init`:
77
+
78
+ ```sh
79
+ npm init fastify
80
+ ```
81
+
82
+ Install dependencies:
83
+
84
+ ```sh
85
+ npm i
86
+ ```
87
+
88
+ To start the app in dev mode:
89
+
90
+ ```sh
91
+ npm run dev
92
+ ```
93
+
94
+ For production mode:
95
+
96
+ ```sh
97
+ npm start
98
+ ```
99
+
100
+ Under the hood `npm init` downloads and runs [Fastify
101
+ Create](https://github.com/fastify/create-fastify), which in turn uses the
102
+ generate functionality of [Fastify CLI](https://github.com/fastify/fastify-cli).
103
+
104
+
105
+ ### Install
106
+
107
+ To install Fastify in an existing project as a dependency:
108
+
109
+ ```sh
110
+ npm i fastify
111
+ ```
112
+
113
+ ### Example
114
+
115
+ ```js
116
+ // Require the framework and instantiate it
117
+
118
+ // ESM
119
+ import Fastify from 'fastify'
120
+
121
+ const fastify = Fastify({
122
+ logger: true
123
+ })
124
+ // CommonJs
125
+ const fastify = require('fastify')({
126
+ logger: true
127
+ })
128
+
129
+ // Declare a route
130
+ fastify.get('/', (request, reply) => {
131
+ reply.send({ hello: 'world' })
132
+ })
133
+
134
+ // Run the server!
135
+ fastify.listen({ port: 3000 }, (err, address) => {
136
+ if (err) throw err
137
+ // Server is now listening on ${address}
138
+ })
139
+ ```
140
+
141
+ With async-await:
142
+
143
+ ```js
144
+ // ESM
145
+ import Fastify from 'fastify'
146
+
147
+ const fastify = Fastify({
148
+ logger: true
149
+ })
150
+ // CommonJs
151
+ const fastify = require('fastify')({
152
+ logger: true
153
+ })
154
+
155
+ fastify.get('/', async (request, reply) => {
156
+ reply.type('application/json').code(200)
157
+ return { hello: 'world' }
158
+ })
159
+
160
+ fastify.listen({ port: 3000 }, (err, address) => {
161
+ if (err) throw err
162
+ // Server is now listening on ${address}
163
+ })
164
+ ```
165
+
166
+ Do you want to know more? Head to the <a
167
+ href="./docs/Guides/Getting-Started.md"><code><b>Getting Started</b></code></a>.
168
+ If you learn best by reading code, explore the official [demo](https://github.com/fastify/demo).
169
+
170
+ > ## Note
171
+ > `.listen` binds to the local host, `localhost`, interface by default
172
+ > (`127.0.0.1` or `::1`, depending on the operating system configuration). If
173
+ > you are running Fastify in a container (Docker,
174
+ > [GCP](https://cloud.google.com/), etc.), you may need to bind to `0.0.0.0`. Be
175
+ > careful when listening on all interfaces; it comes with inherent
176
+ > [security
177
+ > risks](https://web.archive.org/web/20170711105010/https://snyk.io/blog/mongodb-hack-and-secure-defaults/).
178
+ > See [the documentation](./docs/Reference/Server.md#listen) for more
179
+ > information.
180
+
181
+ ### Core features
182
+
183
+ - **Highly performant:** as far as we know, Fastify is one of the fastest web
184
+ frameworks in town, depending on the code complexity we can serve up to 76+
185
+ thousand requests per second.
186
+ - **Extensible:** Fastify is fully extensible via its hooks, plugins, and
187
+ decorators.
188
+ - **Schema-based:** even if it is not mandatory we recommend using [JSON
189
+ Schema](https://json-schema.org/) to validate your routes and serialize your
190
+ outputs. Internally Fastify compiles the schema in a highly performant
191
+ function.
192
+ - **Logging:** logs are extremely important but are costly; we chose the best
193
+ logger to almost remove this cost, [Pino](https://github.com/pinojs/pino)!
194
+ - **Developer friendly:** the framework is built to be very expressive and help
195
+ developers in their daily use without sacrificing performance and
196
+ security.
197
+
198
+ ### Benchmarks
199
+
200
+ __Machine:__ EX41S-SSD, Intel Core i7, 4Ghz, 64GB RAM, 4C/8T, SSD.
201
+
202
+ __Method__: `autocannon -c 100 -d 40 -p 10 localhost:3000` * 2, taking the
203
+ second average
204
+
205
+ | Framework | Version | Router? | Requests/sec |
206
+ | :----------------- | :------------------------- | :----------: | ------------: |
207
+ | Express | 4.17.3 | &#10003; | 14,200 |
208
+ | hapi | 20.2.1 | &#10003; | 42,284 |
209
+ | Restify | 8.6.1 | &#10003; | 50,363 |
210
+ | Koa | 2.13.0 | &#10007; | 54,272 |
211
+ | **Fastify** | **4.0.0** | **&#10003;** | **77,193** |
212
+ | - | | | |
213
+ | `http.Server` | 16.14.2 | &#10007; | 74,513 |
214
+
215
+ These benchmarks taken using https://github.com/fastify/benchmarks. This is a
216
+ synthetic "hello world" benchmark that aims to evaluate the framework overhead.
217
+ The overhead that each framework has on your application depends on your
218
+ application. You should __always__ benchmark if performance matters to you.
219
+
220
+ ## Documentation
221
+ * [__`Getting Started`__](./docs/Guides/Getting-Started.md)
222
+ * [__`Guides`__](./docs/Guides/Index.md)
223
+ * [__`Server`__](./docs/Reference/Server.md)
224
+ * [__`Routes`__](./docs/Reference/Routes.md)
225
+ * [__`Encapsulation`__](./docs/Reference/Encapsulation.md)
226
+ * [__`Logging`__](./docs/Reference/Logging.md)
227
+ * [__`Middleware`__](./docs/Reference/Middleware.md)
228
+ * [__`Hooks`__](./docs/Reference/Hooks.md)
229
+ * [__`Decorators`__](./docs/Reference/Decorators.md)
230
+ * [__`Validation and Serialization`__](./docs/Reference/Validation-and-Serialization.md)
231
+ * [__`Fluent Schema`__](./docs/Guides/Fluent-Schema.md)
232
+ * [__`Lifecycle`__](./docs/Reference/Lifecycle.md)
233
+ * [__`Reply`__](./docs/Reference/Reply.md)
234
+ * [__`Request`__](./docs/Reference/Request.md)
235
+ * [__`Errors`__](./docs/Reference/Errors.md)
236
+ * [__`Content Type Parser`__](./docs/Reference/ContentTypeParser.md)
237
+ * [__`Plugins`__](./docs/Reference/Plugins.md)
238
+ * [__`Testing`__](./docs/Guides/Testing.md)
239
+ * [__`Benchmarking`__](./docs/Guides/Benchmarking.md)
240
+ * [__`How to write a good plugin`__](./docs/Guides/Write-Plugin.md)
241
+ * [__`Plugins Guide`__](./docs/Guides/Plugins-Guide.md)
242
+ * [__`HTTP2`__](./docs/Reference/HTTP2.md)
243
+ * [__`Long Term Support`__](./docs/Reference/LTS.md)
244
+ * [__`TypeScript and types support`__](./docs/Reference/TypeScript.md)
245
+ * [__`Serverless`__](./docs/Guides/Serverless.md)
246
+ * [__`Recommendations`__](./docs/Guides/Recommendations.md)
247
+
248
+ ## Ecosystem
249
+
250
+ - [Core](./docs/Guides/Ecosystem.md#core) - Core plugins maintained by the
251
+ _Fastify_ [team](#team).
252
+ - [Community](./docs/Guides/Ecosystem.md#community) - Community-supported
253
+ plugins.
254
+ - [Live Examples](https://github.com/fastify/example) - Multirepo with a broad
255
+ set of real working examples.
256
+ - [Discord](https://discord.gg/D3FZYPy) - Join our discord server and chat with
257
+ the maintainers.
258
+
259
+ ## Support
260
+ Please visit [Fastify help](https://github.com/fastify/help) to view prior
261
+ support issues and to ask new support questions.
262
+
263
+ Version 3 of Fastify and lower are EOL and will not receive any security or bug
264
+ fixes.
265
+
266
+ Fastify's partner, HeroDevs, provides commercial security fixes for all
267
+ unsupported versions at [https://herodevs.com/support/fastify-nes][hd-link].
268
+ Fastify's supported version matrix is available in the
269
+ [Long Term Support][lts-link] documentation.
270
+
271
+ ## Contributing
272
+
273
+ Whether reporting bugs, discussing improvements and new ideas, or writing code,
274
+ we welcome contributions from anyone and everyone. Please read the [CONTRIBUTING](./CONTRIBUTING.md)
275
+ guidelines before submitting pull requests.
276
+
277
+ ## Team
278
+
279
+ _Fastify_ is the result of the work of a great community. Team members are
280
+ listed in alphabetical order.
281
+
282
+ **Lead Maintainers:**
283
+ * [__Matteo Collina__](https://github.com/mcollina),
284
+ <https://x.com/matteocollina>, <https://www.npmjs.com/~matteo.collina>
285
+ * [__Tomas Della Vedova__](https://github.com/delvedor),
286
+ <https://x.com/delvedor>, <https://www.npmjs.com/~delvedor>
287
+ * [__KaKa Ng__](https://github.com/climba03003),
288
+ <https://www.npmjs.com/~climba03003>
289
+ * [__Manuel Spigolon__](https://github.com/eomm),
290
+ <https://x.com/manueomm>, <https://www.npmjs.com/~eomm>
291
+ * [__James Sumners__](https://github.com/jsumners),
292
+ <https://x.com/jsumners79>, <https://www.npmjs.com/~jsumners>
293
+
294
+ ### Fastify Core team
295
+ * [__Aras Abbasi__](https://github.com/uzlopak),
296
+ <https://www.npmjs.com/~uzlopak>
297
+ * [__Harry Brundage__](https://github.com/airhorns/),
298
+ <https://x.com/harrybrundage>, <https://www.npmjs.com/~airhorns>
299
+ * [__Matteo Collina__](https://github.com/mcollina),
300
+ <https://x.com/matteocollina>, <https://www.npmjs.com/~matteo.collina>
301
+ * [__Gürgün Dayıoğlu__](https://github.com/gurgunday),
302
+ <https://www.npmjs.com/~gurgunday>
303
+ * [__Tomas Della Vedova__](https://github.com/delvedor),
304
+ <https://x.com/delvedor>, <https://www.npmjs.com/~delvedor>
305
+ * [__Carlos Fuentes__](https://github.com/metcoder95),
306
+ <https://x.com/metcoder95>, <https://www.npmjs.com/~metcoder95>
307
+ * [__Vincent Le Goff__](https://github.com/zekth)
308
+ * [__Luciano Mammino__](https://github.com/lmammino),
309
+ <https://x.com/loige>, <https://www.npmjs.com/~lmammino>
310
+ * [__Jean Michelet__](https://github.com/jean-michelet),
311
+ <https://www.npmjs.com/~jean-michelet>
312
+ * [__KaKa Ng__](https://github.com/climba03003),
313
+ <https://www.npmjs.com/~climba03003>
314
+ * [__Luis Orbaiceta__](https://github.com/luisorbaiceta),
315
+ <https://x.com/luisorbai>, <https://www.npmjs.com/~luisorbaiceta>
316
+ * [__Maksim Sinik__](https://github.com/fox1t),
317
+ <https://x.com/maksimsinik>, <https://www.npmjs.com/~fox1t>
318
+ * [__Manuel Spigolon__](https://github.com/eomm),
319
+ <https://x.com/manueomm>, <https://www.npmjs.com/~eomm>
320
+ * [__James Sumners__](https://github.com/jsumners),
321
+ <https://x.com/jsumners79>, <https://www.npmjs.com/~jsumners>
322
+
323
+ ### Fastify Plugins team
324
+ * [__Harry Brundage__](https://github.com/airhorns/),
325
+ <https://x.com/harrybrundage>, <https://www.npmjs.com/~airhorns>
326
+ * [__Simone Busoli__](https://github.com/simoneb),
327
+ <https://x.com/simonebu>, <https://www.npmjs.com/~simoneb>
328
+ * [__Dan Castillo__](https://github.com/dancastillo),
329
+ <https://www.npmjs.com/~dancastillo>
330
+ * [__Matteo Collina__](https://github.com/mcollina),
331
+ <https://x.com/matteocollina>, <https://www.npmjs.com/~matteo.collina>
332
+ * [__Gürgün Dayıoğlu__](https://github.com/gurgunday),
333
+ <https://www.npmjs.com/~gurgunday>
334
+ * [__Tomas Della Vedova__](https://github.com/delvedor),
335
+ <https://x.com/delvedor>, <https://www.npmjs.com/~delvedor>
336
+ * [__Carlos Fuentes__](https://github.com/metcoder95),
337
+ <https://x.com/metcoder95>, <https://www.npmjs.com/~metcoder95>
338
+ * [__Vincent Le Goff__](https://github.com/zekth)
339
+ * [__Jean Michelet__](https://github.com/jean-michelet),
340
+ <https://www.npmjs.com/~jean-michelet>
341
+ * [__KaKa Ng__](https://github.com/climba03003),
342
+ <https://www.npmjs.com/~climba03003>
343
+ * [__Maksim Sinik__](https://github.com/fox1t),
344
+ <https://x.com/maksimsinik>, <https://www.npmjs.com/~fox1t>
345
+ * [__Frazer Smith__](https://github.com/Fdawgs), <https://www.npmjs.com/~fdawgs>
346
+ * [__Manuel Spigolon__](https://github.com/eomm),
347
+ <https://x.com/manueomm>, <https://www.npmjs.com/~eomm>
348
+ * [__Antonio Tripodi__](https://github.com/Tony133), <https://www.npmjs.com/~tony133>
349
+
350
+ ### Emeritus Contributors
351
+ Great contributors to a specific area of the Fastify ecosystem will be invited
352
+ to join this group by Lead Maintainers when they decide to step down from the
353
+ active contributor's group.
354
+
355
+ * [__Tommaso Allevi__](https://github.com/allevo),
356
+ <https://x.com/allevitommaso>, <https://www.npmjs.com/~allevo>
357
+ * [__Ethan Arrowood__](https://github.com/Ethan-Arrowood/),
358
+ <https://x.com/arrowoodtech>, <https://www.npmjs.com/~ethan_arrowood>
359
+ * [__Çağatay Çalı__](https://github.com/cagataycali),
360
+ <https://x.com/cagataycali>, <https://www.npmjs.com/~cagataycali>
361
+ * [__David Mark Clements__](https://github.com/davidmarkclements),
362
+ <https://x.com/davidmarkclem>,
363
+ <https://www.npmjs.com/~davidmarkclements>
364
+ * [__dalisoft__](https://github.com/dalisoft), <https://x.com/dalisoft>,
365
+ <https://www.npmjs.com/~dalisoft>
366
+ * [__Dustin Deus__](https://github.com/StarpTech),
367
+ <https://x.com/dustindeus>, <https://www.npmjs.com/~starptech>
368
+ * [__Denis Fäcke__](https://github.com/SerayaEryn),
369
+ <https://x.com/serayaeryn>, <https://www.npmjs.com/~serayaeryn>
370
+ * [__Rafael Gonzaga__](https://github.com/rafaelgss),
371
+ <https://x.com/_rafaelgss>, <https://www.npmjs.com/~rafaelgss>
372
+ * [__Trivikram Kamat__](https://github.com/trivikr),
373
+ <https://x.com/trivikram>, <https://www.npmjs.com/~trivikr>
374
+ * [__Ayoub El Khattabi__](https://github.com/AyoubElk),
375
+ <https://x.com/ayoubelkh>, <https://www.npmjs.com/~ayoubelk>
376
+ * [__Cemre Mengu__](https://github.com/cemremengu),
377
+ <https://x.com/cemremengu>, <https://www.npmjs.com/~cemremengu>
378
+ * [__Salman Mitha__](https://github.com/salmanm),
379
+ <https://www.npmjs.com/~salmanm>
380
+ * [__Nathan Woltman__](https://github.com/nwoltman),
381
+ <https://x.com/NathanWoltman>, <https://www.npmjs.com/~nwoltman>
382
+
383
+ ## Hosted by
384
+
385
+ [<img
386
+ src="https://github.com/openjs-foundation/artwork/blob/main/openjs_foundation/openjs_foundation-logo-horizontal-color.png?raw=true"
387
+ width="250px;"/>](https://openjsf.org/projects)
388
+
389
+ We are an [At-Large
390
+ Project](https://github.com/openjs-foundation/cross-project-council/blob/HEAD/PROJECT_PROGRESSION.md#at-large-projects)
391
+ in the [OpenJS Foundation](https://openjsf.org/).
392
+
393
+ ## Sponsors
394
+
395
+ Support this project by becoming a [SPONSOR](./SPONSORS.md)!
396
+ Fastify has an [Open Collective](https://opencollective.com/fastify)
397
+ page where we accept and manage financial contributions.
398
+
399
+ ## Acknowledgments
400
+
401
+ This project is kindly sponsored by:
402
+ - [NearForm](https://nearform.com)
403
+ - [Platformatic](https://platformatic.dev)
404
+
405
+ Past Sponsors:
406
+ - [LetzDoIt](https://www.letzdoitapp.com/)
407
+
408
+ This list includes all companies that support one or more team members
409
+ in maintaining this project.
410
+
411
+ ## License
412
+
413
+ Licensed under [MIT](./LICENSE).
414
+
415
+ For your convenience, here is a list of all the licenses of our production
416
+ dependencies:
417
+ - MIT
418
+ - ISC
419
+ - BSD-3-Clause
420
+ - BSD-2-Clause
421
+
422
+ [hd-link]: https://www.herodevs.com/support/fastify-nes?utm_source=fastify&utm_medium=link&utm_campaign=github_readme
423
+ [lts-link]: https://fastify.dev/docs/latest/Reference/LTS/