# @goodrequest/joi-type-extract 中文文档

规范地址：https://npmcn.com/package/%40goodrequest/joi-type-extract/

版本：0\.0\.5
npm 元数据更新时间：2026-03-23T11:17:59.810Z
中文译文更新时间：2026-11-16T19:26:15.939Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40goodrequest/joi-type-extract
原文对照：https://npmcn.com/package/%40goodrequest/joi-type-extract/?lang=original
项目主页：https://github.com/GoodRequest/joi-type-extract#readme
源码仓库：https://github.com/GoodRequest/joi-type-extract

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

- 包体积（解压后）：20.4 kB，4 个文件
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2022-06-10T10:46:37.222Z
- 最新版本发布：2025-10-06T11:13:34.854Z
- 近 30 天下载量：3353（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

从Joi schemas中提取类型的溶液.

## 安装

```sh
npm install @goodrequest/joi-type-extract
```

也可以使用：`pnpm add @goodrequest/joi-type-extract`、`yarn add @goodrequest/joi-type-extract`、`bun add @goodrequest/joi-type-extract`

## README

# joi 类型摘录

克隆块 [https://github.com/TC米兰达/joi-extract-type 互联网档案馆的存檔,存档日期2013-12-21](https://github.com/TCMiranda/joi-extract-type)  

## 设置

1.  安装软件包
    
    ```bash
    npm install @goodrequest/joi-type-extract
    or
    yarn add @goodrequest/joi-type-extract
    ```
    
2.  在其中创建./sc/types/joi/index.d.ts并导入包,这将扩展Joi类型
    
    ```Typescript
    import '@goodrequest/joi-type-extract'
    ```
    
3.  添加此编译器选项, 在类型 Roots 中包含 tsconfig.json 中创建的文件
    
    ```Json
    {
        "compilerOptions": {
            "strictNullChecks": true,
            "typeRoots": [
                "./src/types"
            ]
        }
    }
    ```
    

## 用法实例

```Typescript
import Joi from 'joi'

export const requestSchema = () =>
    Joi.object({
        params: Joi.object({
            userID: Joi.number().required()
        }),
        query: Joi.object({
            search: Joi.string().required()
        }),
        body: Joi.object({
            name: Joi.string().required()
        })
    })

export const responseSchema = Joi.object({
   messages: Joi.array().items({
       message: Joi.string().required(),
       type: Joi.string().valid(MESSAGE_TYPE.SUCCESS).required()
   }).required()
})

type RequestType = Joi.extractType<ReturnType<typeof requestSchema>>
type ResponseType = Joi.extractType<typeof fullMessagesResponseSchema>
```

被提取出 EequestType 和 ResponseType 之后可以被快取使用. 请求和表达。 反应类型

```Typescript
import { Request, Response, NextFunction } from 'express'

const businessLogic = async (
    req: Request<RequestType['params'], ResponseType, RequestType['body'], RequestType['query']>,
    res: Response<ResponseType>,
    next: NextFunction
) => {
    const { params, query, body } = req

    // params.userID will have number type
    // query.serch will have string type
    // body.name will have string type

    // response will be enforced to be same as ResponseType
    return res.json({
        messages: [
            {
                message: 'Response message',
                type: MESSAGE_TYPE.SUCCESS
            }
        ]
    })
}
```

## 常见问题

### @goodrequest/joi-type-extract 是什么？

从Joi schemas中提取类型的溶液\.

### 如何安装 @goodrequest/joi-type-extract？

在项目目录运行 npm install @goodrequest/joi-type-extract，或使用 pnpm add / yarn add / bun add。

### @goodrequest/joi-type-extract 支持 TypeScript 吗？

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

### @goodrequest/joi-type-extract 可以商用吗？

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

### @goodrequest/joi-type-extract 的下载量有多少？

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

### @goodrequest/joi-type-extract 还在维护吗？

最新版本 0\.0\.5 发布于 2025/10/06（1\.1 年前）；至今共发布 4 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/06/10。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

