npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@fastify/fast-json-stringify-compiler

v5.0.1

Published

Build and manage the fast-json-stringify instances for the fastify framework

Downloads

6,228,539

Readme

@fastify/fast-json-stringify-compiler

Build and manage the fast-json-stringify instances for the fastify framework. This package is responsible for compiling the application's response JSON schemas into optimized functions to speed up the response time.

js-standard-style CI

Versions

| @fastify/fast-json-stringify-compiler | fast-json-stringify | Supported fastify | |----------------------------------------:|----------------------:|--------------------:| | v1.x | v3.x | ^3.x | | v2.x | v3.x | ^4.x | | v3.x | v4.x | ^4.x | | v4.x | v5.x | ^4.x |

fast-json-stringify Configuration

The fast-json-stringify configuration is the default one. You can check it the default settings in the fast-json-stringify option documentation.

You can also override the default configuration by passing the serializerOpts configuration to the Fastify instance.

Usage

This module is already used as default by Fastify. If you need to provide to your server instance a different version, refer to the official doc.

fast-json-stringify Standalone

[email protected] introduces the standalone feature that let you to pre-compile your schemas and use them in your application for a faster startup.

To use this feature, you must be aware of the following:

  1. You must generate and save the application's compiled schemas.
  2. Read the compiled schemas from the file and provide them back to your Fastify application.

Generate and save the compiled schemas

Fastify helps you to generate the serialization schemas functions and it is your choice to save them where you want. To accomplish this, you must use a new compiler: @fastify/fast-json-stringify-compiler/standalone.

You must provide 2 parameters to this compiler:

  • readMode: false: a boolean to indicate that you want generate the schemas functions string.
  • 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.

When readMode: false, the compiler is meant to be used in development ONLY.

const { StandaloneSerializer } = require('@fastify/fast-json-stringify-compiler')

const factory = StandaloneSerializer({
  readMode: false,
  storeFunction (routeOpts, schemaSerializationCode) {
    // routeOpts is like: { schema, method, url, httpStatus }
    // schemaSerializationCode is a string source code that is the compiled schema function
    const fileName = generateFileName(routeOpts)
    fs.writeFileSync(path.join(__dirname, fileName), schemaSerializationCode)
  }
})

const app = fastify({
  jsonShorthand: false,
  schemaController: {
    compilersFactory: {
      buildSerializer: factory
    }
  }
})

// ... add all your routes with schemas ...

app.ready().then(() => {
  // at this stage all your schemas are compiled and stored in the file system
  // now it is important to turn off the readMode
})

Read the compiled schemas functions

At this stage, you should have a file for every route's schema. To use them, you must use the @fastify/fast-json-stringify-compiler/standalone with the parameters:

  • readMode: true: a boolean to indicate that you want read and use the schemas functions string.
  • restoreFunction" a sync function that must return a function to serialize the route's payload.

Important keep away before you continue reading the documentation:

  • when you use the readMode: true, the application schemas are not compiled (they are ignored). So, if you change your schemas, you must recompile them!
  • as you can see, you must relate the route's schema to the file name using the routeOpts object. You may use the routeOpts.schema.$id field to do so, it is up to you to define a unique schema identifier.
const { StandaloneSerializer } = require('@fastify/fast-json-stringify-compiler')

const factory = StandaloneSerializer({
  readMode: true,
  restoreFunction (routeOpts) {
    // routeOpts is like: { schema, method, url, httpStatus }
    const fileName = generateFileName(routeOpts)
    return require(path.join(__dirname, fileName))
  }
})

const app = fastify({
  jsonShorthand: false,
  schemaController: {
    compilersFactory: {
      buildSerializer: factory
    }
  }
})

// ... add all your routes with schemas as before...

app.listen({ port: 3000 })

How it works

This module provide a factory function to produce Serializer Compilers functions.

License

Licensed under MIT.