petrel-xf/types

petrel-xf/types

[TOC]

1.组件描述

本组件为项目的 types 整合包，包括 enum 和 model 等，采用 Typescript 语言。

2.前置条件

本组件依赖 windows 上挂载的 EventBus 对象进行通讯。

3.安装组件

npm install --save @petrel-xf/types

4.参数及方法

| 参数 | | :---------------------------------------------------------------- | | enum | | ExtendedAttribute、ExtendedAttributeShow、ExtendOptionValue...... | | model | | AccountSpecModel、AccountInfoModel、AccountStateModel...... | | sdk-model | | AccountModel、AccountProfileModel、AccountConfigModel...... |

5.使用方法

直接在需要使用的地方 import 引入需要的 enum 或 model 即可。

import {
    EnvInfoStateModel,
    EnvStateEnum,
    EnvProductEnum,
    AccountStateModel,
    UploadModelForStore,
} from '@petrel-xf/types';
...
@Getter('activeAccount') public activeAccount: AccountStateModel;
@Getter('uploads') uploads: UploadModelForStore;
...
envInfo.activationState !== EnvStateEnum.ACTIVATED

注意：

• 从服务器直接返回的模型应存储在 sdk-model 下，若发现之前的 model 存储位置不正确，可以移动到正确的目录下。
• sdk-model 下的 model 不应存在可选字段。
• model 下存储的 model 是各项目使用的模型，有些模型扩展自服务器返回的模型。
• 在修改模型时，要注意修改涉及的范围、是否对其他项目有影响、如果有怎么解决等问题。
• 如果不能确定某个字段修改后的影响，建议先将其标注为可选字段。

6.打包方式

打包

"build": "webpack --config webpack.config.js"

发布

npm publish:npmjs