A plugin for Fastify to minify HTML, JS, JSON and CSS. And you can transform any response as your like.
const fastify = require("fastify")();
fastify.register(require("fastify-minify"), {
cache: 2000,
});
fastify.get("/minfiedCSS", function (req, rep) {
const css = getSomeCSS();
rep.type("text/css").send(this.minifyCSS(css));
});
Three methods are added to the fastify instance. minifyHTML
, minifyJS
and minifyCSS
(See transformers
). All of them take a string as input and return a promise.
By default no response is minified automatically. You can enable it with global
or minInfix
.
fastify.register(require("fastify-minify"), {
cache: 2500,
global: true,
minInfix: (req, filePath) => req.query.mini === "true",
validate: (req, rep, payload) => typeof payload === "string",
htmlOptions: { caseSensitive: true },
jsOptions: { "keep-classnames": true },
cssOptions: {},
transformers: [
{
suffix: "txt",
contentType: "text/plain",
func: value => value.toUpperCase(),
decorate: "upperCaseText",
useCache: false
}
]
});
- Size of the lru-cache or a cache object with the functions
set(string, string)
andget(string)=>string | get(string)=>Promise<string>
. tiny-lru is used by default. It is used to cache the minification results. - default:
0
- type: number | object
- If truthy, every response with content type html, js, json or css (See
transformers
) will be minified. Seevalidate
. - default:
false
- type: boolean
- If truthy or a function (
function(req, filePath)
) that returns a truthy value, a new path for static files will be added with min-infix e.g.public/foo.min.css
forpublic/foo.css
. You need to have fastify-static installed to use it. The function is calledonRequest
. โ If you have static files with min-infix, they will be ignored. - default:
false
- type: boolean | function
- If this function (
function(req, rep, payload)
) returns a truthy value, the payload will be minified. It is calledonSend
and only ifglobal
orminInfix
is enabled. - default:
() => true
- type: function
- An object that will be passed to html-minifier-terser.
- default:
{}
- type: object
- An object that will be passed to terser.
- default:
{}
- type: object
- An object that will be passed to csso.
- default:
{}
- type: object
- An array of transformers to transform any response. There are 4 transformers built-in (JS, HTML, CSS, JSON).
suffix
- Suffix of files to transform. Used when
minInfix
is enabled. - type: string | array of strings
- Suffix of files to transform. Used when
contentType
- Content type of response. Used when
global
orminInfix
is enabled. - type: string | array of strings
- Content type of response. Used when
func
- Function to transform the response.
- type: function (
string => string | string => Promise<string>
)
decorate
(optional)- Method name of the decorated function.
- type: string
useCache
(optional)- If true, cache is used when transforming. Enabled by default.
- type: boolean
- To disable one of the built-in transformers you can add a transformer with respective suffix e.g.
{ suffix: "js", func: null }
- default:
[]
- type: array