starlight-server 1.7.2 → 1.7.3

package/dist/router/helpers.d.ts

@@ -1,3 +1,4 @@
+import { type MaySuccess } from '@anjianshi/utils';
 import { type Definition as ValidatorDefinition } from '@anjianshi/utils/validators/index.js';
 import { type Request } from '../http/request.js';
 import { type ResponseUtils } from '../http/response.js';
@@ -63,9 +64,12 @@ export declare function getRequestWithHelpers(request: Request, pathParameters:
 declare class ResponseUtilsHelpers {
     readonly response: ResponseUtils;
     constructor(response: ResponseUtils);
-    success(data?: unknown): void;
-    failed(message: string, code?: string | number): void;
-    failed<T>(message: string, code: string | number | undefined, data: T): void;
+    success(data?: unknown): never;
+    failed(message: string, code?: string | number): never;
+    failed<T>(message: string, code: string | number | undefined, data: T): never;
+    maySuccess(result: MaySuccess<unknown, unknown>): never;
+}
+export declare class ResponseFinish {
 }
 export type ResponseUtilsWithHelpers = ResponseUtils & ResponseUtilsHelpers;
 export declare function getResponseUtilsWithHelpers(response: ResponseUtils): ResponseUtilsWithHelpers;

package/dist/router/helpers.js

@@ -46,12 +46,22 @@ class ResponseUtilsHelpers {
     constructor(response) {
         this.response = response;
     }
+    // 输出成功结果，并结束响应处理
     success(data) {
-        this.response.json(success(data));
+        this.maySuccess(success(data));
     }
     failed(message, code, data) {
-        this.response.json(failed(message, code, data));
+        this.maySuccess(failed(message, code, data));
     }
+    // 输出 MaySuccess 对象，并结束响应处理
+    maySuccess(result) {
+        this.response.json(result);
+        throw new ResponseFinish();
+    }
+}
+// 通过捕获此对象实现提前结束响应处理
+// eslint-disable-next-line @typescript-eslint/no-extraneous-class
+export class ResponseFinish {
 }
 export function getResponseUtilsWithHelpers(response) {
     const helpers = new ResponseUtilsHelpers(response);

package/dist/router/index.d.ts

@@ -2,7 +2,7 @@ import { type OptionalFields } from '@anjianshi/utils';
 import { type CORSRule } from '../http/cors.js';
 import { type Request, type ResponseUtils } from '../http/index.js';
 import { Swagger, type Method } from '../swagger/index.js';
-import { type RequestWithHelpers, type ResponseUtilsWithHelpers } from './helpers.js';
+import { type RequestWithHelpers, type ResponseUtilsWithHelpers, ResponseFinish } from './helpers.js';
 import { type PathParameters } from './match-path.js';
 export interface BasicContext {
     pathParameters: PathParameters;
@@ -21,6 +21,8 @@ export interface Route {
     /** 此接口的 CORS 规则 */
     cors?: CORSRule;
 }
+/** handler 里抛出此异常可提前结束请求处理 */
+export { ResponseFinish };
 export declare class Router {
     /**
      * ----------------------

package/dist/router/index.js

@@ -2,8 +2,10 @@ import { joinPath } from '@anjianshi/utils';
 import { getPreflightRequestMethod, handleCORS } from '../http/cors.js';
 import { HTTPError } from '../http/index.js';
 import { Swagger } from '../swagger/index.js';
-import { getRequestWithHelpers, getResponseUtilsWithHelpers, } from './helpers.js';
+import { getRequestWithHelpers, getResponseUtilsWithHelpers, ResponseFinish, } from './helpers.js';
 import { matchPath } from './match-path.js';
+/** handler 里抛出此异常可提前结束请求处理 */
+export { ResponseFinish };
 export class Router {
     /**
      * ----------------------
@@ -106,8 +108,14 @@ export class Router {
             request: requestWithHelpers,
             response: responseWithHelpers,
         });
-        const result = await this.executor(basicContext, matched.route);
-        if (result !== undefined)
-            throw new Error('route handler 不应该有返回值');
+        try {
+            const result = await this.executor(basicContext, matched.route);
+            if (result !== undefined)
+                throw new Error('route handler 不应该有返回值');
+        }
+        catch (error) {
+            if (!(error instanceof ResponseFinish))
+                throw error;
+        }
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-server",
-  "version": "1.7.2",
+  "version": "1.7.3",
   "description": "Simple But Powerful Node.js HTTP Server",
   "type": "module",
   "keywords": [

package/src/router/helpers.ts

@@ -1,4 +1,4 @@
-import { success, failed } from '@anjianshi/utils'
+import { type MaySuccess, success, failed } from '@anjianshi/utils'
 import {
   getValidator,
   type Definition as ValidatorDefinition,
@@ -59,17 +59,29 @@ export function getRequestWithHelpers(request: Request, pathParameters: PathPara
 class ResponseUtilsHelpers {
   constructor(readonly response: ResponseUtils) {}
 
-  success(data?: unknown) {
-    this.response.json(success(data))
+  // 输出成功结果，并结束响应处理
+  success(data?: unknown): never {
+    this.maySuccess(success(data))
   }
 
-  failed(message: string, code?: string | number): void
-  failed<T>(message: string, code: string | number | undefined, data: T): void
+  // 输出失败结果，并结束响应处理
+  failed(message: string, code?: string | number): never
+  failed<T>(message: string, code: string | number | undefined, data: T): never
   failed<T>(message: string, code?: string | number, data?: T) {
-    this.response.json(failed(message, code, data))
+    this.maySuccess(failed(message, code, data))
+  }
+
+  // 输出 MaySuccess 对象，并结束响应处理
+  maySuccess(result: MaySuccess<unknown, unknown>): never {
+    this.response.json(result)
+    throw new ResponseFinish()
   }
 }
 
+// 通过捕获此对象实现提前结束响应处理
+// eslint-disable-next-line @typescript-eslint/no-extraneous-class
+export class ResponseFinish {}
+
 export type ResponseUtilsWithHelpers = ResponseUtils & ResponseUtilsHelpers
 
 export function getResponseUtilsWithHelpers(response: ResponseUtils) {

package/src/router/index.ts

@@ -7,6 +7,7 @@ import {
   getResponseUtilsWithHelpers,
   type RequestWithHelpers,
   type ResponseUtilsWithHelpers,
+  ResponseFinish,
 } from './helpers.js'
 import { matchPath, type PathParameters } from './match-path.js'
 
@@ -29,6 +30,9 @@ export interface Route {
   cors?: CORSRule
 }
 
+/** handler 里抛出此异常可提前结束请求处理 */
+export { ResponseFinish }
+
 export class Router {
   /**
    * ----------------------
@@ -143,7 +147,11 @@ export class Router {
       response: responseWithHelpers,
     })
 
-    const result = await (this.executor(basicContext, matched.route) as Promise<unknown>)
-    if (result !== undefined) throw new Error('route handler 不应该有返回值')
+    try {
+      const result = await (this.executor(basicContext, matched.route) as Promise<unknown>)
+      if (result !== undefined) throw new Error('route handler 不应该有返回值')
+    } catch (error) {
+      if (!(error instanceof ResponseFinish)) throw error
+    }
   }
 }