# koa-send

> Transfer static files

Latest version **5.0.1** (published 2020-07-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install koa-send
pnpm add koa-send
yarn add koa-send
bun add koa-send
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.1 |
| Published | 2020-07-08 |
| First published | 2013-12-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/koa-send) |
| Module format | CommonJS |
| Node | >= 8 |
| Dependencies | 3 |
| Unpacked size | 13.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 433 |
| Maintainers | aheckmann, coderhaoxin, dead_horse, eivifj, fengmk2, jonathanong, jongleberry, juliangruber, niftylettuce, tjholowaychuk |
| Keywords | koa, file, static, sendfile |

## Links

- npm: https://www.npmjs.com/package/koa-send
- Repository: https://github.com/koajs/send
- Issues: https://github.com/koajs/send/issues
- npm.io page: https://npm.io/package/koa-send

## Dependencies (3)

- [debug](https://npm.io/package/debug.md) ^4.1.1
- [http-errors](https://npm.io/package/http-errors.md) ^1.7.3
- [resolve-path](https://npm.io/package/resolve-path.md) ^1.4.0

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 5.0.1 (latest) — 2020-07-08
- 2.0.3 (latest-2) — 2018-09-12
- 1.3.2 (latest-1) — 2018-09-12
- 5.0.0 — 2018-06-19
- 4.1.3 — 2018-02-14
- 4.1.2 — 2017-12-14
- 4.1.1 — 2017-09-25
- 4.1.0 — 2017-04-26
- 4.0.0 — 2017-04-09
- 3.3.0 — 2017-01-10
- 3.2.0 — 2016-03-23
- 3.1.1 — 2016-03-04
- 3.1.0 — 2015-10-24
- 3.0.1 — 2015-10-22
- 2.0.2 — 2015-10-22
- … 13 more at https://npm.io/package/koa-send/versions

## README

# [**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/

---
_Source: https://npm.io/package/koa-send · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._