# 字典相关方法

字典相关方法均为promise方式调用,因为当缓存中无该字典类型时,会发起请求字典接口的动作,为了兼容此情况,不得不使用promise的形式。字典相关方法如下

/**
 * @description: 通过字典code获取字典label
 * @param val 字典code
 * @param dictType 字典类型
 * @param defaultVal 配置当找不到该字典类型的值时展示默认值
 * @return {Promise()    label}
 * @author: syx
 */
getLabelByCode(val, dictType, defaultVal = "");

/**
 * @description: 通过字典label获取字典code
 * @param val 字典label
 * @param dictType 字典类型
 * @param defaultVal 配置当找不到该字典类型的值时展示默认值
 * @return {Promise()    code}
 * @author: syx
 */
getCodeByLabel(val, dictType, defaultVal = "");

/**
 * @description: 通过字典多个code获取字典多个label
 * @param vals 字典多个 code
 * @param dictType 字典类型
 * @param options {  配置对象
 *  defaultVal 某个code找不到值时 展示的默认值
 *  formatFun(arr, format)  arr为该字典类型中找到的多个code的对象组合, format为字典包配置的format 包含label和value字段。 默认函数为返回label英文逗号分隔
 *  spacer 间隔符,为配置vals中多个code之间的间隔符
 * }
 * @return {Promise()    label1,label2}
 * @author: syx
 */
getLabelByCodes(vals, dictType, options)

/**
 * @description: 通过字典多个label获取字典多个code
 * @param vals 字典多个 label
 * @param dictType 字典类型
 * @param options {  配置对象
 *  defaultVal 某个label找不到值时 展示的默认值
 *  formatFun(arr, format)  arr为该字典类型中找到的多个code的对象组合, format为字典包配置的format 包含label和value字段。 默认函数为返回code英文逗号分隔
 *  spacer 间隔符,为配置vals中多个label之间的间隔符
 * }
 * @return {Promise()    code1,code2}
 * @author: syx
 */
getCodeByLabels(vals, dictType, options)

/**
 * @description: 通过传递字典类型,返回该字典类型的数据
 * @param dictTypes 可传数组形式,或者字符串英文逗号隔开 如 ["sex", "color"]  "sex,color"
 * @return {Promise()    {sex: [], color: []}}
 * @author: syx
 */
getDictObjByDictTypes(dictTypes)

/**
 * @description: 通过字典code获取字典label
 * @param val 字典code
 * @param dictType 字典类型
 * @param options {  配置对象
 *  defaultVal code找不到值时 展示的默认值
 *  formatFun(arr, treeSetting)  arr为该字典类型中找到的多个code的对象组合, treeSetting为字典包配置的treeSetting和配置项treeSetting的合并  默认函数为返回label英文逗号分隔
 *  treeSetting 可覆盖字典包配置项关于treeSetting的配置
 * }
 * @return {Promise()    label,label,label}
 * @author: syx
 */
getTreeLabelByCode(val, dictType, options)

/**
 * @description: 通过字典label获取字典code
 * @param val 字典label
 * @param dictType 字典类型
 * @param options {  配置对象
 *  defaultVal label找不到值时 展示的默认值
 *  formatFun(arr, treeSetting)  arr为该字典类型中找到的多个code的对象组合, treeSetting为字典包配置的treeSetting和配置项treeSetting的合并  默认函数为返回code英文逗号分隔
 *  treeSetting 可覆盖字典包配置项关于treeSetting的配置
 * }
 * @return {Promise()    code,code,code}
 * @author: syx
 */
getTreeCodeByLabel(val, dictType, options)

/**
 * @description: 通过多个字典code获取多个字典label
 * @param vals 多个字典code
 * @param dictType 字典类型
 * @param options {  配置对象
 *  defaultVal 某个codel找不到值时 展示的默认值
 *  formatFunIn(arr, treeSetting)  arr为该字典类型中找到的多个code的对象组合, treeSetting为字典包配置的treeSetting和配置项treeSetting的合并  默认函数为返回label "/"分隔
 *  treeSetting 可覆盖字典包配置项关于treeSetting的配置
 *  formatFunOut (arr) arr为多个label的数组  默认return arr.join(",")
 *  spacer 间隔符,为配置vals中多个label之间的间隔符
 * }
 * @return {Promise()    label1/label11/label111,label2/label22/label222}
 * @author: syx
 */
getTreeLabelByCodes(vals, dictType, options)

/**
 * @description: 通过多个字典label获取多个字典code
 * @param vals 多个字典label
 * @param dictType 字典类型
 * @param options {  配置对象
 *  defaultVal 某个codel找不到值时 展示的默认值
 *  formatFunIn(arr, treeSetting)  arr为该字典类型中找到的多个code的对象组合, treeSetting为字典包配置的treeSetting和配置项treeSetting的合并  默认函数为返回code "/"分隔
 *  treeSetting 可覆盖字典包配置项关于treeSetting的配置
 *  formatFunOut (arr) arr为多个code的数组  默认return arr.join(",")
 *  spacer 间隔符,为配置vals中多个label之间的间隔符
 * }
 * @return {Promise()    code1/code11/code111,code2/code22/code222}
 * @author: syx
 */
getTreeCodeByLabels(vals, dictType, options)

爆米花小布微信公众号

上次更新: 7/11/2024, 4:01:24 PM