serve-index
Serves pages that contain directory listings for a given path.
Install
$ npm install serve-index
API
var serveIndex =
serveIndex(path, options)
Returns middlware that serves an index of the directory in the given path
.
The path
is based off the req.url
value, so a req.url
of '/some/dir
with a path
of 'public'
will look at 'public/some/dir'
. If you are using
something like express
, you can change the URL "base" with app.use
(see
the express example).
Options
Serve index accepts these properties in the options object.
filter
Apply this filter function to files. Defaults to false
. The filter
function
is called for each file, with the signature filter(filename, index, files, dir)
where filename
is the name of the file, index
is the array index, files
is
the array of files and dir
is the absolute path the file is located (and thus,
the directory the listing is for).
hidden
Display hidden (dot) files. Defaults to false
.
icons
Display icons. Defaults to false
.
stylesheet
Optional path to a CSS stylesheet. Defaults to a built-in stylesheet.
template
Optional path to an HTML template. Defaults to a built-in template.
The following tokens are replaced in templates:
{directory}
with the name of the directory.{files}
with the HTML of an unordered list of file links.{linked-path}
with the HTML of a link to the directory.{style}
with the specified stylesheet and embedded images.
view
Display mode. tiles
and details
are available. Defaults to tiles
.
trailingSlashes
If set to true, links to directories will include a trailing slash. Defaults to false.
Examples
Serve directory indexes with vanilla node.js http server
var finalhandler = var http = var serveIndex = var serveStatic = // Serve directory indexes for public/ftp folder (with icons)var index = // Serve up public/ftp folder filesvar serve = // Create servervar server = http // Listenserver
Serve directory indexes with express
var express = var serveIndex = var app = // Serve URLs like /ftp/thing as public/ftp/thingappapp