# @forinda/kickjs 中文文档

规范地址：https://npmcn.com/package/%40forinda/kickjs/

版本：10\.14\.2
npm 元数据更新时间：2026-11-08T11:08:09.431Z
中文译文更新时间：2026-11-15T07:53:55.707Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40forinda/kickjs
原文对照：https://npmcn.com/package/%40forinda/kickjs/?lang=original
项目主页：https://kickjs.app/
源码仓库：https://github.com/forinda/kick-js

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：2 MB，249 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0
- 运行依赖：3 个
- peer 依赖：h3 ^2\.0\.0，zod ^4\.0\.0，croner ^11\.0\.0，dotenv ^17\.0\.0，multer ^2\.0\.0，express ^5\.1\.0，fastify ^5\.0\.0，serve-static ^1\.15\.0 \|\| ^2\.0\.0，@fastify/middie ^9\.0\.0，@fastify/multipart ^10\.1\.6
- 首次发布：2025-09-20T00:16:07.718Z
- 最新版本发布：2026-11-08T11:08:09.122Z
- 近 30 天下载量：5123（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：126（近 12 个月 121 个）

## 中文简介

现代类型安全后端框架,由Vite提供动力. 为开发者经验所建,按需要可插接——运行于快通,快通或h3上.

## 安装

```sh
npm install @forinda/kickjs
```

也可以使用：`pnpm add @forinda/kickjs`、`yarn add @forinda/kickjs`、`bun add @forinda/kickjs`

## README

# @forinda/ kickjs (英语)

现代类型安全后端框架,由Vite提供动力. 为开发者经验所建,可按需要插入: DI,模块,一个打出的请求上下文,验证和生成器,在Express(默认),Fastify或h3上,在Workers, Bun和Deno上通过一个网络标准条目.

## 安装

```bash
npx @forinda/kickjs-cli new my-api && cd my-api && pnpm dev
```

或者把它添加到现有的项目中:

```bash
pnpm add @forinda/kickjs express reflect-metadata zod
pnpm add -D @forinda/kickjs-cli @forinda/kickjs-vite
```

## 快速实例

```ts
// src/modules/users/user.controller.ts
import { Autowired, Controller, Get, Post, Service, type Ctx } from '@forinda/kickjs'
import { z } from 'zod'

@Service()
export class UserService {
  list() {
    return [{ id: '1', name: 'Alice' }]
  }
}

@Controller()
export class UserController {
  @Autowired() private readonly users!: UserService

  @Get('/')
  list() {
    return this.users.list()
  }

  @Post('/', { body: z.object({ name: z.string().min(1) }) })
  create(ctx: Ctx<KickRoutes.UserController['create']>) {
    ctx.created({ id: '2', name: ctx.body.name })
  }
}
```

```ts
// src/index.ts
import 'reflect-metadata'
import { bootstrap, defineModule, defineModules } from '@forinda/kickjs'
import { UserController } from './modules/users/user.controller'

const UserModule = defineModule({
  name: 'UserModule',
  build: () => ({ routes: () => ({ path: '/users', controller: UserController }) }),
})

export const app = await bootstrap({ modules: defineModules().mount(UserModule()) })
```

`GET /api/v1/users` 返回列表. `KickRoutes` 来自 `kick typegen`,哪个 `kick dev` 为你跑步。 要使用另一个引擎, 请通过 `runtime: fastifyRuntime()` (从) `@forinda/kickjs/fastify`)或(或) `h3Runtime()` 改为 `bootstrap()`。 。 。 .

## 文档

**[kickjs.app (英语)](https://kickjs.app/)**。好的起点:

-   [开始](https://kickjs.app/guide/getting-started)
-   [模块](https://kickjs.app/guide/modules), (中文(简体) ), [主计长](https://kickjs.app/guide/controllers), (中文(简体) ), [依赖性注射](https://kickjs.app/guide/dependency-injection)
-   [HTTP 运行时间](https://kickjs.app/guide/http-runtimes), (中文(简体) ), [边际部署](https://kickjs.app/guide/edge-deployment)
-   [上下文装饰器](https://kickjs.app/guide/context-decorators), (中文(简体) ), [适配器](https://kickjs.app/guide/adapters), (中文(简体) ), [插件](https://kickjs.app/guide/plugins)
-   [BYO 食谱](https://kickjs.app/guide/byo-recipes): auth, GraphQL, OpenTeleometry, cron, 邮件, 多租借

## 许可证

麻省理工学院

## 常见问题

### @forinda/kickjs 是什么？

现代类型安全后端框架,由Vite提供动力\. 为开发者经验所建,按需要可插接——运行于快通,快通或h3上\.

### 如何安装 @forinda/kickjs？

在项目目录运行 npm install @forinda/kickjs，或使用 pnpm add / yarn add / bun add。

### @forinda/kickjs 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @forinda/kickjs 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @forinda/kickjs 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @forinda/kickjs 可以商用吗？

@forinda/kickjs 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @forinda/kickjs 的下载量有多少？

根据 npm 官方下载统计，@forinda/kickjs 在 2026/10/16 – 2026/11/14 这 30 天内被下载 5,123 次，日均约 171 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @forinda/kickjs 还在维护吗？

最新版本 10\.14\.2 发布于 2026/11/08（7 天前）；至今共发布 126 个版本，其中过去 12 个月发布了 121 个；首次发布于 2025/09/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。