- 快速入门
- 指南
- 参考手册
- 高级主题
- 资源
- Express 词汇表
- Express 社区
- 模板引擎
- Express 中间件
- Express body-parser middleware
- Express compression middleware
- Express connect-rid middleware
- Express cookie-parser middleware
- Express cookie-session middleware
- Express cors middleware
- Express csurf middleware
- Express errorhandler middleware
- Express method-override middleware
- Express morgan middleware
- Express multer middleware
- Express response-time middleware
- Express serve-favicon middleware
- Express serve-index middleware
- Express serve-static middleware
- Express session middleware
- Express timeout middleware
- Express vhost middleware
- Express 实用模板
- 推荐框架
- 推荐书籍和博客
Express serve-index middleware
Serves pages that contain directory listings for a given path.
Install
This is a Node.js module available through the npm registry. Installation is done using the npm install
command:
$ npm install serve-index
API
var serveIndex = require('serve-index')
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 or a function that will render a HTML string. Defaults to a built-in template.
When given a string, the string is used as a file path to load and then 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.
When given as a function, the function is called as template(locals, callback)
and it needs to invoke callback(error, htmlString)
. The following are the provided locals:
directory
is the directory being displayed (where/
is the root).displayIcons
is a Boolean for if icons should be rendered or not.fileList
is a sorted array of files in the directory. The array contains objects with the following properties:name
is the relative name for the file.stat
is afs.Stats
object for the file.
path
is the full filesystem path todirectory
.style
is the default stylesheet or the contents of thestylesheet
option.viewName
is the view name provided by theview
option.
view
Display mode. tiles
and details
are available. Defaults to tiles
.
Examples
Serve directory indexes with vanilla node.js http server
var finalhandler = require('finalhandler')
var http = require('http')
var serveIndex = require('serve-index')
var serveStatic = require('serve-static')
// Serve directory indexes for public/ftp folder (with icons)
var index = serveIndex('public/ftp', {'icons': true})
// Serve up public/ftp folder files
var serve = serveStatic('public/ftp')
// Create server
var server = http.createServer(function onRequest(req, res){
var done = finalhandler(req, res)
serve(req, res, function onNext(err) {
if (err) return done(err)
index(req, res, done)
})
})
// Listen
server.listen(3000)
Serve directory indexes with express
var express = require('express')
var serveIndex = require('serve-index')
var app = express()
// Serve URLs like /ftp/thing as public/ftp/thing
// The express.static serves the file contents
// The serveIndex is this module serving the directory
app.use('/ftp', express.static('public/ftp'), serveIndex('public/ftp', {'icons': true}))
// Listen
app.listen(3000)
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论