koa-files 2.3.6 → 2.3.8

package/README.md

@@ -5,7 +5,7 @@
 >
 > [![NPM Version][npm-image]][npm-url]
 > [![Download Status][download-image]][npm-url]
-> [![Snyk Vulnerabilities][snyk-image]][snyk-url]
+> [![Languages Status][languages-image]][github-url]
 > ![Node Version][node-image]
 
 ## Installation
@@ -17,13 +17,13 @@ $ npm install koa-files
 ## API
 
 ```js
-const Koa = require('koa');
-const server = require('koa-files');
+import Koa from 'koa';
+import files from 'koa-files';
 
 const app = new Koa();
 
 // Static files server
-app.use(server(root, options));
+app.use(files(root, options));
 ```
 
 - `root` root directory string. nothing above this root directory can be served.
@@ -64,10 +64,8 @@ app.use(server(root, options));
  * @author nuintun
  */
 
-'use strict';
-
-const Koa = require('koa');
-const server = require('koa-files');
+import Koa from 'koa';
+import files from 'koa-files';
 
 const app = new Koa();
 const port = process.env.PORT || 80;
@@ -82,7 +80,7 @@ function httpError(error) {
 }
 
 // Static files server
-app.use(server('tests', { cacheControl: 'public, max-age=31557600' }));
+app.use(files('tests', { cacheControl: 'public, max-age=31557600' }));
 
 // Listen error event
 app.on('error', error => !httpError(error) && console.error(error));
@@ -102,6 +100,6 @@ MIT
 [npm-image]: https://img.shields.io/npm/v/koa-files.svg?style=flat-square
 [npm-url]: https://www.npmjs.org/package/koa-files
 [download-image]: https://img.shields.io/npm/dm/koa-files.svg?style=flat-square
-[snyk-image]: https://img.shields.io/snyk/vulnerabilities/github/nuintun/koa-files.svg?style=flat-square
-[snyk-url]: https://snyk.io/test/github/nuintun/koa-files
+[languages-image]: https://img.shields.io/github/languages/top/nuintun/koa-files?style=flat-square
+[github-url]: https://github.com/nuintun/koa-files
 [node-image]: https://img.shields.io/node/v/koa-files.svg?style=flat-square

package/cjs/{Send.cjs → Files.cjs}

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 2.3.6
+ * @version 2.3.8
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -27,27 +27,29 @@ const fs__default = /*#__PURE__*/ _interopDefault(fs);
 const parseRange__default = /*#__PURE__*/ _interopDefault(parseRange);
 
 /**
- * @module Send
+ * @module Files
  * @license MIT
  * @author nuintun
  */
 /**
- * @class Send
+ * @class Files
  */
-class Send {
+class Files {
   /**
    * @constructor
-   * @param {string} root
-   * @param {Options} options
+   * @description Create files service
+   * @param root Files service root
+   * @param options Files service options
    */
   constructor(root, options = {}) {
     this.options = options;
     this.root = utils.unixify(path.resolve(root));
   }
   /**
+   * @private
    * @method isConditionalGET
-   * @param {Context} context
-   * @returns {boolean}
+   * @description Check if request is conditional GET
+   * @param context Koa context
    */
   isConditionalGET(context) {
     const { request } = context;
@@ -59,9 +61,10 @@ class Send {
     );
   }
   /**
+   * @private
    * @method isPreconditionFailure
-   * @param {Context} context
-   * @returns {boolean}
+   * @description Check if request precondition failure
+   * @param context Koa context
    */
   isPreconditionFailure(context) {
     const { request, response } = context;
@@ -80,9 +83,10 @@ class Send {
     return false;
   }
   /**
+   * @private
    * @method isRangeFresh
-   * @param {Context} context
-   * @returns {boolean}
+   * @description Check if request range fresh
+   * @param context Koa context
    */
   isRangeFresh(context) {
     const { request, response } = context;
@@ -101,19 +105,21 @@ class Send {
     return Date.parse(lastModified) <= Date.parse(ifRange);
   }
   /**
+   * @private
    * @method isIgnore
-   * @param {string} path
-   * @returns {boolean}
+   * @description Check if path is ignore
+   * @param path File path
    */
   isIgnore(path) {
     const { ignore } = this.options;
     return (typeof ignore === 'function' ? ignore(path) : false) === true;
   }
   /**
+   * @private
    * @method parseRange
-   * @param {Context} context
-   * @param {Stats} stats
-   * @returns {Ranges}
+   * @description Parse range
+   * @param context Koa context
+   * @param stats File stats
    */
   parseRange(context, stats) {
     const { size } = stats;
@@ -178,10 +184,12 @@ class Send {
     return ranges.length ? ranges : [{ start: 0 }];
   }
   /**
+   * @private
    * @method setupHeaders
-   * @param {Context} context
-   * @param {string} path
-   * @param {Stats} stats
+   * @description Setup headers
+   * @param context Koa context
+   * @param path File path
+   * @param stats File stats
    */
   setupHeaders(context, path$1, stats) {
     const { options } = this;
@@ -213,12 +221,13 @@ class Send {
     }
   }
   /**
+   * @private
    * @method read
-   * @param {string} path
-   * @param {Range} range
-   * @param {PassThrough} buffer
-   * @param {boolean} end
-   * @returns {Promise<true>}
+   * @description Read file
+   * @param path File path
+   * @param range Read range
+   * @param buffer Destination stream
+   * @param end Is destory destination stream after read
    */
   read(path, range, buffer, end) {
     return new Promise((resolve, reject) => {
@@ -261,14 +270,16 @@ class Send {
     });
   }
   /**
+   * @private
    * @method send
-   * @param {Context} context
-   * @param {string} path
-   * @param {Range[]} ranges
+   * @description Send file
+   * @param context Koa context
+   * @param path File path
+   * @param ranges Read ranges
    */
   async send(context, path, ranges) {
-    // Ranges count
-    let count = ranges.length;
+    // Ranges length
+    let { length } = ranges;
     // Set stream body, highWaterMark 64kb
     const stream$1 = new stream.PassThrough({ highWaterMark: 65536 });
     // Set response body
@@ -276,7 +287,7 @@ class Send {
     // Read file ranges
     try {
       for (const range of ranges) {
-        await this.read(path, range, stream$1, --count === 0);
+        await this.read(path, range, stream$1, --length === 0);
       }
     } catch (error) {
       // End stream when read exception
@@ -284,9 +295,10 @@ class Send {
     }
   }
   /**
+   * @public
    * @method response
-   * @param {Context} context
-   * @returns {Promise<boolean>}
+   * @description Response to koa context
+   * @param context Koa context
    */
   async response(context) {
     const { root } = this;
@@ -374,4 +386,4 @@ class Send {
   }
 }
 
-module.exports = Send;
+module.exports = Files;

package/cjs/index.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 2.3.6
+ * @version 2.3.8
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -9,7 +9,7 @@
 
 'use strict';
 
-const Send = require('./Send.cjs');
+const Files = require('./Files.cjs');
 
 /**
  * @module index
@@ -22,15 +22,15 @@ const Send = require('./Send.cjs');
  * @param {Options} options
  */
 function server(root, options) {
-  const send = new Send(root, options);
+  const files = new Files(root, options);
   if (options && options.defer) {
     return async (context, next) => {
       await next();
-      await send.response(context);
+      await files.response(context);
     };
   }
   return async (context, next) => {
-    if (!(await send.response(context))) {
+    if (!(await files.response(context))) {
       await next();
     }
   };

package/cjs/utils.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 2.3.6
+ * @version 2.3.8
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -26,10 +26,9 @@ const fs__default = /*#__PURE__*/ _interopDefault(fs);
 const CHARS = Array.from('0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz');
 /**
  * @function isOutRoot
- * @description Test path is out of bound of root
- * @param {string} path
- * @param {string} root
- * @returns {boolean}
+ * @description Check if path is out of root
+ * @param path The path to check
+ * @param root The root path
  */
 function isOutRoot(path$1, root) {
   path$1 = path.relative(root, path$1);
@@ -37,18 +36,16 @@ function isOutRoot(path$1, root) {
 }
 /**
  * @function unixify
- * @description Convert path separators to posix/unix-style forward slashes
- * @param {string} path
- * @returns {string}
+ * @description Convert path to unix style
+ * @param path The path to convert
  */
 function unixify(path) {
   return path.replace(/\\/g, '/');
 }
 /**
  * @function decodeURI
- * @description Decode URI component.
- * @param {string} URI
- * @returns {string|-1}
+ * @description Decode URI component
+ * @param URI The URI to decode
  */
 function decodeURI(URI) {
   try {
@@ -59,8 +56,7 @@ function decodeURI(URI) {
 }
 /**
  * @function boundaryGenerator
- * @description Create boundary
- * @returns {string}
+ * @description Generate a boundary
  */
 function boundaryGenerator() {
   let boundary = '';
@@ -73,8 +69,8 @@ function boundaryGenerator() {
 }
 /**
  * @function fstat
- * @param {string} path
- * @returns {Promise<Stats>}
+ * @description Get file stats
+ * @param path The file path
  */
 function fstat(path) {
   return new Promise((resolve, reject) => {
@@ -85,16 +81,16 @@ function fstat(path) {
 }
 /**
  * @function hasTrailingSlash
- * @param {string} path
- * @returns {boolean}
+ * @description Check if path has trailing slash
+ * @param path The path to check
  */
 function hasTrailingSlash(path) {
   return /\/$/.test(path);
 }
 /**
  * @function parseTokens
- * @description Parse a HTTP tokens.
- * @param {string[]} value
+ * @description Parse HTTP tokens
+ * @param value The tokens value string
  */
 function parseTokens(value) {
   let end = 0;
@@ -123,25 +119,25 @@ function parseTokens(value) {
   tokens.push(value.substring(start, end));
   return tokens;
 }
+/**
+ * @function isETag
+ * @description Check if etag is valid
+ * @param value The value to check
+ */
+function isETag(value) {
+  return /^(?:W\/)?"[\s\S]+"$/.test(value);
+}
 /**
  * @function isETagFresh
- * @param {string} match
- * @param {string} etag
- * @returns {boolean}
+ * @description Check if etag is fresh
+ * @param match The match value
+ * @param etag The etag value
  */
 function isETagFresh(match, etag) {
   return parseTokens(match).some(match => {
     return match === etag || match === 'W/' + etag || 'W/' + match === etag;
   });
 }
-/**
- * @function isETag
- * @param {string} etag
- * @returns {boolean}
- */
-function isETag(etag) {
-  return /(?:W\/)?"(?:[ !#-\x7E\x80-\xFF]*|\r\n[\t ]|\\.)*"/.test(etag);
-}
 
 exports.boundaryGenerator = boundaryGenerator;
 exports.decodeURI = decodeURI;

package/esm/{Send.js → Files.js}

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 2.3.6
+ * @version 2.3.8
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -16,27 +16,29 @@ import { resolve, extname, join } from 'path';
 import { unixify, isETagFresh, isETag, boundaryGenerator, decodeURI, isOutRoot, fstat, hasTrailingSlash } from './utils.js';
 
 /**
- * @module Send
+ * @module Files
  * @license MIT
  * @author nuintun
  */
 /**
- * @class Send
+ * @class Files
  */
-class Send {
+class Files {
   /**
    * @constructor
-   * @param {string} root
-   * @param {Options} options
+   * @description Create files service
+   * @param root Files service root
+   * @param options Files service options
    */
   constructor(root, options = {}) {
     this.options = options;
     this.root = unixify(resolve(root));
   }
   /**
+   * @private
    * @method isConditionalGET
-   * @param {Context} context
-   * @returns {boolean}
+   * @description Check if request is conditional GET
+   * @param context Koa context
    */
   isConditionalGET(context) {
     const { request } = context;
@@ -48,9 +50,10 @@ class Send {
     );
   }
   /**
+   * @private
    * @method isPreconditionFailure
-   * @param {Context} context
-   * @returns {boolean}
+   * @description Check if request precondition failure
+   * @param context Koa context
    */
   isPreconditionFailure(context) {
     const { request, response } = context;
@@ -69,9 +72,10 @@ class Send {
     return false;
   }
   /**
+   * @private
    * @method isRangeFresh
-   * @param {Context} context
-   * @returns {boolean}
+   * @description Check if request range fresh
+   * @param context Koa context
    */
   isRangeFresh(context) {
     const { request, response } = context;
@@ -90,19 +94,21 @@ class Send {
     return Date.parse(lastModified) <= Date.parse(ifRange);
   }
   /**
+   * @private
    * @method isIgnore
-   * @param {string} path
-   * @returns {boolean}
+   * @description Check if path is ignore
+   * @param path File path
    */
   isIgnore(path) {
     const { ignore } = this.options;
     return (typeof ignore === 'function' ? ignore(path) : false) === true;
   }
   /**
+   * @private
    * @method parseRange
-   * @param {Context} context
-   * @param {Stats} stats
-   * @returns {Ranges}
+   * @description Parse range
+   * @param context Koa context
+   * @param stats File stats
    */
   parseRange(context, stats) {
     const { size } = stats;
@@ -167,10 +173,12 @@ class Send {
     return ranges.length ? ranges : [{ start: 0 }];
   }
   /**
+   * @private
    * @method setupHeaders
-   * @param {Context} context
-   * @param {string} path
-   * @param {Stats} stats
+   * @description Setup headers
+   * @param context Koa context
+   * @param path File path
+   * @param stats File stats
    */
   setupHeaders(context, path, stats) {
     const { options } = this;
@@ -202,12 +210,13 @@ class Send {
     }
   }
   /**
+   * @private
    * @method read
-   * @param {string} path
-   * @param {Range} range
-   * @param {PassThrough} buffer
-   * @param {boolean} end
-   * @returns {Promise<true>}
+   * @description Read file
+   * @param path File path
+   * @param range Read range
+   * @param buffer Destination stream
+   * @param end Is destory destination stream after read
    */
   read(path, range, buffer, end) {
     return new Promise((resolve, reject) => {
@@ -250,14 +259,16 @@ class Send {
     });
   }
   /**
+   * @private
    * @method send
-   * @param {Context} context
-   * @param {string} path
-   * @param {Range[]} ranges
+   * @description Send file
+   * @param context Koa context
+   * @param path File path
+   * @param ranges Read ranges
    */
   async send(context, path, ranges) {
-    // Ranges count
-    let count = ranges.length;
+    // Ranges length
+    let { length } = ranges;
     // Set stream body, highWaterMark 64kb
     const stream = new PassThrough({ highWaterMark: 65536 });
     // Set response body
@@ -265,7 +276,7 @@ class Send {
     // Read file ranges
     try {
       for (const range of ranges) {
-        await this.read(path, range, stream, --count === 0);
+        await this.read(path, range, stream, --length === 0);
       }
     } catch (error) {
       // End stream when read exception
@@ -273,9 +284,10 @@ class Send {
     }
   }
   /**
+   * @public
    * @method response
-   * @param {Context} context
-   * @returns {Promise<boolean>}
+   * @description Response to koa context
+   * @param context Koa context
    */
   async response(context) {
     const { root } = this;
@@ -363,4 +375,4 @@ class Send {
   }
 }
 
-export { Send as default };
+export { Files as default };

package/esm/index.js

@@ -1,13 +1,13 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 2.3.6
+ * @version 2.3.8
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
  */
 
-import Send from './Send.js';
+import Files from './Files.js';
 
 /**
  * @module index
@@ -20,15 +20,15 @@ import Send from './Send.js';
  * @param {Options} options
  */
 function server(root, options) {
-  const send = new Send(root, options);
+  const files = new Files(root, options);
   if (options && options.defer) {
     return async (context, next) => {
       await next();
-      await send.response(context);
+      await files.response(context);
     };
   }
   return async (context, next) => {
-    if (!(await send.response(context))) {
+    if (!(await files.response(context))) {
       await next();
     }
   };

package/esm/utils.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 2.3.6
+ * @version 2.3.8
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -18,10 +18,9 @@ import { relative, isAbsolute } from 'path';
 const CHARS = Array.from('0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz');
 /**
  * @function isOutRoot
- * @description Test path is out of bound of root
- * @param {string} path
- * @param {string} root
- * @returns {boolean}
+ * @description Check if path is out of root
+ * @param path The path to check
+ * @param root The root path
  */
 function isOutRoot(path, root) {
   path = relative(root, path);
@@ -29,18 +28,16 @@ function isOutRoot(path, root) {
 }
 /**
  * @function unixify
- * @description Convert path separators to posix/unix-style forward slashes
- * @param {string} path
- * @returns {string}
+ * @description Convert path to unix style
+ * @param path The path to convert
  */
 function unixify(path) {
   return path.replace(/\\/g, '/');
 }
 /**
  * @function decodeURI
- * @description Decode URI component.
- * @param {string} URI
- * @returns {string|-1}
+ * @description Decode URI component
+ * @param URI The URI to decode
  */
 function decodeURI(URI) {
   try {
@@ -51,8 +48,7 @@ function decodeURI(URI) {
 }
 /**
  * @function boundaryGenerator
- * @description Create boundary
- * @returns {string}
+ * @description Generate a boundary
  */
 function boundaryGenerator() {
   let boundary = '';
@@ -65,8 +61,8 @@ function boundaryGenerator() {
 }
 /**
  * @function fstat
- * @param {string} path
- * @returns {Promise<Stats>}
+ * @description Get file stats
+ * @param path The file path
  */
 function fstat(path) {
   return new Promise((resolve, reject) => {
@@ -77,16 +73,16 @@ function fstat(path) {
 }
 /**
  * @function hasTrailingSlash
- * @param {string} path
- * @returns {boolean}
+ * @description Check if path has trailing slash
+ * @param path The path to check
  */
 function hasTrailingSlash(path) {
   return /\/$/.test(path);
 }
 /**
  * @function parseTokens
- * @description Parse a HTTP tokens.
- * @param {string[]} value
+ * @description Parse HTTP tokens
+ * @param value The tokens value string
  */
 function parseTokens(value) {
   let end = 0;
@@ -115,24 +111,24 @@ function parseTokens(value) {
   tokens.push(value.substring(start, end));
   return tokens;
 }
+/**
+ * @function isETag
+ * @description Check if etag is valid
+ * @param value The value to check
+ */
+function isETag(value) {
+  return /^(?:W\/)?"[\s\S]+"$/.test(value);
+}
 /**
  * @function isETagFresh
- * @param {string} match
- * @param {string} etag
- * @returns {boolean}
+ * @description Check if etag is fresh
+ * @param match The match value
+ * @param etag The etag value
  */
 function isETagFresh(match, etag) {
   return parseTokens(match).some(match => {
     return match === etag || match === 'W/' + etag || 'W/' + match === etag;
   });
 }
-/**
- * @function isETag
- * @param {string} etag
- * @returns {boolean}
- */
-function isETag(etag) {
-  return /(?:W\/)?"(?:[ !#-\x7E\x80-\xFF]*|\r\n[\t ]|\\.)*"/.test(etag);
-}
 
 export { boundaryGenerator, decodeURI, fstat, hasTrailingSlash, isETag, isETagFresh, isOutRoot, parseTokens, unixify };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koa-files",
-  "version": "2.3.6",
+  "version": "2.3.8",
   "description": "A static files serving middleware for koa.",
   "type": "module",
   "main": "cjs/index.cjs",
@@ -8,7 +8,8 @@
   "types": "types/index.d.ts",
   "exports": {
     "import": "./esm/index.js",
-    "require": "./cjs/index.cjs"
+    "require": "./cjs/index.cjs",
+    "types": "./types/index.d.ts"
   },
   "files": [
     "cjs",
@@ -44,10 +45,10 @@
     "test": "node tests",
     "lint": "tsc --noEmit",
     "clean": "node tools/clean.js",
-    "format": "prettier --write .",
     "prepublishOnly": "npm run build",
     "build:cjs": "rollup -c tools/rollup.cjs.js",
     "build:esm": "rollup -c tools/rollup.esm.js",
+    "format": "prettier --write . --ignore-path .prettierignore",
     "build": "npm run clean && npm run build:main && npm run format",
     "build:main": "npm run build:cjs && npm run build:esm && npm run build:types",
     "build:types": "tsc --declaration --emitDeclarationOnly --declarationDir types"
@@ -56,20 +57,20 @@
     "destroy": "^1.2.0",
     "etag": "^1.8.1",
     "range-parser": "^1.2.1",
-    "tslib": "^2.5.0"
+    "tslib": "^2.6.2"
   },
   "devDependencies": {
-    "@rollup/plugin-typescript": "^11.0.0",
-    "@types/destroy": "^1.0.0",
-    "@types/etag": "^1.8.1",
-    "@types/koa": "^2.13.5",
-    "@types/range-parser": "^1.2.4",
-    "koa": "^2.14.1",
-    "magic-string": "^0.30.0",
-    "prettier": "^2.8.6",
-    "rimraf": "^4.4.0",
-    "rollup": "^3.20.0",
-    "typescript": "^5.0.2"
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/destroy": "^1.0.3",
+    "@types/etag": "^1.8.3",
+    "@types/koa": "^2.15.0",
+    "@types/range-parser": "^1.2.7",
+    "koa": "^2.15.1",
+    "magic-string": "^0.30.8",
+    "prettier": "^3.2.5",
+    "rimraf": "^5.0.5",
+    "rollup": "^4.13.0",
+    "typescript": "^5.4.2"
   },
   "peerDependencies": {
     "koa": "^2.0.0"

package/types/Files.d.ts

@@ -0,0 +1,98 @@
+/**
+ * @module Files
+ * @license MIT
+ * @author nuintun
+ */
+import { Context } from 'koa';
+export interface Options {
+  etag?: boolean;
+  cacheControl?: string;
+  acceptRanges?: boolean;
+  lastModified?: boolean;
+  ignore?: (path: string) => boolean;
+}
+/**
+ * @class Files
+ */
+export default class Files {
+  private root;
+  private options;
+  /**
+   * @constructor
+   * @description Create files service
+   * @param root Files service root
+   * @param options Files service options
+   */
+  constructor(root: string, options?: Options);
+  /**
+   * @private
+   * @method isConditionalGET
+   * @description Check if request is conditional GET
+   * @param context Koa context
+   */
+  private isConditionalGET;
+  /**
+   * @private
+   * @method isPreconditionFailure
+   * @description Check if request precondition failure
+   * @param context Koa context
+   */
+  private isPreconditionFailure;
+  /**
+   * @private
+   * @method isRangeFresh
+   * @description Check if request range fresh
+   * @param context Koa context
+   */
+  private isRangeFresh;
+  /**
+   * @private
+   * @method isIgnore
+   * @description Check if path is ignore
+   * @param path File path
+   */
+  private isIgnore;
+  /**
+   * @private
+   * @method parseRange
+   * @description Parse range
+   * @param context Koa context
+   * @param stats File stats
+   */
+  private parseRange;
+  /**
+   * @private
+   * @method setupHeaders
+   * @description Setup headers
+   * @param context Koa context
+   * @param path File path
+   * @param stats File stats
+   */
+  private setupHeaders;
+  /**
+   * @private
+   * @method read
+   * @description Read file
+   * @param path File path
+   * @param range Read range
+   * @param buffer Destination stream
+   * @param end Is destory destination stream after read
+   */
+  private read;
+  /**
+   * @private
+   * @method send
+   * @description Send file
+   * @param context Koa context
+   * @param path File path
+   * @param ranges Read ranges
+   */
+  private send;
+  /**
+   * @public
+   * @method response
+   * @description Response to koa context
+   * @param context Koa context
+   */
+  response(context: Context): Promise<boolean>;
+}

package/types/index.d.ts

@@ -4,8 +4,8 @@
  * @author nuintun
  */
 import { Middleware } from 'koa';
-import { Options as SendOptions } from './Send';
-export interface Options extends SendOptions {
+import { Options as FilesOptions } from './Files';
+export interface Options extends FilesOptions {
   defer?: boolean;
 }
 /**

package/types/utils.d.ts

@@ -7,60 +7,56 @@
 import { Stats } from 'fs';
 /**
  * @function isOutRoot
- * @description Test path is out of bound of root
- * @param {string} path
- * @param {string} root
- * @returns {boolean}
+ * @description Check if path is out of root
+ * @param path The path to check
+ * @param root The root path
  */
 export declare function isOutRoot(path: string, root: string): boolean;
 /**
  * @function unixify
- * @description Convert path separators to posix/unix-style forward slashes
- * @param {string} path
- * @returns {string}
+ * @description Convert path to unix style
+ * @param path The path to convert
  */
 export declare function unixify(path: string): string;
 /**
  * @function decodeURI
- * @description Decode URI component.
- * @param {string} URI
- * @returns {string|-1}
+ * @description Decode URI component
+ * @param URI The URI to decode
  */
 export declare function decodeURI(URI: string): string | -1;
 /**
  * @function boundaryGenerator
- * @description Create boundary
- * @returns {string}
+ * @description Generate a boundary
  */
 export declare function boundaryGenerator(): string;
 /**
  * @function fstat
- * @param {string} path
- * @returns {Promise<Stats>}
+ * @description Get file stats
+ * @param path The file path
  */
 export declare function fstat(path: string): Promise<Stats>;
 /**
  * @function hasTrailingSlash
- * @param {string} path
- * @returns {boolean}
+ * @description Check if path has trailing slash
+ * @param path The path to check
  */
 export declare function hasTrailingSlash(path: string): boolean;
 /**
  * @function parseTokens
- * @description Parse a HTTP tokens.
- * @param {string[]} value
+ * @description Parse HTTP tokens
+ * @param value The tokens value string
  */
 export declare function parseTokens(value: string): string[];
 /**
- * @function isETagFresh
- * @param {string} match
- * @param {string} etag
- * @returns {boolean}
+ * @function isETag
+ * @description Check if etag is valid
+ * @param value The value to check
  */
-export declare function isETagFresh(match: string, etag: string): boolean;
+export declare function isETag(value: string): boolean;
 /**
- * @function isETag
- * @param {string} etag
- * @returns {boolean}
+ * @function isETagFresh
+ * @description Check if etag is fresh
+ * @param match The match value
+ * @param etag The etag value
  */
-export declare function isETag(etag: string): boolean;
+export declare function isETagFresh(match: string, etag: string): boolean;

package/types/Send.d.ts

@@ -1,86 +0,0 @@
-/**
- * @module Send
- * @license MIT
- * @author nuintun
- */
-import { Context } from 'koa';
-export interface Options {
-  etag?: boolean;
-  cacheControl?: string;
-  acceptRanges?: boolean;
-  lastModified?: boolean;
-  ignore?: (path: string) => boolean;
-}
-/**
- * @class Send
- */
-export default class Send {
-  private root;
-  private options;
-  /**
-   * @constructor
-   * @param {string} root
-   * @param {Options} options
-   */
-  constructor(root: string, options?: Options);
-  /**
-   * @method isConditionalGET
-   * @param {Context} context
-   * @returns {boolean}
-   */
-  private isConditionalGET;
-  /**
-   * @method isPreconditionFailure
-   * @param {Context} context
-   * @returns {boolean}
-   */
-  private isPreconditionFailure;
-  /**
-   * @method isRangeFresh
-   * @param {Context} context
-   * @returns {boolean}
-   */
-  private isRangeFresh;
-  /**
-   * @method isIgnore
-   * @param {string} path
-   * @returns {boolean}
-   */
-  private isIgnore;
-  /**
-   * @method parseRange
-   * @param {Context} context
-   * @param {Stats} stats
-   * @returns {Ranges}
-   */
-  private parseRange;
-  /**
-   * @method setupHeaders
-   * @param {Context} context
-   * @param {string} path
-   * @param {Stats} stats
-   */
-  private setupHeaders;
-  /**
-   * @method read
-   * @param {string} path
-   * @param {Range} range
-   * @param {PassThrough} buffer
-   * @param {boolean} end
-   * @returns {Promise<true>}
-   */
-  private read;
-  /**
-   * @method send
-   * @param {Context} context
-   * @param {string} path
-   * @param {Range[]} ranges
-   */
-  private send;
-  /**
-   * @method response
-   * @param {Context} context
-   * @returns {Promise<boolean>}
-   */
-  response(context: Context): Promise<boolean>;
-}