@pkpm/pkpm-types

图模大师及相关项目的 types 整合包

Usage no npm install needed!

<script type="module">
  import pkpmPkpmTypes from 'https://cdn.skypack.dev/@pkpm/pkpm-types';
</script>

README

pkpm-types

项目介绍

图模大师及相关项目的 types 整合包，包括 enum 和 model，采用 Typescript 语言

安装教程

  1. 安装 npm
  2. 使用以下命令安装: npm install @pkpm/pkpm-types

使用说明

  • 直接在需要使用的地方 import 引入需要的 enum 或 model 即可。
    例子:
    import { RoleModel } from '@pkpm/pkpm-types'
  • 注意：
  1. 从服务器直接返回的模型应存储在 sdk-model 下，若发现之前的 model 存储位置不正确，可以移动到正确的目录下。
  2. sdk-model 下的 model 不应存在可选字段。
  3. model 下存储的 model 是各项目使用的模型，有些模型扩展自服务器返回的模型。
  4. 在修改模型时，要注意修改涉及的范围、是否对其他项目有影响、如果有怎么解决等问题。
  5. 如果不能确定某个字段修改后的影响，建议先将其标注为可选字段。

参与贡献

  1. Fork 本项目
  2. 新建 Feat_xxx 分支
  3. 提交代码
  4. 新建 Pull Request