maai-types

English | 简体中文

项目介绍

maai-types 是一个TypeScript类型定义库，为maai相关项目提供完整的类型支持，实现VSCode智能提示。

目录结构

types/
└── maai/
    ├── biz/          # 业务相关类型定义
    ├── sdk/          # SDK相关类型定义
    ├── utils/        # 工具类类型定义
    ├── package.json  # 项目配置
    └── tsconfig.json # TypeScript配置

安装使用

1. 安装依赖：

npm install @maai/types --save-dev
# 或
yarn add @maai/types -D

2. 在tsconfig.json中添加引用：

{
  "references": [
    { "path": "node_modules/@maai-types/maai" }
  ]
}

使用

安装后，TypeScript会自动识别类型定义。在代码中导入Maai模块即可获得类型支持：

import webUtils from "@maai/utils/web";
import asserts from "@maai/utils/asserts";

const body = webUtils.getBody();
asserts.isNotBlank(body.name, "名称不能为空");

类型定义覆盖范围

当前版本包含以下模块的类型定义：

• 核心HTTP模块 (Request/Response)
• 数据库操作接口
• 断言工具
• Web工具集

开发指南

1. 添加新类型定义：

• 在对应子目录创建.d.ts文件
• 更新index.d.ts导出类型

2. 构建项目：

tsc -b

贡献说明

欢迎提交Pull Request，请确保：

• 类型定义准确完整
• 添加对应的测试用例
• 更新文档说明