koa-files 4.0.7 → 4.1.0

package/README.md

@@ -29,6 +29,10 @@ interface IgnoreFunction {
   (path: string): boolean | Promise<boolean>;
 }
 
+interface HighWaterMarkFunction {
+  (path: string, stats: Stats): Promise<number> | number;
+}
+
 interface HeadersFunction {
   (path: string, stats: Stats): Promise<Headers | void> | Headers | void;
 }
@@ -41,14 +45,14 @@ export interface FileSystem {
 }
 
 export interface Options {
-  fs?: FileSystem;
-  defer?: boolean;
   etag?: boolean;
+  defer?: boolean;
+  fs?: FileSystem;
   acceptRanges?: boolean;
   lastModified?: boolean;
-  highWaterMark?: number;
   ignore?: IgnoreFunction;
   headers?: Headers | HeadersFunction;
+  highWaterMark?: number | HighWaterMarkFunction;
 }
 
 export function server(root: string, options?: Options): Middleware;

package/cjs/ReadStream.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 4.0.7
+ * @version 4.1.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -128,13 +128,13 @@ class ReadStream extends stream.Readable {
       const buffer$1 = buffer.Buffer.allocUnsafeSlow(bytesToRead);
       const position = range.offset + bytesRead;
       // Read file range.
-      this.fs.read(fd, buffer$1, 0, bytesToRead, position, (error, bytesRead, buffer) => {
+      this.fs.read(fd, buffer$1, 0, bytesToRead, position, (readError, bytesRead, buffer) => {
         this.reading = false;
         // Tell ._destroy() that it's safe to close the fd now.
         if (this.destroyed) {
-          this.emit(DISPOSE_EVENT, error);
-        } else if (error != null) {
-          this.destroy(error);
+          this.emit(DISPOSE_EVENT, readError);
+        } else if (readError != null) {
+          this.destroy(readError);
         } else if (bytesRead !== bytesToRead) {
           this.destroy(new RangeError('invalid read operation'));
         } else {

package/cjs/ReadStream.d.cts

@@ -2,11 +2,12 @@
  * @module ReadStream
  */
 import { PathLike } from 'fs';
+import { Readable } from 'stream';
 import { Range } from './utils/http.cjs';
 import { FileSystem } from './utils/fs.cjs';
-import { Readable, ReadableOptions } from 'stream';
-export interface Options extends Pick<ReadableOptions, 'highWaterMark'> {
+export interface Options {
   fs: FileSystem;
+  highWaterMark?: number;
 }
 interface Callback {
   (error?: Error | null): void;

package/cjs/Service.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 4.0.7
+ * @version 4.1.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -38,20 +38,15 @@ class Service {
    * @param root The file service root.
    * @param options The file service options.
    */
-  constructor(root, options) {
+  constructor(root, options = {}) {
+    var _a;
     this.root = path.unixify(path$1.resolve(root));
-    this.options = Object.assign({ fs: fs__default.default, highWaterMark: 65536 }, options);
-  }
-  /**
-   * @private
-   * @method isIgnore
-   * @description Check if path is ignore.
-   * @param path The path to check.
-   */
-  async isIgnore(path) {
-    const { ignore } = this.options;
-    const isIgnored = type.isFunction(ignore) ? await ignore(path) : false;
-    return isIgnored === true;
+    const { ignore, highWaterMark = 65536 } = options;
+    this.options = Object.assign(Object.assign({}, options), {
+      fs: (_a = options.fs) !== null && _a !== void 0 ? _a : fs__default.default,
+      ignore: type.isFunction(ignore) ? ignore : () => false,
+      highWaterMark: type.isFunction(highWaterMark) ? highWaterMark : () => highWaterMark
+    });
   }
   /**
    * @private
@@ -131,12 +126,12 @@ class Service {
     if (path.isOutRoot(path$2, root)) {
       return false;
     }
+    // Get options.
+    const { options } = this;
     // Is ignore path or file (403).
-    if (await this.isIgnore(path$2)) {
+    if (await options.ignore(path$2)) {
       return false;
     }
-    // Get options.
-    const { options } = this;
     // File stats.
     const stats = await fs$1.stat(options.fs, path$2);
     // Check file stats.
@@ -193,7 +188,10 @@ class Service {
       return context.throw(400);
     }
     // Set response body.
-    response.body = new ReadStream.ReadStream(path$2, ranges, options);
+    response.body = new ReadStream.ReadStream(path$2, ranges, {
+      fs: options.fs,
+      highWaterMark: await options.highWaterMark(path$2, stats)
+    });
     // File found.
     return true;
   }

package/cjs/Service.d.cts

@@ -10,17 +10,20 @@ interface Headers {
 interface IgnoreFunction {
   (path: string): boolean | Promise<boolean>;
 }
+interface HighWaterMarkFunction {
+  (path: string, stats: Stats): Promise<number> | number;
+}
 interface HeadersFunction {
   (path: string, stats: Stats): Promise<Headers | void> | Headers | void;
 }
 export interface Options {
-  fs?: FileSystem;
   etag?: boolean;
+  fs?: FileSystem;
   acceptRanges?: boolean;
   lastModified?: boolean;
-  highWaterMark?: number;
   ignore?: IgnoreFunction;
   headers?: Headers | HeadersFunction;
+  highWaterMark?: number | HighWaterMarkFunction;
 }
 /**
  * @class Service
@@ -35,13 +38,6 @@ export declare class Service {
    * @param options The file service options.
    */
   constructor(root: string, options?: Options);
-  /**
-   * @private
-   * @method isIgnore
-   * @description Check if path is ignore.
-   * @param path The path to check.
-   */
-  private isIgnore;
   /**
    * @private
    * @method setupHeaders

package/cjs/index.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 4.0.7
+ * @version 4.1.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/cjs/utils/fs.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 4.0.7
+ * @version 4.1.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/cjs/utils/hash.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 4.0.7
+ * @version 4.1.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/cjs/utils/http.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 4.0.7
+ * @version 4.1.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/cjs/utils/path.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 4.0.7
+ * @version 4.1.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/cjs/utils/type.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 4.0.7
+ * @version 4.1.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/esm/ReadStream.d.ts

@@ -2,11 +2,12 @@
  * @module ReadStream
  */
 import { PathLike } from 'fs';
+import { Readable } from 'stream';
 import { Range } from './utils/http.js';
 import { FileSystem } from './utils/fs.js';
-import { Readable, ReadableOptions } from 'stream';
-export interface Options extends Pick<ReadableOptions, 'highWaterMark'> {
+export interface Options {
   fs: FileSystem;
+  highWaterMark?: number;
 }
 interface Callback {
   (error?: Error | null): void;

package/esm/ReadStream.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 4.0.7
+ * @version 4.1.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -126,13 +126,13 @@ class ReadStream extends Readable {
       const buffer = Buffer.allocUnsafeSlow(bytesToRead);
       const position = range.offset + bytesRead;
       // Read file range.
-      this.fs.read(fd, buffer, 0, bytesToRead, position, (error, bytesRead, buffer) => {
+      this.fs.read(fd, buffer, 0, bytesToRead, position, (readError, bytesRead, buffer) => {
         this.reading = false;
         // Tell ._destroy() that it's safe to close the fd now.
         if (this.destroyed) {
-          this.emit(DISPOSE_EVENT, error);
-        } else if (error != null) {
-          this.destroy(error);
+          this.emit(DISPOSE_EVENT, readError);
+        } else if (readError != null) {
+          this.destroy(readError);
         } else if (bytesRead !== bytesToRead) {
           this.destroy(new RangeError('invalid read operation'));
         } else {

package/esm/Service.d.ts

@@ -10,17 +10,20 @@ interface Headers {
 interface IgnoreFunction {
   (path: string): boolean | Promise<boolean>;
 }
+interface HighWaterMarkFunction {
+  (path: string, stats: Stats): Promise<number> | number;
+}
 interface HeadersFunction {
   (path: string, stats: Stats): Promise<Headers | void> | Headers | void;
 }
 export interface Options {
-  fs?: FileSystem;
   etag?: boolean;
+  fs?: FileSystem;
   acceptRanges?: boolean;
   lastModified?: boolean;
-  highWaterMark?: number;
   ignore?: IgnoreFunction;
   headers?: Headers | HeadersFunction;
+  highWaterMark?: number | HighWaterMarkFunction;
 }
 /**
  * @class Service
@@ -35,13 +38,6 @@ export declare class Service {
    * @param options The file service options.
    */
   constructor(root: string, options?: Options);
-  /**
-   * @private
-   * @method isIgnore
-   * @description Check if path is ignore.
-   * @param path The path to check.
-   */
-  private isIgnore;
   /**
    * @private
    * @method setupHeaders

package/esm/Service.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 4.0.7
+ * @version 4.1.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -29,20 +29,15 @@ class Service {
    * @param root The file service root.
    * @param options The file service options.
    */
-  constructor(root, options) {
+  constructor(root, options = {}) {
+    var _a;
     this.root = unixify(resolve(root));
-    this.options = Object.assign({ fs, highWaterMark: 65536 }, options);
-  }
-  /**
-   * @private
-   * @method isIgnore
-   * @description Check if path is ignore.
-   * @param path The path to check.
-   */
-  async isIgnore(path) {
-    const { ignore } = this.options;
-    const isIgnored = isFunction(ignore) ? await ignore(path) : false;
-    return isIgnored === true;
+    const { ignore, highWaterMark = 65536 } = options;
+    this.options = Object.assign(Object.assign({}, options), {
+      fs: (_a = options.fs) !== null && _a !== void 0 ? _a : fs,
+      ignore: isFunction(ignore) ? ignore : () => false,
+      highWaterMark: isFunction(highWaterMark) ? highWaterMark : () => highWaterMark
+    });
   }
   /**
    * @private
@@ -122,12 +117,12 @@ class Service {
     if (isOutRoot(path, root)) {
       return false;
     }
+    // Get options.
+    const { options } = this;
     // Is ignore path or file (403).
-    if (await this.isIgnore(path)) {
+    if (await options.ignore(path)) {
       return false;
     }
-    // Get options.
-    const { options } = this;
     // File stats.
     const stats = await stat(options.fs, path);
     // Check file stats.
@@ -184,7 +179,10 @@ class Service {
       return context.throw(400);
     }
     // Set response body.
-    response.body = new ReadStream(path, ranges, options);
+    response.body = new ReadStream(path, ranges, {
+      fs: options.fs,
+      highWaterMark: await options.highWaterMark(path, stats)
+    });
     // File found.
     return true;
   }

package/esm/index.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 4.0.7
+ * @version 4.1.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/esm/utils/fs.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 4.0.7
+ * @version 4.1.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/esm/utils/hash.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 4.0.7
+ * @version 4.1.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/esm/utils/http.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 4.0.7
+ * @version 4.1.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/esm/utils/path.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 4.0.7
+ * @version 4.1.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/esm/utils/type.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 4.0.7
+ * @version 4.1.0
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koa-files",
-  "version": "4.0.7",
+  "version": "4.1.0",
   "description": "A static files serving middleware for koa.",
   "type": "module",
   "main": "cjs/index.cjs",
@@ -54,11 +54,11 @@
     "@types/node": "^24.1.0",
     "@types/range-parser": "^1.2.7",
     "dts-paths": "^1.1.10",
-    "koa": "^3.0.0",
+    "koa": "^3.0.1",
     "magic-string": "^0.30.17",
     "prettier": "^3.6.2",
     "rimraf": "^6.0.1",
-    "rollup": "^4.45.1",
+    "rollup": "^4.46.1",
     "typescript": "^5.8.3"
   },
   "peerDependencies": {