# 其他相关方法

此处为本字典包暴露的其他与字典无关的相关方法，均为函数调用方式，具体方法如下

const { options } = require("less");

/**
 * @description: 获取字典包配置数据
 * @return {dictConfig 字典包配置数据  配置与默认配置的合并}
 * @author: syx
 */
getDictConfig();

/**
 * @description: 通过字段获取dictConfig的配置
 * @param key dictConfig的字段
 * @return {dictConfig的某个字段}
 * @author: syx
 */
getDictConfigByKey(key)

/**
 * @description: 判断某个字符串是不是日期格式
 * @param str 字符串
 * @return {boolean}
 * @author: syx
 */
isDate(str)

/**
 * @description: 将某个日期格式化
 * @param date 日期 可以是字符串 数字 date()
 * @param format  默认datetime 可选  date month time year  也可自定义格式，具体配置继续阅读
 * @return 根据format返回的日期格式
 * @author: syx
 */
formatDate(date, format, defaultVal)

/**
 * @description: 将某个字符串进行脱敏
 * @param str 字符串
 * @param options { 配置
 *   start: 1,  展示前面几位数 默认1
 *   end: 0, 展示后面几位数 默认0
 *   symbol: "*" 使用什么符号进行脱敏  默认 *
 *   middle  如果有配置，则表示 中间展示几个symbol
 * } 
 * @return 根据format返回的日期格式
 * @author: syx
 */
mask(str, options)

/**
 * @description: 姓名脱敏
 * @param name 姓名
 * @param symbol "*" 使用什么符号进行脱敏  默认 *
 * @return {*}
 * @author: syx
 */
maskName(name, symbol)

/**
 * @description: 身份证号脱敏
 * @param idCard 身份证号码
 * @param symbol "*" 使用什么符号进行脱敏  默认 *
 * @return {*}
 * @author: syx
 */
maskIdCard(idCard, symbol)

/**
 * @description: 手机号脱敏
 * @param phone 手机号码
 * @param symbol "*" 使用什么符号进行脱敏  默认 *
 * @return {*}
 * @author: syx
 */
maskPhone(phone, symbol)

/**
 * @description: 地址脱敏
 * @param address 地址
 * @param symbol "*" 使用什么符号进行脱敏  默认 *
 * @return {*}
 * @author: syx
 */
maskAddress(address, symbol)

/**
 * @description: 脱敏字符串
 * @param str 要脱敏的数据
 * @param options { 配置
 *   start: 1,  展示前面几位数 默认1
 *   end: 0, 展示后面几位数 默认0
 *   symbol: "*" 使用什么符号进行脱敏  默认 *
 *   middle  如果有配置，则表示 中间展示几个symbol
 *   defaultVal: "", 没值时返回的默认值
 *   maskType: "" 脱敏类型   mobile，name，address，idCard
 * } 
 * @return {*}
 * @author: syx
 */
desensitization(str, options)

/**
 * @description: 一维数组转化为 树形数组
 * @param data 一维数组
 * @param config { 配置项
 *    idField: "id", //唯一标识字段名
 *    parentIdField: "parentId", //父节点唯一标识字段名
 *    childrenField: "children", //子节点标识字段名
 *    firstId: "0", // 根节点值
 *    labelField: "label", //label字段名
 *    labelArrField: "labelArr", //给对象新增的中文数组字段名
 *    idArrField: "idArr", //给对象新增的id数组字段名
 *    levelField: "level", //给对象新增的层级字段名
 *    level: 0, // 给根目录配置的层级
 *    leafField: "leaf" //叶子节点标识字段名
 * }
 * @return {*}
 * @author: syx
 */
listToTree(data, config)

/**
 * @description: 通过code 获取树形数据item的数组
 * @param code 值
 * @param arr 一维数组
 * @param options { // 配置项
 *   idField: "id", //唯一标识字段名
 *   parentIdField: "parentId" //父节点唯一标识字段名
 * }
 * @return {*}
 * @author: syx
 */
getTreeItemByCode(code, arr, options)

/**
 * @description: 通过label 获取树形数据item的数组
 * @param label 值
 * @param arr 一维数组
 * @param options { // 配置项
 *   idField: "id", //唯一标识字段名
 *   labelField: "label", //唯一标识字段名
 *   parentIdField: "parentId" //父节点唯一标识字段名
 * }
 * @return {*}
 * @author: syx
 */
getTreeItemByLabel(label, arr, options)

# 使用方式

import {getDictConfig, getDictConfigByKey, isDate, formatDate, mask, maskName, maskIdCard, maskPhone, maskAddress, desensitization, listToTree, getTreeItemByCode, getTreeItemByLabel} from "vue3-element-dict"

# 日期格式

标识	示例	描述
yy	18	年，两位数
yyyy	2018	年，四位数
M	1-12	月，从1开始
MM	01-12	月，两位数字
d	1-31	日
dd	01-31	日，两位数
h	0-23	24小时
hh	00-23	24小时，两位数
h	1-12	12小时
hh	01-12	12小时，两位数
m	0-59	分钟
mm	00-59	分钟，两位数
s	0-59	秒
ss	00-59	秒，两位数

← 字典方法