@fastcar/koa 0.1.22 → 0.1.23

package/README.md

@@ -114,6 +114,14 @@ export default class UserController {
     const userId = ctx.params.id;
     return { code: 200, data: { id: userId } };
   }
+
+  @HEAD("/users/:id")
+  async checkUserExists(data: { id: string }, ctx: Context) {
+    // HEAD 请求通常用于检查资源是否存在，不返回响应体
+    const userId = ctx.params.id;
+    const exists = await checkUser(userId); // 假设的检查方法
+    ctx.status = exists ? 200 : 404;
+  }
 }
 ```
 
@@ -183,6 +191,7 @@ type KoaConfig = {
 | `@PutMapping(path)` | PUT | `@PUT` | `string` - 路由路径 |
 | `@DeleteMapping(path)` | DELETE | `@DELETE` | `string` - 路由路径 |
 | `@PatchMapping(path)` | PATCH | `@PATCH` | `string` - 路由路径 |
+| `@HeadMapping(path)` | HEAD | `@HEAD` | `string` - 路由路径 |
 | `@AllMapping(path)` | ALL | `@ALL` | `string` - 路由路径 |
 | `@RequestMapping(path)` | - | `@REQUEST` | `string` - 基础路径前缀 |
 
@@ -392,7 +401,7 @@ export default class UploadController {
 import { KoaApplication, KoaConfig } from "@fastcar/koa";
 
 // 装饰器
-import { EnableKoa, KoaMiddleware, GET, POST, ... } from "@fastcar/koa/annotation";
+import { EnableKoa, KoaMiddleware, GET, POST, HEAD, ... } from "@fastcar/koa/annotation";
 ```
 
 ### KoaApplication 类

package/annotation.d.ts

@@ -25,6 +25,8 @@ export function PatchMapping(url?: string): MRet;
 
 export function PutMapping(url?: string): MRet;
 
+export function HeadMapping(url?: string): MRet;
+
 export function RequestMapping(url: string): Ret;
 
 export function ALL(url?: string): MRet;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@fastcar/koa",
-	"version": "0.1.22",
+	"version": "0.1.23",
 	"homepage": "https://github.com/williamDazhangyu/fast-car",
 	"description": "fastcar框架下对koa的包装",
 	"main": "target/index.js",

package/src/annotation/router/HeadMapping.ts

@@ -0,0 +1,12 @@
+import { RouteMethods } from "../../type/RouteMethods";
+import AddMapping from "./AddMapping";
+
+export default function HeadMapping(url?: string) {
+	return function (target: any, name: string, descriptor: PropertyDescriptor) {
+		AddMapping(target, {
+			url,
+			method: name,
+			request: [RouteMethods.HeadMapping],
+		});
+	};
+}

package/src/annotation.ts

@@ -5,6 +5,7 @@ import AddMapping from "./annotation/router/AddMapping";
 import AllMapping from "./annotation/router/AllMapping";
 import DeleteMapping from "./annotation/router/DeleteMapping";
 import GetMapping from "./annotation/router/GetMapping";
+import HeadMapping from "./annotation/router/HeadMapping";
 import PatchMapping from "./annotation/router/PatchMapping";
 import PostMapping from "./annotation/router/PostMapping";
 import PutMapping from "./annotation/router/PutMapping";
@@ -18,6 +19,7 @@ const PUT = PutMapping;
 const PATCH = PatchMapping;
 const ALL = AllMapping;
 const REQUEST = RequestMapping;
+const HEAD = HeadMapping;
 
 export {
 	//关于请求方式注解
@@ -29,6 +31,7 @@ export {
 	PostMapping,
 	PutMapping,
 	RequestMapping,
+	HeadMapping,
 	//开启koa应用
 	EnableKoa,
 	//追加koa中间件
@@ -42,4 +45,5 @@ export {
 	ALL,
 	REQUEST,
 	KoaApp,
+	HEAD,
 };

package/src/type/RouteMethods.ts

@@ -5,4 +5,5 @@ export enum RouteMethods {
 	DeleteMapping = "delete",
 	PatchMapping = "patch",
 	AllMapping = "all",
+	HeadMapping = "head",
 }

package/target/annotation/router/HeadMapping.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = HeadMapping;
+const RouteMethods_1 = require("../../type/RouteMethods");
+const AddMapping_1 = require("./AddMapping");
+function HeadMapping(url) {
+    return function (target, name, descriptor) {
+        (0, AddMapping_1.default)(target, {
+            url,
+            method: name,
+            request: [RouteMethods_1.RouteMethods.HeadMapping],
+        });
+    };
+}

package/target/annotation.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KoaApp = exports.REQUEST = exports.ALL = exports.PATCH = exports.PUT = exports.DELETE = exports.POST = exports.GET = exports.KoaMiddleware = exports.EnableKoa = exports.RequestMapping = exports.PutMapping = exports.PostMapping = exports.PatchMapping = exports.GetMapping = exports.DeleteMapping = exports.AllMapping = exports.AddMapping = void 0;
+exports.HEAD = exports.KoaApp = exports.REQUEST = exports.ALL = exports.PATCH = exports.PUT = exports.DELETE = exports.POST = exports.GET = exports.KoaMiddleware = exports.EnableKoa = exports.HeadMapping = exports.RequestMapping = exports.PutMapping = exports.PostMapping = exports.PatchMapping = exports.GetMapping = exports.DeleteMapping = exports.AllMapping = exports.AddMapping = void 0;
 const EnableKoa_1 = require("./annotation/EnableKoa");
 exports.EnableKoa = EnableKoa_1.default;
 const KoaApp_1 = require("./annotation/KoaApp");
@@ -15,6 +15,8 @@ const DeleteMapping_1 = require("./annotation/router/DeleteMapping");
 exports.DeleteMapping = DeleteMapping_1.default;
 const GetMapping_1 = require("./annotation/router/GetMapping");
 exports.GetMapping = GetMapping_1.default;
+const HeadMapping_1 = require("./annotation/router/HeadMapping");
+exports.HeadMapping = HeadMapping_1.default;
 const PatchMapping_1 = require("./annotation/router/PatchMapping");
 exports.PatchMapping = PatchMapping_1.default;
 const PostMapping_1 = require("./annotation/router/PostMapping");
@@ -38,3 +40,5 @@ const ALL = AllMapping_1.default;
 exports.ALL = ALL;
 const REQUEST = RequestMapping_1.default;
 exports.REQUEST = REQUEST;
+const HEAD = HeadMapping_1.default;
+exports.HEAD = HEAD;

package/target/type/RouteMethods.js

@@ -9,4 +9,5 @@ var RouteMethods;
     RouteMethods["DeleteMapping"] = "delete";
     RouteMethods["PatchMapping"] = "patch";
     RouteMethods["AllMapping"] = "all";
+    RouteMethods["HeadMapping"] = "head";
 })(RouteMethods || (exports.RouteMethods = RouteMethods = {}));