Serve static files
$ npm install serve-static
var serveStatic = require'serve-static'
Create a new middleware function to serve files from within a given root
directory. The file to serve will be determined by combining
with the provided root directory. When a file is not found, instead of
sending a 404 response, this module will instead call
next() to move on
to the next middleware, allowing for stacking and fall-backs.
Set how "dotfiles" are treated when encountered. A dotfile is a file
or directory that begins with a dot ("."). Note this check is done on
the path itself without checking if the path actually exists on the
root is specified, only the dotfiles above the root are
checked (i.e. the root itself can be within a dotfile when set
The default value is
'allow'No special treatment for dotfiles.
'deny'Deny a request for a dotfile and 403/
'ignore'Pretend like the dotfile does not exist and 404/
Enable or disable etag generation, defaults to true.
Set file extension fallbacks. When set, if a file is not found, the given
extensions will be added to the file name and search for. The first that
exists will be served. Example:
The default value is
Set the middleware to have client errors fall-through as just unhandled
requests, otherwise forward a client error. The difference is that client
errors like a bad request or a request to a non-existent file will cause
this middleware to simply
next() to your next middleware when this value
true. When this value is
false, these errors (even 404s), will invoke
true is desired such that multiple physical directories can be
mapped to the same web address or for routes to fill in non-existent files.
false can be used if this middleware is mounted at a path that
is designed to be strictly a single file system directory, which allows for
short-circuiting 404s for less overhead. This middleware will also reply to
The default value is
By default this module will send "index.html" files in response to a request
on a directory. To disable this set
false or to supply a new index pass a
string or an array in preferred order.
Enable or disable
Last-Modified header, defaults to true. Uses the file
system's last modified value.
Provide a max-age in milliseconds for http caching, defaults to 0. This can also be a string accepted by the ms module.
Redirect to trailing "/" when the pathname is a dir. Defaults to
Function to set custom headers on response. Alterations to the headers need to
occur synchronously. The function is called as
fn(res, path, stat), where
the arguments are:
resthe response object
paththe file path that is being sent
statthe stat object of the file that is being sent
var finalhandler = require'finalhandler'var http = require'http'var serveStatic = require'serve-static'// Serve up public/ftp foldervar serve = serveStatic'public/ftp' 'index': 'index.html' 'index.htm'// Create servervar server = httpcreateServervar done = finalhandlerreq resservereq res done// Listenserverlisten3000
var contentDisposition = require'content-disposition'var finalhandler = require'finalhandler'var http = require'http'var serveStatic = require'serve-static'// Serve up public/ftp foldervar serve = serveStatic'public/ftp''index': false'setHeaders': setHeaders// Set header to force downloadressetHeader'Content-Disposition' contentDispositionpath// Create servervar server = httpcreateServervar done = finalhandlerreq resservereq res done// Listenserverlisten3000
This is a simple example of using Express.
var express = require'express'var serveStatic = require'serve-static'var app = expressappuseserveStatic'public/ftp' 'index': 'default.html' 'default.htm'applisten3000
This example shows a simple way to search through multiple directories.
Files are look for in
public-optimized/ first, then
public/ second as
var express = require'express'var serveStatic = require'serve-static'var app = expressappuseserveStatic__dirname + '/public-optimized'appuseserveStatic__dirname + '/public'applisten3000
This example shows how to set a different max age depending on the served file type. In this example, HTML files are not cached, while everything else is for 1 day.
var express = require'express'var serveStatic = require'serve-static'var app = expressappuseserveStatic__dirname + '/public'maxAge: '1d'setHeaders: setCustomCacheControlapplisten3000if serveStaticmimelookuppath === 'text/html'// Custom Cache-Control for HTML filesressetHeader'Cache-Control' 'public, max-age=0'