mirror of
https://github.com/pure-admin/vue-pure-admin.git
synced 2025-06-08 17:37:24 +08:00
110 lines
4.1 KiB
Markdown
110 lines
4.1 KiB
Markdown
# [**koa-send**](https://github.com/koajs/send)
|
|
|
|
> Static file serving middleware.
|
|
|
|
[![NPM version][npm-image]][npm-url]
|
|
[![Build status][travis-image]][travis-url]
|
|
[![Test coverage][coveralls-image]][coveralls-url]
|
|
[![Dependency Status][david-image]][david-url]
|
|
[![License][license-image]][license-url]
|
|
[![Downloads][downloads-image]][downloads-url]
|
|
|
|
|
|
## Installation
|
|
|
|
```js
|
|
$ npm install koa-send
|
|
```
|
|
|
|
|
|
## Options
|
|
|
|
- `maxage` Browser cache max-age in milliseconds. (defaults to `0`).
|
|
- `immutable` Tell the browser the resource is immutable and can be cached indefinitely. (defaults to `false`).
|
|
- `hidden` Allow transfer of hidden files. (defaults to `false`).
|
|
- [`root`](#root-path) Root directory to restrict file access.
|
|
- `index` Name of the index file to serve automatically when visiting the root location. (defaults to none).
|
|
- `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. (defaults to `true`).
|
|
- `format` If not `false` (defaults to `true`), format the path to serve static file servers and not require a trailing slash for directories, so that you can do both `/directory` and `/directory/`.
|
|
- [`setHeaders`](#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`)
|
|
|
|
### Root path
|
|
|
|
Note that `root` is required, defaults to `''` and will be resolved,
|
|
removing the leading `/` to make the path relative and this
|
|
path must not contain "..", protecting developers from
|
|
concatenating user input. If you plan on serving files based on
|
|
user input supply a `root` directory from which to serve from.
|
|
|
|
For example to serve files from `./public`:
|
|
|
|
```js
|
|
app.use(async (ctx) => {
|
|
await send(ctx, ctx.path, { root: __dirname + '/public' });
|
|
})
|
|
```
|
|
|
|
To serve developer specified files:
|
|
|
|
```js
|
|
app.use(async (ctx) => {
|
|
await send(ctx, 'path/to/my.js');
|
|
})
|
|
```
|
|
|
|
### setHeaders
|
|
|
|
The function is called as `fn(res, path, stats)`, where the arguments are:
|
|
* `res`: the response object.
|
|
* `path`: the resolved file path that is being sent.
|
|
* `stats`: the stats object of the file that is being sent.
|
|
|
|
You should only use the `setHeaders` option when you wish to edit the `Cache-Control` or `Last-Modified` headers, because doing it before is useless (it's overwritten by `send`), and doing it after is too late because the headers are already sent.
|
|
|
|
If you want to edit any other header, simply set them before calling `send`.
|
|
|
|
|
|
## Example
|
|
|
|
```js
|
|
const send = require('koa-send');
|
|
const Koa = require('koa');
|
|
const app = new Koa();
|
|
|
|
// $ GET /package.json
|
|
// $ GET /
|
|
|
|
app.use(async (ctx) => {
|
|
if ('/' == ctx.path) return ctx.body = 'Try GET /package.json';
|
|
await send(ctx, ctx.path);
|
|
})
|
|
|
|
app.listen(3000);
|
|
console.log('listening on port 3000');
|
|
```
|
|
|
|
|
|
## License
|
|
|
|
[MIT](/LICENSE)
|
|
|
|
|
|
[npm-image]: https://img.shields.io/npm/v/koa-send.svg?style=flat-square
|
|
[npm-url]: https://npmjs.org/package/koa-send
|
|
[github-tag]: http://img.shields.io/github/tag/koajs/send.svg?style=flat-square
|
|
[github-url]: https://github.com/koajs/send/tags
|
|
[travis-image]: https://img.shields.io/travis/koajs/send.svg?style=flat-square
|
|
[travis-url]: https://travis-ci.org/koajs/send
|
|
[coveralls-image]: https://img.shields.io/coveralls/koajs/send.svg?style=flat-square
|
|
[coveralls-url]: https://coveralls.io/r/koajs/send?branch=master
|
|
[david-image]: http://img.shields.io/david/koajs/send.svg?style=flat-square
|
|
[david-url]: https://david-dm.org/koajs/send
|
|
[license-image]: http://img.shields.io/npm/l/koa-send.svg?style=flat-square
|
|
[license-url]: LICENSE
|
|
[downloads-image]: http://img.shields.io/npm/dm/koa-send.svg?style=flat-square
|
|
[downloads-url]: https://npmjs.org/package/koa-send
|
|
[gittip-image]: https://img.shields.io/gittip/jonathanong.svg?style=flat-square
|
|
[gittip-url]: https://www.gittip.com/jonathanong/
|