.eslintrc

@@ -0,0 +1,2 @@
+---
+extends: standard

.gitignore

@@ -1,2 +1,3 @@
+package-lock.json
 node_modules
 coverage

.npmrc

@@ -0,0 +1 @@
+package-lock=false

.travis.yml

@@ -1,7 +1,6 @@
 node_js:
-- "4"
-- "6"
-- "7"
+- 8
+- 10
 sudo: false
 language: node_js
 script: "npm run-script test-travis"

History.md

@@ -1,4 +1,34 @@
 
+5.0.0 / 2018-06-19
+==================
+
+ * bump deps
+ * fix bug that set Content-Type not working. (#105)
+
+4.1.2 / 2017-12-14
+==================
+
+ * Fix issue with dots in path when using extensions array (#92)
+
+4.1.1 / 2017-09-25
+==================
+
+ * Fix brotli support, closes #83
+ * Fix tests
+
+4.1.0 / 2017-04-26
+==================
+
+ * Add support for Cache-Control: immutable with a new "immutable" option
+ * Added serving of brotli versions of files
+
+4.0.0 / 2017-04-09
+==================
+
+ * throw error if file not exists, closes #43
+ * remove co, use async function
+ * bump deps
+
 3.3.0 / 2017-01-10
 ==================
 

Readme.md

@@ -19,10 +19,13 @@ $ 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
- - `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.
- - `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/`
+ - [`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`)
 
@@ -37,16 +40,16 @@ $ npm install koa-send
   For example to serve files from `./public`:
 
 ```js
-app.use(function *(){
-  yield send(this, this.path, { root: __dirname + '/public' });
+app.use(async (ctx) => {
+  await send(ctx, ctx.path, { root: __dirname + '/public' });
 })
 ```
 
   To serve developer specified files:
 
 ```js
-app.use(function *(){
-  yield send(this, 'path/to/my.js');
+app.use(async (ctx) => {
+  await send(ctx, 'path/to/my.js');
 })
 ```
 
@@ -61,17 +64,17 @@ You should only use the `setHeaders` option when you wish to edit the `Cache-Con
 
 If you want to edit any other header, simply set them before calling `send`.
 
-## Example (Koa@2) with async/await
+## Example
 
 ```js
-var send = require('koa-send');
-var Koa = require('koa');
-var app = new Koa();
+const send = require('koa-send');
+const Koa = require('koa');
+const app = new Koa();
 
 // $ GET /package.json
 // $ GET /
 
-app.use(async function (ctx, next){
+app.use(async (ctx) => {
   if ('/' == ctx.path) return ctx.body = 'Try GET /package.json';
   await send(ctx, ctx.path);
 })
@@ -80,25 +83,6 @@ app.listen(3000);
 console.log('listening on port 3000');
 ```
 
-## Example
-
-```js
-var send = require('koa-send');
-var koa = require('koa');
-var app = koa();
-
-// $ GET /package.json
-// $ GET /
-
-app.use(function *(){
-  if ('/' == this.path) return this.body = 'Try GET /package.json';
-  yield send(this, this.path);
-})
-
-app.listen(3000);
-console.log('listening on port 3000');
-```
-
 ## License
 
   MIT

example.js

@@ -1,15 +1,18 @@
 
-var send = require('./');
-var koa = require('koa');
-var app = koa();
+const send = require('./')
+const Koa = require('koa')
+const app = new Koa()
 
 // $ GET /package.json
 // $ GET /
 
-app.use(function *(){
-  if ('/' == this.path) return this.body = 'Try GET /package.json';
-  yield send(this, this.path, { root: __dirname });
+app.use(async (ctx) => {
+  if (ctx.path === '/') {
+    ctx.body = 'Try GET /package.json'
+    return
+  }
+  await send(ctx, ctx.path, { root: __dirname })
 })
 
-app.listen(3000);
-console.log('listening on port 3000');
+app.listen(3000)
+console.log('listening on port 3000')