Home

Awesome

@koa/send

NPM version Build Status Test coverage License Downloads

Koa static file serving middleware.

Notice: We recommend using @koa/send for installation, as both koa-send and @koa/send refer to the same module. However, in our next major versions bumps, we will deprecate koa-send and only maintain the module under @koa/send.

Install

NPM

$ npm i @koa/send

Options

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:

app.use(async (ctx) => {
  await send(ctx, ctx.path, { root: __dirname + "/public" });
});

To serve developer specified files:

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:

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

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