koa-index

Serve directory listings for Koa

Install

Screenshot

Usage

1import Koa from 'koa'
2import path from 'path'
3import koaIndex from 'koa-index'
4
5const app = new Koa()
6
7app.use(
8  koaIndex(__dirname, {
9    hidden: true
10  })
11)
12
13app.listen(8080)

API

1interface IOpts {
2  index?: string | boolean
3  directory?: boolean
4  maxAge?: number
5  lastModified?: boolean
6  etag?: boolean
7  hidden?: boolean
8}
9
10koaIndex(root: string, opts?: IOpts)

Options

• index: Default file name, defaults to index.html
• directory: Support directory send, defaults to true
• maxAge: cache control max age (in milliseconds) for the files, default to 0
• lastModified: Enable or disable Last-Modified header, defaults to true
• etag: Enable or disable etag generation, defaults to true
• hidden: Display hidden (dot) files. Defaults to false

License

MIT