chore: 初始化医签通前端项目结构与文档
This commit is contained in:
38
packages/types/README.md
Normal file
38
packages/types/README.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# types
|
||||
|
||||
医签通公共 TypeScript 类型定义包。
|
||||
|
||||
## 计划包含的类型
|
||||
|
||||
- 患者;
|
||||
- 门诊/住院就诊;
|
||||
- 医嘱和收费项目;
|
||||
- 知情同意文书;
|
||||
- 签署任务和任务组;
|
||||
- 签署人及监护人关系;
|
||||
- 签署状态;
|
||||
- 回传结果;
|
||||
- 分页、错误和审计记录。
|
||||
|
||||
示例:
|
||||
|
||||
```ts
|
||||
type ConsentStatus =
|
||||
| 'pending'
|
||||
| 'signed'
|
||||
| 'rejected'
|
||||
| 'expired'
|
||||
| 'voided'
|
||||
```
|
||||
|
||||
## 使用原则
|
||||
|
||||
- 类型命名使用清晰的业务名词;
|
||||
- 前后端字段命名和枚举值保持一致;
|
||||
- 只放公共类型和必要的枚举;
|
||||
- 不放页面组件和接口请求逻辑;
|
||||
- 优先使用 ```import type```,避免产生不必要的运行时代码。
|
||||
|
||||
## 当前状态
|
||||
|
||||
当前仅完成目录和说明文档,尚未创建类型代码。
|
||||
Reference in New Issue
Block a user