$ npm install sirv
The optimized and lightweight middleware for serving requests to static assets
You may use sirv
as a very fast and lightweight alternative to serve-static
. While (currently), sirv
may not have the same options, it handles the majority of use cases without a hitch!
The massive performance advantage over serve-static
is explained by not relying on the file system for existence checks on every request. These are expensive interactions & must be avoided whenever possible! Instead, sirv
performs all its work upfront and recycles the initial resultset for existence checks & writing header values based on files' stats.
This middleware will work out of the box for Polka and other Express-like frameworks. It requires very little effort to modify/wrap it for servers that don't accept the (req, res, next)
signature.
:bulb: For a feature-complete CLI application, check out the sibling sirv-cli
package as an alternative to zeit/serve
~!
$ npm install --save sirv
const sirv = require('sirv');
const polka = require('polka');
const compress = require('compression')();
// Init `sirv` handler
const assets = sirv('public', {
maxAge: 31536000, // 1Y
immutable: true
});
polka()
.use(compress, assets)
.use('/api', require('./api'))
.listen(3000)
.then(() => {
console.log('> Ready on localhost:3000~!');
});
Returns: Function
The returned function is a middleware in the standard Express-like signature: (req, res, next)
, where req
is the http.IncomingMessage
, res
is the http.ServerResponse
, and next
(in this case) is the function to call if no file was found for the given path.
For sirv
, the next()
callback is functionally synonymous with opts.onNoMatch
; however next()
is given priority if/when defined and will not receive the res
as an argument.
Type: String
Default: .
The directory from which to read and serve assets. It is resolved to an absolute path — you must provide an absolute path yourself if process.cwd()
is not the correct assumption.
Type: Boolean
Default: false
Enable "dev" mode, which disables/skips caching. Instead, sirv
will traverse the file system on every request.
Additionally, dev
mode will ignore maxAge
, immutable
, etag
, and setHeaders
as these options are geared towards production response headers.
Important: Do not use
dev
mode in production!
Type: Boolean
Default: false
Generate and attach an ETag
header to responses.
Type: Boolean
Default: false
Allow requests to dotfiles (files or directories beginning with a .
).
Type: Array
Default: ['html', 'htm']
The file extension fallbacks to check for if a pathame is not initially found. For example, if a /login
request cannot find a login
filename, it will then look for login.html
and login.htm
before giving up~!
Important: Actually,
sirv
will also look forlogin/index.html
andlogin/index.htm
before calling it quits.
Type: Number
Default: undefined
Enables the Cache-Control
header on responses & sets the max-age
value (in seconds). For example 31536000
is equivalent to one year.
Type: Boolean
Default: false
Appends the immutable
directive on your Cache-Control
header, used for uniquely-named assets that will not change!
Note: Requires
opts.maxAge
to contain a value!
Type: Boolean
Default: false
Treat the directory as a single-page application. When true
, the directory's index page (eg, index.html
) will be sent if the request asset does not exist.
For example, if "/about" is requested but no variants of that file exist, then the response for "/" is sent instead:
// Note: This is psuedo code to illustrate what's happening
// Request: "/about"
let file = find(['/about', '/about.html', '/about.htm', '/about/index.html', '/about.htm']);
if (file) {
send(file);
} else if (opts.single) {
file = find(['/', '/index.html', '/index.htm']);
send(file);
} else {
// next() or 404
}
Type: Function
A custom function to run if a file cannot be found for a given request.
By default, sirv
will send a basic (404) Not found
response.
The function receives the current req <IncomingMessage>, res <ServerResponse>
pair for as its two arguments.
Note: This won't run if a
next
callback has been provided to the middleware; seesirv
description.
Type: Function
A custom function to append or change any headers on the outgoing response. There is no default.
Its signature is (res, pathname, stats)
, where res
is the ServerResponse
, pathname
is incoming request path (stripped of queries), and stats
is the file's result from fs.statSync
.
MIT © Luke Edwards
© 2010 - cnpmjs.org x YWFE | Home | YWFE