You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Build and manage the [`fast-json-stringify`](https://www.npmjs.com/package/fast-json-stringify) instances for the Fastify framework.
8
+
This package is responsible for compiling the application's `response` JSON schemas into optimized functions to speed up the response time.
8
9
9
10
## Versions
10
11
@@ -17,7 +18,7 @@ This package is responsible for compiling the application's `response` JSON sche
17
18
18
19
### fast-json-stringify Configuration
19
20
20
-
The `fast-json-stringify` configuration is the default one. You can check it the default settings in the [`fast-json-stringify` option](https://github.com/fastify/fast-json-stringify/#options) documentation.
21
+
The `fast-json-stringify` configuration is the default one. You can check the default settings in the [`fast-json-stringify` option](https://github.com/fastify/fast-json-stringify/#options) documentation.
21
22
22
23
You can also override the default configuration by passing the [`serializerOpts`](https://fastify.dev/docs/latest/Reference/Server/#serializeropts) configuration to the Fastify instance.
23
24
@@ -28,7 +29,7 @@ If you need to provide to your server instance a different version, refer to [th
28
29
29
30
### fast-json-stringify Standalone
30
31
31
-
`[email protected]` introduces the [standalone feature](https://github.com/fastify/fast-json-stringify#standalone) that let you to pre-compile your schemas and use them in your application for a faster startup.
32
+
`[email protected]` introduces the [standalone feature](https://github.com/fastify/fast-json-stringify#standalone) that lets you pre-compile your schemas and use them in your application for a faster startup.
32
33
33
34
To use this feature, you must be aware of the following:
34
35
@@ -43,7 +44,7 @@ To accomplish this, you must use a new compiler: `@fastify/fast-json-stringify-c
43
44
44
45
You must provide 2 parameters to this compiler:
45
46
46
-
-`readMode: false`: a boolean to indicate that you want generate the schemas functions string.
47
+
-`readMode: false`: a boolean to indicate that you want to generate the schemas functions string.
47
48
-`storeFunction`" a sync function that must store the source code of the schemas functions. You may provide an async function too, but you must manage errors.
48
49
49
50
When `readMode: false`, **the compiler is meant to be used in development ONLY**.
@@ -84,7 +85,7 @@ app.ready().then(() => {
84
85
At this stage, you should have a file for every route's schema.
85
86
To use them, you must use the `@fastify/fast-json-stringify-compiler/standalone` with the parameters:
86
87
87
-
-`readMode: true`: a boolean to indicate that you want read and use the schemas functions string.
88
+
-`readMode: true`: a boolean to indicate that you want to read and use the schemas functions string.
88
89
-`restoreFunction`" a sync function that must return a function to serialize the route's payload.
89
90
90
91
Important keep away before you continue reading the documentation:
@@ -120,7 +121,7 @@ app.listen({ port: 3000 })
120
121
121
122
### How it works
122
123
123
-
This module provide a factory function to produce [Serializer Compilers](https://fastify.dev/docs/latest/Reference/Server/#serializercompiler) functions.
124
+
This module provides a factory function to produce [Serializer Compilers](https://fastify.dev/docs/latest/Reference/Server/#serializercompiler) functions.
0 commit comments