Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/koajs/static

Static file server middleware
https://github.com/koajs/static

Last synced: 3 months ago
JSON representation

Static file server middleware

Lists

README 

        
# koa-static



[![NPM version][npm-image]][npm-url]

[![Build status][travis-image]][travis-url]

[![Test coverage][coveralls-image]][coveralls-url]

[![License][license-image]][license-url]

[![Downloads][downloads-image]][downloads-url]



Koa static file serving middleware, wrapper for [`koa-send`](https://github.com/koajs/send).



## Installation



```bash

$ npm install koa-static

```



## API



```js

import Koa from "koa"; // CJS: require('koa');

import serve from "koa-static"; // CJS: require('koa-static')

const app = new Koa();

app.use(serve(root, opts));

```



- `root` root directory string. nothing above this root directory can be served

- `opts` options object.



### Options



- `maxage` Browser cache max-age in milliseconds. defaults to 0

- `hidden` Allow transfer of hidden files. defaults to false

- `index` Default file name, defaults to 'index.html'

- `defer` If true, serves after `return next()`, allowing any downstream middleware to respond first.

- `gzip` Try to serve the gzipped version of a file automatically when gzip is supported by a client and if the requested file with .gz extension exists. defaults to true.

- `brotli` Try to serve the brotli version of a file automatically when brotli is supported by a client and if the requested file with .br extension exists (note, that brotli is only accepted over https). defaults to true.

- [setHeaders](https://github.com/koajs/send#setheaders) Function to set custom headers on response.

- `extensions` Try to match extensions from passed array to search for file when no extension is sufficed in URL. First found is served. (defaults to `false`)



## Example



```js

const serve = require("koa-static");

const Koa = require("koa");

const app = new Koa();



// $ GET /package.json

app.use(serve("."));



// $ GET /hello.txt

app.use(serve("test/fixtures"));



// or use absolute paths

app.use(serve(__dirname + "/test/fixtures"));



app.listen(3000);



console.log("listening on port 3000");

```



### See also



- [koajs/conditional-get](https://github.com/koajs/conditional-get) Conditional GET support for koa

- [koajs/compress](https://github.com/koajs/compress) Compress middleware for koa

- [koajs/mount](https://github.com/koajs/mount) Mount `koa-static` to a specific path



## License



MIT



[npm-image]: https://img.shields.io/npm/v/koa-static.svg?style=flat-square

[npm-url]: https://npmjs.org/package/koa-static

[github-tag]: http://img.shields.io/github/tag/koajs/static.svg?style=flat-square

[github-url]: https://github.com/koajs/static/tags

[travis-image]: https://img.shields.io/travis/koajs/static.svg?style=flat-square

[travis-url]: https://travis-ci.org/koajs/static

[coveralls-image]: https://img.shields.io/coveralls/koajs/static.svg?style=flat-square

[coveralls-url]: https://coveralls.io/r/koajs/static?branch=master

[license-image]: http://img.shields.io/npm/l/koa-static.svg?style=flat-square

[license-url]: LICENSE

[downloads-image]: http://img.shields.io/npm/dm/koa-static.svg?style=flat-square

[downloads-url]: https://npmjs.org/package/koa-static

[gittip-image]: https://img.shields.io/gittip/jonathanong.svg?style=flat-square

[gittip-url]: https://www.gittip.com/jonathanong/