Koa-better-serve NPM

koa-better-serve

Small, simple and correct serving of files, using koa-send - nothing more

You might also be interested in koa-better-router.

Quality Assurance :100:

If you have any how-to kind of questions, please read Code of Conduct and join the chat room or open an issue.
You may also read the Contributing Guide. There, beside "How to contribute?", we describe everything stated by the badges.

(TOC generated by verb using markdown-toc)

Install

This project requires Node.js v7 and above. Use npm to install it.

$ npm install koa-better-serve

API

Review carefully the provided examples and the working tests.

koaBetterServe

Serving dir of files and folders, when request url (ctx.url) match to pathname. All behind the scenes is just using koa-send. Hint: use koa-convert to use it for koa v1.

Params

root {String|Buffer}: folder to serve
pathname {String|RegExp}: path to match, can be regex
options {Object}: optional, passed directly to koa-send
returns {Function}

Example

const serve = require('koa-better-serve')
const Koa = require('koa')
const app = new Koa()

app.use(serve('./uploads/images', '/images'))
app.listen(4290)

dush: Microscopic & functional event emitter in ~350 bytes, extensible through plugins | homepage
koa-bel: View engine for koa without any deps, built to be used with… more | homepage
koa-better-body: Full-featured koa body parser! Support parsing text, buffer, json, json patch, json… more | homepage
koa-better-router: Stable and lovely router for koa, using path-match. Foundation for building powerful… more | homepage
koa-rest-router: Most powerful, flexible and composable router for building enterprise RESTful APIs easily! | homepage
micro: Asynchronous HTTP microservices | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the Contributing Guide and Code of Conduct documents for advices.