ticatec-dictionary
v0.0.5
Published
拥有管理数据字典的工具类库
Downloads
1
Maintainers
Readme
公共数据字典管理
在前台的开发中,我们经常需要中使用数据字典用于选择,key-value转换工作。通过这个管理类库可以简单的实现。里面总共包括了三个组件
数据字典管理类单一实例 dicManager
这是一个数据字典管理类的实例。项目中需要的所有数据字典都可以让这个来管理。使用方法如下:
import dicManager from 'ticatec-dictonary';
dicManager包括以下方法:
- 注册一个普通数据字典,registerDic
- 注册一个树状数据字典, registerTreeDic
- 获取一个数据字典,get
- 初始化加载指定的数据字典
registerDic
/**
* 注册一个普通的数据字典
* @param key 数据字典的名称
* @param dataLoader 加载数据的方法
* @param keyName 数据字典中key的字段名
* @param getText 可以是数据项中文字值对应的字段名,也可以是一个函数,根据key返回对应的文字值
*/
dicManager.registerDic(key, dataLoader, keyName, getText)
registerTreeDic
/**
* 注册一个普通的数据字典
* @param key 数据字典的名称
* @param dataLoader 加载数据的方法
* @param keyName 数据字典中key的字段名
* @param getText 可以是数据项中文字值对应的字段名,也可以是一个函数,根据key返回对应的文字值
*/
dicManager.registerTreeDic(key, dataLoader, keyName, getText)
get
返回对应的数据字典
let dic = await dicManager.get('country');
Dictionary
数据字典类,可以获取list,根据key查找对应的数据项,根据key查找对应的文本值
- async reload() 重新加载数据
- toList() 转换成数组
- get(key) 返回对应的数据对象
- getText(key) 返回对应的文本值
TreeDictionary
- async reload() 重新加载数据
- toList() 转换成数组
- get(key) 返回对应的数据对象
- getText(key) 返回对应的文本值
- getChildren(key) 返回指定数据项的子项目列表