Plugin for serving static files as fast as possible.

npm install --save fastify-static

const fastify = require('fastify')()
const path = require('path')

fastify.register(require('fastify-static'), {
  root: path.join(__dirname, 'public'),
  prefix: '/public/', // optional: default '/'
})

fastify.get('/another/path', function (req, reply) {
  reply.sendFile('myHtml.html') // serving path.join(__dirname, 'public', 'myHtml.html') directly
})

The absolute path of the directory that contains the files to serve. The file to serve will be determined by combining req.url with the provided root directory.

Default: '/'

A URL path prefix used to create a virtual mount path for the static directory.

Default: true

A flag that define if the fastify route hide-schema attribute is hidden or not

Default: undefined

A function to set custom headers on the response. Alterations to the headers must be done synchronously. The function is called as fn(res, path, stat), where the arguments are:

• res The response object.
• path The path of the file that is being sent.
• stat The stat object of the file that is being sent.

The following options are also supported and will be passed directly to the send module:

• acceptRanges
• cacheControl
• dotfiles
• etag
• extensions
• immutable
• index
• lastModified
• maxAge

If a request matches the URL prefix but a file cannot be found for the request, Fastify's 404 handler will be called. You can set a custom 404 handler with fastify.setNotFoundHandler().

If an error occurs while trying to send a file, the error will be passed to Fastify's error handler. You can set a custom error handler with fastify.setErrorHandler().

Licensed under MIT