# 文档

Deepkit 是一个面向后端应用的开源 TypeScript 框架，在 MIT 许可下免费提供，旨在帮助你构建可扩展且易维护的后端应用。它被设计用于在浏览器和 Node.js 中工作，但也可以在任何合适的 JavaScript 环境中运行。

在这里你可以找到 Deepkit 各个组件的章节以及我们所有包的 API 参考。

如果你需要帮助，欢迎加入我们的[Discord 服务器](https://discord.com/invite/PtfVf7B8UU)或在 [GitHub](https://github.com/deepkit/deepkit-framework) 上提交 issue。

## 章节


- [应用](https://deepkit.io/zh/documentation/app.md) - 基于命令行界面，使用 Deepkit 编写你的第一个应用。
- [框架](https://deepkit.io/zh/documentation/framework.md) - 为你的应用添加应用（HTTP/RPC）服务器、API 文档、调试器、集成测试等。
- [运行时类型](https://deepkit.io/zh/documentation/runtime-types.md) - 了解 TypeScript 运行时类型，以及如何验证与转换数据。
- [依赖注入](https://deepkit.io/zh/documentation/dependency-injection.md) - 依赖注入容器、控制反转与依赖倒置。
- [文件系统](https://deepkit.io/zh/documentation/filesystem.md) - 文件系统抽象，以统一方式处理本地与远程文件系统。
- [消息代理](https://deepkit.io/zh/documentation/broker.md) - 消息代理抽象，用于处理分布式二级缓存、发布/订阅、队列、集中式原子锁或键值存储。
- [HTTP](https://deepkit.io/zh/documentation/http.md) - HTTP 服务器抽象，用于构建类型安全的端点。
- [RPC](https://deepkit.io/zh/documentation/rpc.md) - 远程过程调用抽象，用于连接前端与后端，或连接多个后端服务。
- [ORM](https://deepkit.io/zh/documentation/orm.md) - ORM 与 DBAL，以类型安全的方式存储和查询数据。
- [桌面 UI](https://deepkit.io/zh/documentation/desktop-ui/getting-started) - 使用 Deepkit 基于 Angular 的 UI 框架构建 GUI 应用。

## API 参考

以下是所有 Deepkit 包的完整列表及其 API 文档链接。

### 组成

- [@deepkit/app](https://deepkit.io/zh/documentation/package/app.md)
- [@deepkit/framework](https://deepkit.io/zh/documentation/package/framework.md)
- [@deepkit/http](https://deepkit.io/zh/documentation/package/http.md)
- [@deepkit/angular-ssr](https://deepkit.io/zh/documentation/package/angular-ssr.md)

### 基础设施

- [@deepkit/rpc](https://deepkit.io/zh/documentation/package/rpc.md)
- [@deepkit/rpc-tcp](https://deepkit.io/zh/documentation/package/rpc-tcp.md)
- [@deepkit/broker](https://deepkit.io/zh/documentation/package/broker.md)
- [@deepkit/broker-redis](https://deepkit.io/zh/documentation/package/broker-redis.md)

### 文件系统

- [@deepkit/filesystem](https://deepkit.io/zh/documentation/package/filesystem.md)
- [@deepkit/filesystem-ftp](https://deepkit.io/zh/documentation/package/filesystem-ftp.md)
- [@deepkit/filesystem-sftp](https://deepkit.io/zh/documentation/package/filesystem-sftp.md)
- [@deepkit/filesystem-s3](https://deepkit.io/zh/documentation/package/filesystem-aws-s3.md)
- [@deepkit/filesystem-google](https://deepkit.io/zh/documentation/package/filesystem-google.md)
- [@deepkit/filesystem-database](https://deepkit.io/zh/documentation/package/filesystem-database.md)

### 数据库

- [@deepkit/orm](https://deepkit.io/zh/documentation/package/orm.md)
- [@deepkit/mysql](https://deepkit.io/zh/documentation/package/mysql.md)
- [@deepkit/postgres](https://deepkit.io/zh/documentation/package/postgres.md)
- [@deepkit/sqlite](https://deepkit.io/zh/documentation/package/sqlite.md)
- [@deepkit/mongodb](https://deepkit.io/zh/documentation/package/mongo.md)

### 基础

- [@deepkit/type](https://deepkit.io/zh/documentation/package/type.md)
- [@deepkit/event](https://deepkit.io/zh/documentation/package/event.md)
- [@deepkit/injector](https://deepkit.io/zh/documentation/package/injector.md)
- [@deepkit/template](https://deepkit.io/zh/documentation/package/template.md)
- [@deepkit/logger](https://deepkit.io/zh/documentation/package/logger.md)
- [@deepkit/workflow](https://deepkit.io/zh/documentation/package/workflow.md)
- [@deepkit/stopwatch](https://deepkit.io/zh/documentation/package/stopwatch.md)

### 工具

- [@deepkit/api-console](https://deepkit.io/zh/documentation/package/api-console.md)
- [@deepkit/devtool](https://deepkit.io/zh/documentation/package/devtool.md)
- [@deepkit/desktop-ui](https://deepkit.io/zh/documentation/desktop-ui/getting-started)
- [@deepkit/orm-browser](https://deepkit.io/zh/documentation/package/orm-browser.md)
- [@deepkit/bench](https://deepkit.io/zh/documentation/package/bench.md)
- [@deepkit/run](https://deepkit.io/zh/documentation/package/run.md)

### 核心

- [@deepkit/bson](https://deepkit.io/zh/documentation/package/bson.md)
- [@deepkit/core](https://deepkit.io/zh/documentation/package/core.md)
- [@deepkit/topsort](https://deepkit.io/zh/documentation/package/topsort.md)

### 运行时

- [@deepkit/vite](https://deepkit.io/zh/documentation/package/vite.md)
- [@deepkit/bun](https://deepkit.io/zh/documentation/package/bun.md)
- [@deepkit/type-compiler](https://deepkit.io/zh/documentation/package/type-compiler.md)